PositionalAudioComponent
class PositionalAudioComponent : Component
A Component that provides positional spatial audio playback for an Entity.
It provides an AudioOutputProvider which can be used to configure an androidx.media3.exoplayer.ExoPlayer.Builder instance for positional audio playback.
This component can only be attached to one Entity at a time. If the component is detached from an Entity, the audio will become head-locked.
Summary
Public companion functions |
|
|---|---|
PositionalAudioComponent |
create(session: Session, params: PointSourceParams)Creates a |
Public functions |
|
|---|---|
Unit |
setPointSourceParams(params: PointSourceParams)Updates the |
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, params: PointSourceParams): PositionalAudioComponent
Creates a PositionalAudioComponent for the given session and initializes it with the provided params.
Public functions
setPointSourceParams
fun setPointSourceParams(params: PointSourceParams): Unit
Updates the PointSourceParams used by the spatial audio source.
These params will apply to currently playing audio and future playback requests.
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 positional audio playback.