Class AudioDuck

Index

Methods

create registerChannel setBaseVolume removeChannel hasChannel channelCount triggerDuck cancelDuck hasEvent eventCount getChannelMultiplier getChannel forEach list tick clear dispose

Methods

`Static`create

create(opts?: AudioDuckOptions): AudioDuck
Parameters
- opts: AudioDuckOptions = {}
Returns AudioDuck
- Defined in runtime/audio-duck.ts:107

registerChannel

registerChannel(spec: DuckChannelSpec): boolean
Parameters
- spec: DuckChannelSpec
Returns boolean
- Defined in runtime/audio-duck.ts:111

setBaseVolume

setBaseVolume(id: string, volume: number): boolean
Parameters
- id: string
- volume: number
Returns boolean
- Defined in runtime/audio-duck.ts:124

removeChannel

removeChannel(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/audio-duck.ts:133

hasChannel

hasChannel(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/audio-duck.ts:138

channelCount

channelCount(): number
Returns number
- Defined in runtime/audio-duck.ts:142

triggerDuck

triggerDuck(spec: DuckEventSpec): boolean
Parameters
- spec: DuckEventSpec
Returns boolean
- Defined in runtime/audio-duck.ts:146

cancelDuck

cancelDuck(eventId: string): boolean
Parameters
- eventId: string
Returns boolean
- Defined in runtime/audio-duck.ts:188

hasEvent

hasEvent(eventId: string): boolean
Parameters
- eventId: string
Returns boolean
- Defined in runtime/audio-duck.ts:201

eventCount

eventCount(): number
Returns number
- Defined in runtime/audio-duck.ts:205

getChannelMultiplier

getChannelMultiplier(channelId: string): number
Parameters
- channelId: string
Returns number
- Defined in runtime/audio-duck.ts:210

getChannel

getChannel(channelId: string): DuckChannelSnapshot | null
Parameters
- channelId: string
Returns DuckChannelSnapshot | null
- Defined in runtime/audio-duck.ts:229

forEach

forEach(cb: (ch: DuckChannelSnapshot) => void): void
Parameters
- cb: (ch: DuckChannelSnapshot) => void
Returns void
- Defined in runtime/audio-duck.ts:243

list

list(): DuckChannelSnapshot[]
Returns DuckChannelSnapshot[]
- Defined in runtime/audio-duck.ts:256

tick

tick(dtMs: number): void
Parameters
- dtMs: number
Returns void
- Defined in runtime/audio-duck.ts:269

clear

clear(): void
Returns void
- Defined in runtime/audio-duck.ts:310

dispose

dispose(): void
Returns void
- Defined in runtime/audio-duck.ts:316