AudioMixGroup

struct · iOS 18.0+ · SDK 27.1

struct AudioMixGroup

A group that manages the playback properties of multiple playing sounds. A mix group component manages the playback parameters for a collection of different ``AudioPlaybackController`` and ``AudioGeneratorController`` instances. Properties such as ``gain``, ``fade(to:duration:)``, and ``speed`` are multiplicative with the parameters you set on the controller. You associate audio resources to a mix group by setting the ``mixGroupName`` parameter in the resource's configuration. For an example, see ``AudioFileResource/Configuration-swift.struct/mixGroupName``. Enable a mix group by adding it to an ``AudioMixGroupsComponent`` structure on an entity in the scene. The scene where the component belongs limits the scope of the mix group. ```swift var mixGroup = AudioMixGroup(name: "myMixGroup") entity.components.set(AudioMixGroupsComponent(mixGroups: [mixGroup])) ```

Members (9)

fade(gain: number, duration: number): void

mutating func fade(to gain: Audio.Decibel, duration: TimeInterval)

get gain(): number

var gain: Audio.Decibel { get set }

set gain(value: number)

var gain: Audio.Decibel { get set }

static init(name: string): AudioMixGroup

init(name: String)

get name(): string

let name: String

get speed(): number

var speed: Double

set speed(value: number)

var speed: Double

get isMuted(): boolean

var isMuted: Bool

set isMuted(value: boolean)

var isMuted: Bool

All RealityFoundation types →