SpatialAudioTrack

class SpatialAudioTrack

Summary

Public companion functions
PointSourceAttributes?

Gets the PointSourceAttributes of the provided AudioTrack.
SoundFieldAttributes?

Gets the SoundFieldAttributes of the provided AudioTrack.
Int

Gets the SourceType of the provided AudioTrack.

Public constructors

Public companion functions

getPointSourceAttributes

Added in 1.0.0-alpha01
fun getPointSourceAttributes(session: Session, track: AudioTrack): PointSourceAttributes?

Gets the PointSourceAttributes of the provided AudioTrack.

Parameters
session: Session

The current SceneCore Session instance.
track: AudioTrack

The AudioTrack from which to get the PointSourceAttributes.
Returns
PointSourceAttributes?

The PointSourceAttributes of the provided track, null if not set.

getSoundFieldAttributes

Added in 1.0.0-alpha01
fun getSoundFieldAttributes(session: Session, track: AudioTrack): SoundFieldAttributes?

Gets the SoundFieldAttributes of the provided AudioTrack.

Parameters
session: Session

The current SceneCore Session instance.
track: AudioTrack

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-alpha01
fun getSpatialSourceType(session: Session, track: AudioTrack): Int

Gets the SourceType of the provided AudioTrack. This value is implicitly set depending one which type of attributes was used to configure the builder. Will return SpatializerExtensions.NOT_SPATIALIZED for tracks that didn't use spatial audio attributes.

Parameters
session: Session

The current SceneCore Session instance.
track: AudioTrack

The AudioTrack from which to get the SpatializerConstants.SourceType.
Returns
Int

The SpatializerExtensions.SourceType of the provided track.

Public constructors

SpatialAudioTrack

Added in 1.0.0-alpha01
SpatialAudioTrack()