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

AudioStreamConfig

Configuration class for pcm audio stream playback and data handling.

This class encapsulates all necessary parameters for configuring an audio stream player in the ECS system, including channel layout specifications, audio format details, and data delivery mode selection.

Key features:

Supports both push and pull modes for audio data delivery
Handles standard and Ambisonics channel layouts
Manages audio format specifications including sample rate and channel configuration
Integrates with the audio mix group system for volume control

Usage example:

// STANDARD config
val standardConfig = AudioStreamConfig(
    AudioChannelLayoutType.STANDARD,
    "mix_group_1",
    AudioChannelLayout.OUTPUT_LAYOUT_STEREO,
    AmbisonicsType.NONE,
    AudioFormat(sampleRate = 48000),
    null
)

// AMBISONICS config
val ambisonicConfig = AudioStreamConfig(
    AudioChannelLayoutType.AMBISONICS,
    "mix_group_2",
    AudioChannelLayout.OUTPUT_LAYOUT_INVALID,
    AmbisonicsType.ACN_SN3D_1,
    AudioFormat(sampleRate = 96000)
)

Constructors

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.