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

AudioResourceConfig

class AudioResourceConfig(mixerGroupID: String, ambisonicsType: AmbisonicsType = AmbisonicsType.NONE)

The configuration of AudioResource. This class is used to configure the audio resource with a mix group name which is hold by AudioMixerGroupResource which will be used by AudioMixerGroupsComponent. The mixerGroupID can link AudioResource,AudioMixerGroupResource and AudioMixerGroupsComponent together, so that user can control the volume and playbackRate of the audio resources as a group.

Parameters

mixerGroupID

The name of the mix group.

ambisonicsType

The ambisonics audio type of the current audio resource.

Constructors

AudioResourceConfig

constructor(mixerGroupID: String, ambisonicsType: AmbisonicsType = AmbisonicsType.NONE)

constructor(mixerGroupID: String, ambisonicsType: AmbisonicsType = AmbisonicsType.NONE, randomStart: Boolean = false, loopEnable: Boolean = false)

Configuration class for AudioResource.

Properties

val ambisonicsType: AmbisonicsType

The ambisonics audio type of the audio resource.

val loopEnable: Boolean

Whether the audio resource should playback in loop mode.

val mixerGroupID: String

The identifier of the mixer group to which this audio resource belongs.

val randomStart: Boolean

Whether playback should begin at a random position within the audio resource's duration.