Skip to main content

Class: AudioController

Defined in: modules/engine/src/audio/audio-controller.ts:113

Scene-bound Web Audio playback, independent of the asset format and GPU backend.

Constructors​

Constructor​

new AudioController(options): AudioController

Defined in: modules/engine/src/audio/audio-controller.ts:140

Parameters​

options​

AudioControllerOptions

Returns​

AudioController

Properties​

definition​

readonly definition: AudioDefinition

Defined in: modules/engine/src/audio/audio-controller.ts:115


gain​

readonly gain: GainNode

Defined in: modules/engine/src/audio/audio-controller.ts:114

Methods​

destroy()​

destroy(): void

Defined in: modules/engine/src/audio/audio-controller.ts:408

Disconnect owned nodes and cancel pending loads; never closes the borrowed context.

Returns​

void


initialize()​

initialize(): Promise<void>

Defined in: modules/engine/src/audio/audio-controller.ts:189

Fetch and decode once. Safe to call repeatedly; does not start playback.

Returns​

Promise<void>


play()​

play(options?): Promise<void>

Defined in: modules/engine/src/audio/audio-controller.ts:199

Restart sources. Resume the application's AudioContext from a user gesture first.

Parameters​

options?​
autoplayOnly?​

boolean

restart?​

boolean

sourceIndices?​

readonly number[]

Returns​

Promise<void>


setGraphGain()​

setGraphGain(graphIndex, nodeIndex, gain): void

Defined in: modules/engine/src/audio/audio-controller.ts:227

Change a graph gain using its authored interpolation and duration.

Parameters​

graphIndex​

number

nodeIndex​

number

gain​

number

Returns​

void


stop()​

stop(): void

Defined in: modules/engine/src/audio/audio-controller.ts:299

Returns​

void


update()​

update(listenerMatrix): void

Defined in: modules/engine/src/audio/audio-controller.ts:312

Call after animation updates, with the camera's inverse view matrix. Distances are in meters.

Parameters​

listenerMatrix​

Matrix4

Returns​

void