SoundFieldAudioComponent
class SoundFieldAudioComponent : Component
Provides spatial audio playback for a sound field associated with an Entity.
It provides an AudioOutputProvider which can be used to configure an ExoPlayer.Builder instance for sound field audio playback. The characteristics of the sound field are defined by SoundFieldAttributes.
This component can only be attached to one Entity at a time.
Summary
Public companion functions |
|
|---|---|
SoundFieldAudioComponent |
create(session: Session, attributes: SoundFieldAttributes)Creates a |
Protected functions |
|
|---|---|
open Boolean |
Called by the framework when this component is being added to an |
open Unit |
Called by the framework when this component is being removed from an |
Public properties |
|
|---|---|
AudioOutputProvider |
An |
Public companion functions
create
fun create(session: Session, attributes: SoundFieldAttributes): SoundFieldAudioComponent
Creates a SoundFieldAudioComponent for the given session and initializes it with the provided attributes.
Protected functions
onAttach
protected open fun onAttach(entity: Entity): Boolean
Called by the framework when this component is being added to an Entity.
This method is triggered when Entity.addComponent is invoked. Implementations should override this method to perform setup logic or to validate if the component is compatible with the provided entity.
onDetach
protected open fun onDetach(entity: Entity): Unit
Called by the framework when this component is being removed from an Entity.
This method is triggered when Entity.removeComponent is invoked. Implementations should override this method to release resources or undo any changes made during onAttach.
Public properties
audioOutputProvider
val audioOutputProvider: AudioOutputProvider
An AudioOutputProvider that can be used to configure an androidx.media3.exoplayer.ExoPlayer.Builder for ambisonics audio playback.