SpatialAudioTrack

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

public static class SpatialAudioTrack

Provides spatial audio extensions on the framework AudioTrack class.

Summary

Public fields
`static @NonNull SpatialAudioTrack`	`INSTANCE`

Public methods
`static final PointSourceParams`	`getPointSourceParams(@NonNull Session session, @NonNull AudioTrack track)` Gets the `PointSourceParams` of the provided `AudioTrack`.
`static final SoundFieldAttributes`	`getSoundFieldAttributes( @NonNull Session session, @NonNull AudioTrack track )` Gets the `SoundFieldAttributes` of the provided `AudioTrack`.
`static final @NonNull SpatializerConstants.SourceType`	`getSpatialSourceType(@NonNull Session session, @NonNull AudioTrack track)` Gets the `SpatializerConstants.SourceType` of the provided `AudioTrack`.
`static final void`	`setPointSourceParams( @NonNull Session session, @NonNull AudioTrack track, @NonNull PointSourceParams params, @NonNull Entity entity )` Sets a new `PointSourceParams` on the provided `AudioTrack`.

Public fields

INSTANCE

Added in 1.0.0-beta01

public static @NonNull SpatialAudioTrack INSTANCE

Public methods

getPointSourceParams

Added in 1.0.0-beta01

public static final PointSourceParams getPointSourceParams(@NonNull Session session, @NonNull AudioTrack track)

Gets the PointSourceParams of the provided AudioTrack.

Parameters
`@NonNull Session session`	The current `Session` instance.
`@NonNull AudioTrack track`	The `AudioTrack` from which to get the `PointSourceParams`.

Returns
`PointSourceParams`	The `PointSourceParams` of the provided track, null if not set.

getSoundFieldAttributes

Added in 1.0.0-beta01

public static final SoundFieldAttributes getSoundFieldAttributes(
    @NonNull Session session,
    @NonNull AudioTrack track
)

Gets the SoundFieldAttributes of the provided AudioTrack.

Parameters
`@NonNull Session session`	The current `Session` instance.
`@NonNull AudioTrack track`	The `AudioTrack` from which to get the `SoundFieldAttributes`.

Returns
`SoundFieldAttributes`	The `SoundFieldAttributes` of the provided track, null if not set.

getSpatialSourceType

Added in 1.0.0-beta01

public static final @NonNull SpatializerConstants.SourceType getSpatialSourceType(@NonNull Session session, @NonNull AudioTrack track)

Gets the SpatializerConstants.SourceType of the provided AudioTrack. If setPointSourceParams has not yet been called, this value is determined by how the SpatialAudioTrackBuilder was constructed. Will return SpatializerConstants.SourceType.DEFAULT for tracks that didn't use spatial audio attributes.

Parameters
`@NonNull Session session`	The current `Session` instance.
`@NonNull AudioTrack track`	The `AudioTrack` from which to get the `SpatializerConstants.SourceType`.

Returns
`@NonNull SpatializerConstants.SourceType`	The `SpatializerConstants.SourceType` of the provided track.

setPointSourceParams

Added in 1.0.0-beta01

public static final void setPointSourceParams(
    @NonNull Session session,
    @NonNull AudioTrack track,
    @NonNull PointSourceParams params,
    @NonNull Entity entity
)

Sets a new PointSourceParams on the provided AudioTrack.

The new PointSourceParams will be applied if the SpatializerConstants.SourceType of the AudioTrack was either SpatializerConstants.SourceType.DEFAULT or SpatializerConstants.SourceType.POINT_SOURCE. If the SpatializerConstants.SourceType was SpatializerConstants.SourceType.SOUND_FIELD, then this method will throw an IllegalStateException.

Parameters
`@NonNull Session session`	The current `Session` instance.
`@NonNull AudioTrack track`	The `AudioTrack` on which to set the `PointSourceParams`.
`@NonNull PointSourceParams params`	The `PointSourceParams` to be set.
`@NonNull Entity entity`	The `Entity` from which the sound will be played.

Throws
`IllegalStateException`	if the `SpatializerConstants.SourceType` of the `AudioTrack` is `SpatializerConstants.SourceType.SOUND_FIELD`.
`IllegalArgumentException`	if the `PointSourceParams` cannot be set on this `AudioTrack` instance.