Skip to content
InterfaceAudio System@public

FlxAudioBackend

Replaceable audio backend. The browser implementation wraps Web Audio API; the null implementation enables headless testing.

ts
export interface FlxAudioBackend

Properties

PropertyModifiersTypeDescription
suspendedreadonlyboolean-
unlockedreadonlyboolean-

Methods

createSound()

ts
createSound(source: unknown, streaming: boolean): FlxSoundHandle

Create a sound handle.

Parameters:

ParameterTypeDescription
sourceunknowndecoded AudioBuffer, URL string, or HTMLAudioElement.
streamingbooleantrue to use a media-element source node.

Returns: FlxSoundHandle

destroy()

ts
destroy(): void

Returns: void

pauseAll()

ts
pauseAll(): void

Returns: void

resumeAll()

ts
resumeAll(): void

Returns: void

setGlobalMute()

ts
setGlobalMute(muted: boolean): void

Parameters:

ParameterTypeDescription
mutedboolean-

Returns: void

setGlobalVolume()

ts
setGlobalVolume(volume: number): void

Parameters:

ParameterTypeDescription
volumenumber-

Returns: void

unlockAudio()

ts
unlockAudio(): void

Wire gesture listeners (click/keydown/touchstart) to unlock audio.

Returns: void

Released under the MIT License.