SpatialAudioTrack


class SpatialAudioTrack


Summary

Public companion functions

PointSourceParams?

Gets the PointSourceParams of the provided AudioTrack.

SoundFieldAttributes?

Gets the SoundFieldAttributes of the provided AudioTrack.

Int

Gets the SourceType of the provided AudioTrack.

Unit
setPointSourceParams(
    session: Session,
    track: AudioTrack,
    params: PointSourceParams
)

Sets a new PointSourceParams on the provided AudioTrack.

Public constructors

Public companion functions

getPointSourceParams

Added in 1.0.0-alpha04
fun getPointSourceParams(session: Session, track: AudioTrack): PointSourceParams?

Gets the PointSourceParams of the provided AudioTrack.

Parameters
session: Session

The current SceneCore Session instance.

track: AudioTrack

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

Gets the SourceType of the provided AudioTrack. If setPointSourceParams has not yet been called, this value is implicitly set by which type of attributes was used to configure the builder. Will return SpatializerConstants.DEFAULT for tracks that didn't use spatial audio attributes.

If setPointSourceParams is called and the SourceType was either SpatializerConstants.DEFAULT or SpatializerConstants.POINT_SOURCE, then the return value will be SpatializerConstants.POINT_SOURCE. If the SourceType was SpatializerConstants.SOUND_FIELD then the return value will remain SpatializerConstants.SOUND_FIELD.

Parameters
session: Session

The current SceneCore Session instance.

track: AudioTrack

The AudioTrack from which to get the SpatializerConstants.SourceType.

Returns
Int

The SpatializerConstants.SourceType of the provided track.

setPointSourceParams

Added in 1.0.0-alpha04
fun setPointSourceParams(
    session: Session,
    track: AudioTrack,
    params: PointSourceParams
): Unit

Sets a new PointSourceParams on the provided AudioTrack.

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

Parameters
session: Session

The current SceneCore Session instance.

track: AudioTrack

The AudioTrack on which to set the PointSourceParams.

params: PointSourceParams

The PointSourceParams to be set.

Throws
kotlin.IllegalStateException

if the SpatializerConstants.SourceType of the AudioTrack is SpatializerConstants.SOUND_FIELD.

kotlin.IllegalArgumentException

if the PointSourceParams is not able to be set.

Public constructors

SpatialAudioTrack

Added in 1.0.0-alpha04
SpatialAudioTrack()