Class AmbientLayerMixer

Index

Methods

create registerLayer removeLayer hasLayer getLayer layerCount layerIds setTarget setTargets snap silenceAll tick forEach list clear dispose

Methods

`Static`create

create(opts?: AmbientLayerMixerOptions): AmbientLayerMixer
Parameters
- opts: AmbientLayerMixerOptions = {}
Returns AmbientLayerMixer
- Defined in runtime/ambient-layer-mixer.ts:99

registerLayer

registerLayer(spec: AmbientLayerSpec): boolean
Parameters
- spec: AmbientLayerSpec
Returns boolean
- Defined in runtime/ambient-layer-mixer.ts:103

removeLayer

removeLayer(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/ambient-layer-mixer.ts:129

hasLayer

hasLayer(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/ambient-layer-mixer.ts:134

getLayer

getLayer(id: string): AmbientLayerSnapshot | null
Parameters
- id: string
Returns AmbientLayerSnapshot | null
- Defined in runtime/ambient-layer-mixer.ts:138

layerCount

layerCount(): number
Returns number
- Defined in runtime/ambient-layer-mixer.ts:143

layerIds

layerIds(): string[]
Returns string[]
- Defined in runtime/ambient-layer-mixer.ts:145

setTarget

setTarget(
    id: string,
    target: number,
    opts?: AmbientLayerSetTargetOptions,
): boolean
Parameters
- id: string
- target: number
- opts: AmbientLayerSetTargetOptions = {}
Returns boolean
- Defined in runtime/ambient-layer-mixer.ts:158

setTargets

setTargets(
targets: Record<string, number>,
opts?: AmbientLayerSetTargetOptions,
): void
Parameters
- targets: Record<string, number>
- opts: AmbientLayerSetTargetOptions = {}
Returns void
- Defined in runtime/ambient-layer-mixer.ts:183

snap

snap(id: string, volume: number): boolean
Parameters
- id: string
- volume: number
Returns boolean
- Defined in runtime/ambient-layer-mixer.ts:194

silenceAll

silenceAll(): void
Returns void
- Defined in runtime/ambient-layer-mixer.ts:199

tick

tick(dtMs: number): void
Parameters
- dtMs: number
Returns void
- Defined in runtime/ambient-layer-mixer.ts:215

forEach

forEach(cb: (l: AmbientLayerSnapshot) => void): void
Parameters
- cb: (l: AmbientLayerSnapshot) => void
Returns void
- Defined in runtime/ambient-layer-mixer.ts:243

list

list(): AmbientLayerSnapshot[]
Returns AmbientLayerSnapshot[]
- Defined in runtime/ambient-layer-mixer.ts:253

clear

clear(): void
Returns void
- Defined in runtime/ambient-layer-mixer.ts:264

dispose

dispose(): void
Returns void
- Defined in runtime/ambient-layer-mixer.ts:269