Class AudioEngine

The central audio API: a thin, game-oriented layer over the Web Audio API. Owns one AudioContext, a tree of AudioBuses (master plus sfx / music / ui / voice), an AudioLoader, and the pool of live SoundHandle voices.

Standalone — instantiate one with new AudioEngine(), drive it from your own loop:

const audio = new AudioEngine();
audio.resumeOnGesture();                       // unlock on first interaction
const clip = await audio.load('/sfx/hit.ogg');
audio.play(clip, { bus: 'sfx' });              // one-shot
audio.playAt(clip, enemy.position).follow(enemy);
// per frame:
audio.updateListener(camPos, camForward, camUp);
audio.update(dt);

Index

Constructors

constructor

new AudioEngine(): AudioEngine
Returns AudioEngine

Accessors

context

get context(): AudioContext
The underlying context, created lazily on first access.

Returns AudioContext
- Defined in src/audio/audio_engine.ts:56

ready

get ready(): boolean
True once the context exists and is running (not suspended/closed).

Returns boolean
- Defined in src/audio/audio_engine.ts:66

master

get master(): AudioBus
The master bus all other buses route through.

Returns AudioBus
- Defined in src/audio/audio_engine.ts:126

masterVolume

get masterVolume(): number
Master volume in [0, 1]. Shorthand for master.volume.

Returns number
- Defined in src/audio/audio_engine.ts:132
set masterVolume(v: number): void
Parameters
- v: number
Returns void
- Defined in src/audio/audio_engine.ts:135

muted

get muted(): boolean
Mute/unmute all output. Volume settings are preserved across toggles.

Returns boolean
- Defined in src/audio/audio_engine.ts:140
set muted(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in src/audio/audio_engine.ts:143

loader

get loader(): AudioLoader
The shared loader, for advanced use (eviction, manual decode).

Returns AudioLoader
- Defined in src/audio/audio_engine.ts:169

activeVoices

get activeVoices(): number
Number of live (not yet pruned) voices.

Returns number
- Defined in src/audio/audio_engine.ts:208

musicVolume

get musicVolume(): number
The music bus volume in [0, 1].

Returns number
- Defined in src/audio/audio_engine.ts:260
set musicVolume(v: number): void
Parameters
- v: number
Returns void
- Defined in src/audio/audio_engine.ts:263

Methods

resume

resume(): Promise<void>
Resume the context. Browsers require this to run from a user gesture.

Returns Promise<void>
- Defined in src/audio/audio_engine.ts:71

resumeOnGesture

resumeOnGesture(target?: EventTarget): void
Resume the context on the first user interaction. Attaches one-shot pointer/touch/key listeners to target (default window) and removes them once the context is running. Safe to call before any gesture.
Parameters
- target: EventTarget = window
Returns void
- Defined in src/audio/audio_engine.ts:83

bus

bus(name?: BusName): AudioBus
Get (or lazily create, parented to master) a bus by name.
Parameters
- name: BusName = 'sfx'
Returns AudioBus
- Defined in src/audio/audio_engine.ts:115

load

load(url: string): Promise<AudioClip>
Fetch + decode (cached) a clip. See AudioLoader.load.
Parameters
- url: string
Returns Promise<AudioClip>
- Defined in src/audio/audio_engine.ts:151

loadAll

loadAll(urls: readonly string[]): Promise<AudioClip[]>
Load several clips in parallel.
Parameters
- urls: readonly string[]
Returns Promise<AudioClip[]>
- Defined in src/audio/audio_engine.ts:157

decode

decode(name: string, data: ArrayBuffer): Promise<AudioClip>
Decode an already-fetched buffer into a clip cached under name.
Parameters
- name: string
- data: ArrayBuffer
Returns Promise<AudioClip>
- Defined in src/audio/audio_engine.ts:163

play

play(
clip: AudioClip,
opts?: VoiceOptions & { bus?: BusName },
): SoundHandle | null
Play a non-spatial one-shot through a bus (default sfx). Returns a handle for control, or null if the context isn't running yet.
Parameters
- clip: AudioClip
- opts: VoiceOptions & { bus?: BusName } = {}
Returns SoundHandle | null
- Defined in src/audio/audio_engine.ts:180

playAt

playAt(
    clip: AudioClip,
    pos: Vec3Like,
    opts?: VoiceOptions & { bus?: BusName },
): SoundHandle | null
Play a spatial one-shot positioned at pos (a PannerNode). Defaults to the sfx bus. Call .follow(target) on the result to track a moving object.
Parameters
- clip: AudioClip
- pos: Vec3Like
- opts: VoiceOptions & { bus?: BusName } = {}
Returns SoundHandle | null
- Defined in src/audio/audio_engine.ts:188

playMusic

playMusic(
track: string | AudioClip,
opts?: MusicOptions,
): Promise<SoundHandle | null>
Play a looping background track through the music bus. Only one track plays at a time; calling again replaces it, optionally crossfading. Accepts a URL (loaded on demand) or a preloaded AudioClip.
Parameters
- track: string | AudioClip
- opts: MusicOptions = {}
Returns Promise<SoundHandle | null>
- Defined in src/audio/audio_engine.ts:219

stopMusic

stopMusic(fade?: number): void
Stop the current music track, optionally fading out over fade seconds.
Parameters
- fade: number = 0
Returns void
- Defined in src/audio/audio_engine.ts:247

fadeOutMusic

fadeOutMusic(duration?: number): void
Fade the current music out over duration seconds, then stop.
Parameters
- duration: number = 2
Returns void
- Defined in src/audio/audio_engine.ts:255

requestMicrophone

requestMicrophone(opts?: MicrophoneOptions): Promise<Microphone>
Request microphone access. See Microphone.request.
Parameters
- Optionalopts: MicrophoneOptions
Returns Promise<Microphone>
- Defined in src/audio/audio_engine.ts:270

createAnalyser

createAnalyser(opts?: AudioAnalyserOptions): AudioAnalyser
Create a standalone analyser. Connect a source into its .input to tap it, or pass it to AudioBus.analyser to tap a bus.
Parameters
- Optionalopts: AudioAnalyserOptions
Returns AudioAnalyser
- Defined in src/audio/audio_engine.ts:278

updateListener

updateListener(position: Vec3Like, forward: Vec3Like, up: Vec3Like): void
Sync the 3D listener (the "ears") to the camera. Call every frame. Handles the modern AudioParam listener and the deprecated Firefox setter fallback.
Parameters
- position: Vec3Like
- forward: Vec3Like
- up: Vec3Like
Returns void
- Defined in src/audio/audio_engine.ts:288

update

update(_dt?: number): void
Per-frame housekeeping: advance follow()-bound spatial voices and prune finished ones. Call once per frame after gameplay updates.
Parameters
- _dt: number = 0
Returns void
- Defined in src/audio/audio_engine.ts:318

dispose

dispose(): void
Stop everything and close the context.

Returns void
- Defined in src/audio/audio_engine.ts:336

Class AudioEngine

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns AudioEngine

Accessors

context

Returns AudioContext

ready

Returns boolean

master

Returns AudioBus

masterVolume

Returns number

Parameters

Returns void

muted

Returns boolean

Parameters

Returns void

loader

Returns AudioLoader

activeVoices

Returns number

musicVolume

Returns number

Parameters

Returns void

Methods

resume

Returns Promise<void>

resumeOnGesture

Parameters

Returns void

bus

Parameters

Returns AudioBus

load

Parameters

Returns Promise<AudioClip>

loadAll

Parameters

Returns Promise<AudioClip[]>

decode

Parameters

Returns Promise<AudioClip>

play

Parameters

Returns SoundHandle | null

playAt

Parameters

Returns SoundHandle | null

playMusic

Parameters

Returns Promise<SoundHandle | null>

stopMusic

Parameters

Returns void

fadeOutMusic

Parameters

Returns void

requestMicrophone

Parameters

Returns Promise<Microphone>

createAnalyser

Parameters

Returns AudioAnalyser

updateListener

Parameters

Returns void

update

Parameters

Returns void

dispose

Returns void

Settings

On This Page