PositionalAudioComponent
public final class PositionalAudioComponent extends 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 methods |
|
|---|---|
static final @NonNull PositionalAudioComponent |
create(@NonNull Session session, @NonNull PointSourceParams params)Creates a |
final @NonNull AudioOutputProvider |
An |
final void |
setPointSourceParams(@NonNull PointSourceParams params)Updates the |
Protected methods |
|
|---|---|
boolean |
Called by the framework when this component is being added to an |
void |
Called by the framework when this component is being removed from an |
Public methods
create
public static final @NonNull PositionalAudioComponent create(@NonNull Session session, @NonNull PointSourceParams params)
Creates a PositionalAudioComponent for the given session and initializes it with the provided params.
getAudioOutputProvider
public final @NonNull AudioOutputProvider getAudioOutputProvider()
An AudioOutputProvider that can be used to configure an androidx.media3.exoplayer.ExoPlayer.Builder for positional audio playback.
setPointSourceParams
public final void setPointSourceParams(@NonNull PointSourceParams params)
Updates the PointSourceParams used by the spatial audio source.
These params will apply to currently playing audio and future playback requests.
Protected methods
onAttach
protected boolean onAttach(@NonNull Entity entity)
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.
| Returns | |
|---|---|
boolean |
|
onDetach
protected void onDetach(@NonNull Entity entity)
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.