core/com.pico.spatial.core.ecs.audio/AudioStreamConfig/AudioStreamConfig

AudioStreamConfig

constructor(channelLayoutType: AudioChannelLayoutType = AudioChannelLayoutType.STANDARD, audioMixerGroupId: String = "", channelLayout: AudioChannelLayout = AudioChannelLayout.OUTPUT_LAYOUT_STEREO, ambisonicType: AmbisonicsType = AmbisonicsType.NONE, audioFormat: AudioFormat = AudioFormat())

Constructs an audio stream configuration for playback control.

Parameters

channelLayoutType

Specifies audio spatialization mode: - AudioChannelLayoutType.STANDARD for traditional layouts (stereo, 5.1, etc.). - AudioChannelLayoutType.AMBISONICS for spherical harmonic-based audio.

audioMixerGroupId

Audio group identifier for volume/mixing control.

channelLayout

Required when using STANDARD layout: - Must be non-null if channelLayoutType is STANDARD. - Specify channel arrangement (e.g. OUTPUT_LAYOUT_5_1_2).

ambisonicType

Required when using AMBISONICS layout: - Must be non-null if channelLayoutType is AMBISONICS. - Specify Ambisonics format (e.g. ACN_SN3D_1).

audioFormat

PCM format details including: - Sample rate (e.g. 48000). - Bit depth. - Channel count.

Usage example:

// STANDARD configuration
AudioStreamConfig(
    AudioChannelLayoutType.STANDARD,
    "game_effects",
    AudioChannelLayout.OUTPUT_LAYOUT_STEREO,
    AmbisonicsType.NONE,
    AudioFormat(sampleRate = 48000)
)

// AMBISONICS configuration
AudioStreamConfig(
    AudioChannelLayoutType.AMBISONICS,
    "environment",
    AudioChannelLayout.OUTPUT_LAYOUT_INVALID,
    AmbisonicsType.ACN_SN3D_2,
    AudioFormat(sampleRate = 96000)
)

Throws

IllegalStateException

if configuration parameters are invalid: - When channelLayoutType is AudioChannelLayoutType.STANDARD and channelLayout is AudioChannelLayout.OUTPUT_LAYOUT_INVALID. - When channelLayoutType is AudioChannelLayoutType.AMBISONICS and ambisonicType is AmbisonicsType.NONE.