Class AudioManager

AudioManager is a framework-agnostic audio management system built on the Web Audio API. It provides centralized control for organizing, playing, and managing audio assets in games and interactive applications.

Example

const audio = new AudioManager();

// Initialize on user interaction (required by browsers)
button.onclick = async () => {
  await audio.resumeAudioContext();
};

// Add and play sounds
audio.addAudioTrack('explosion', 'sfx', '/sounds/explosion.wav');
await audio.preload(['explosion']);
audio.playAudioTrack('explosion');

// Play background music with fade
audio.addAudioTrack('music', 'music', '/sounds/track.mp3');
await audio.fadeIn('music', 2000);

Index

Constructors

constructor

new AudioManager(): AudioManager
Creates a new AudioManager instance.

Returns AudioManager
- Defined in audio-manager.ts:147

Properties

`Readonly`onTrackStart$

onTrackStart$: Observable<TrackStartEvent>

Observable that emits when a track starts playing.

`Readonly`onTrackEnd$

onTrackEnd$: Observable<TrackEndEvent>

Observable that emits when a track finishes playing.

`Readonly`onLoadComplete$

onLoadComplete$: Observable<LoadCompleteEvent>

Observable that emits when a track's metadata is loaded and ready to play.

`Readonly`onError$

onError$: Observable<AudioErrorEvent>

Observable that emits when an audio error occurs.

`Readonly`onPositionUpdate$

onPositionUpdate$: Observable<PositionUpdateEvent>

Observable that emits when a 3D sound's position is updated.

`Readonly`onOrientationUpdate$

onOrientationUpdate$: Observable<OrientationUpdateEvent>

Observable that emits when a 3D sound's orientation is updated.

`Readonly`onDistanceThreshold$

onDistanceThreshold$: Observable<DistanceThresholdEvent>

Observable that emits when a 3D sound crosses a distance threshold.

Accessors

loggingEnabled

get loggingEnabled(): boolean
Gets or sets whether debug logging is enabled.

Returns boolean
- Defined in audio-manager.ts:136
set loggingEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in audio-manager.ts:140

Methods

initAudio

initAudio(): Promise<void>
Initializes the AudioContext and resumes it if suspended.

Returns Promise<void>
- Defined in audio-manager.ts:190

resumeAudioContext

resumeAudioContext(): Promise<void>
Resumes a suspended AudioContext.

Returns Promise<void>
- Defined in audio-manager.ts:197

suspendAudioContext

suspendAudioContext(): Promise<void>
Suspends the AudioContext to save resources.

Returns Promise<void>
- Defined in audio-manager.ts:204

isAudioReady

isAudioReady(): boolean
Checks if the AudioContext is initialized and running.

Returns boolean
- Defined in audio-manager.ts:211

setMasterVolume

setMasterVolume(volume: number): void
Sets the master volume that affects all audio output.
Parameters
- volume: number
Returns void
- Defined in audio-manager.ts:220

getMasterVolume

getMasterVolume(): number
Gets the current master volume level.

Returns number
- Defined in audio-manager.ts:227

setAudioEnabled

setAudioEnabled(group: string, enabled: boolean): void
Enables or disables audio playback for a specific group.
Parameters
- group: string
- enabled: boolean
Returns void
- Defined in audio-manager.ts:236

setAudioVolume

setAudioVolume(group: string, volume: number): void
Sets the volume for a specific audio group.
Parameters
- group: string
- volume: number
Returns void
- Defined in audio-manager.ts:244

setGroupPoolSize

setGroupPoolSize(group: string, maxConcurrent: number): void
Sets the maximum number of concurrent sounds for a group.
Parameters
- group: string
- maxConcurrent: number
Returns void
- Defined in audio-manager.ts:251

getPoolStats

getPoolStats(group?: string): PoolStats | PoolStats[]
Gets statistics about the audio pool for one or all groups.
Parameters
- Optionalgroup: string
Returns PoolStats | PoolStats[]
- Defined in audio-manager.ts:258

isLoaded

isLoaded(key: string): boolean
Checks if all tracks for a key are fully loaded and ready to play.
Parameters
- key: string
Returns boolean
- Defined in audio-manager.ts:267

getLoadStatus

getLoadStatus(key: string): LoadStatus
Gets detailed loading status for a specific audio key.
Parameters
- key: string
Returns LoadStatus
- Defined in audio-manager.ts:274

preload

preload(keys: string[]): Promise<void>
Preloads audio tracks into memory for low-latency playback.
Parameters
- keys: string[]
Returns Promise<void>
- Defined in audio-manager.ts:281

addAudioTrack

addAudioTrack(key: string, group: string, path: string): void
Registers an audio track with the manager.
Parameters
- key: string
- group: string
- path: string
Returns void
- Defined in audio-manager.ts:290

playAudioTrack

playAudioTrack(key: string): void
Plays a one-shot sound effect.
Parameters
- key: string
Returns void
- Defined in audio-manager.ts:299

playContinuous

playContinuous(key: string, channelId?: string): void
Starts continuous playback on a channel.
Parameters
- key: string
- channelId: string = DEFAULT_CHANNEL
Returns void
- Defined in audio-manager.ts:308

stopContinuous

stopContinuous(channelId?: string): void
Stops continuous playback on a channel.
Parameters
- channelId: string = DEFAULT_CHANNEL
Returns void
- Defined in audio-manager.ts:315

pauseContinuous

pauseContinuous(channelId?: string): void
Pauses continuous playback on a channel.
Parameters
- channelId: string = DEFAULT_CHANNEL
Returns void
- Defined in audio-manager.ts:323

resumeContinuous

resumeContinuous(channelId?: string): void
Resumes paused continuous playback on a channel.
Parameters
- channelId: string = DEFAULT_CHANNEL
Returns void
- Defined in audio-manager.ts:330

fadeIn

fadeIn(key: string, duration: number, channelId?: string): Promise<void>
Starts playback with a gradual volume fade-in effect.
Parameters
- key: string
- duration: number
- channelId: string = DEFAULT_CHANNEL
Returns Promise<void>
- Defined in audio-manager.ts:339

fadeOut

fadeOut(duration: number, channelId?: string): Promise<void>
Gradually fades out and stops the current playback on a channel.
Parameters
- duration: number
- channelId: string = DEFAULT_CHANNEL
Returns Promise<void>
- Defined in audio-manager.ts:346

crossFade

crossFade(key: string, duration: number, channelId?: string): Promise<void>
Cross-fades from the current track to a new track.
Parameters
- key: string
- duration: number
- channelId: string = DEFAULT_CHANNEL
Returns Promise<void>
- Defined in audio-manager.ts:353

getActiveChannels

getActiveChannels(): { [channelId: string]: ChannelInfo }
Gets information about all active continuous playback channels.

Returns { [channelId: string]: ChannelInfo }
- Defined in audio-manager.ts:362

getChannelInfo

getChannelInfo(channelId?: string): ChannelInfo | null
Gets information about a specific playback channel.
Parameters
- channelId: string = DEFAULT_CHANNEL
Returns ChannelInfo | null
- Defined in audio-manager.ts:369

stopAllContinuous

stopAllContinuous(): void
Stops all continuous playback on all channels.

Returns void
- Defined in audio-manager.ts:376

pauseAllContinuous

pauseAllContinuous(): void
Pauses all continuous playback on all channels.

Returns void
- Defined in audio-manager.ts:383

resumeAllContinuous

resumeAllContinuous(): void
Resumes all paused continuous playback on all channels.

Returns void
- Defined in audio-manager.ts:390

setPlaybackRate

setPlaybackRate(rate: number, channelId?: string): void
Sets the playback speed/rate for a channel.
Parameters
- rate: number
- channelId: string = DEFAULT_CHANNEL
Returns void
- Defined in audio-manager.ts:399

getPlaybackRate

getPlaybackRate(channelId?: string): number | null
Gets the current playback rate for a channel.
Parameters
- channelId: string = DEFAULT_CHANNEL
Returns number | null
- Defined in audio-manager.ts:406

seek

seek(time: number, channelId?: string): void
Seeks to a specific time position in the current track.
Parameters
- time: number
- channelId: string = DEFAULT_CHANNEL
Returns void
- Defined in audio-manager.ts:413

getCurrentTime

getCurrentTime(channelId?: string): number | null
Gets the current playback time in seconds.
Parameters
- channelId: string = DEFAULT_CHANNEL
Returns number | null
- Defined in audio-manager.ts:420

getDuration

getDuration(channelId?: string): number | null
Gets the total duration of the current track in seconds.
Parameters
- channelId: string = DEFAULT_CHANNEL
Returns number | null
- Defined in audio-manager.ts:427

getPlaybackInfo

getPlaybackInfo(channelId?: string): PlaybackInfo | null
Gets comprehensive playback information for a channel.
Parameters
- channelId: string = DEFAULT_CHANNEL
Returns PlaybackInfo | null
- Defined in audio-manager.ts:434

addImpulseResponse

addImpulseResponse(key: string, path: string): void
Registers an impulse response for use with convolution reverb.
Parameters
- key: string
- path: string
Returns void
- Defined in audio-manager.ts:443

preloadImpulses

preloadImpulses(keys: string[]): Promise<void>
Preloads impulse response files into memory.
Parameters
- keys: string[]
Returns Promise<void>
- Defined in audio-manager.ts:450

isImpulseLoaded

isImpulseLoaded(key: string): boolean
Checks if an impulse response is fully loaded and ready for use.
Parameters
- key: string
Returns boolean
- Defined in audio-manager.ts:457

setEffectsMix

setEffectsMix(wet: number): void
Sets the wet/dry mix for the effects bus.
Parameters
- wet: number
Returns void
- Defined in audio-manager.ts:464

getEffectsMix

getEffectsMix(): number
Gets the current wet/dry mix for the effects bus.

Returns number
- Defined in audio-manager.ts:471

setEffectsReverb

setEffectsReverb(key: string | null): Promise<void>
Applies a reverb effect using a loaded impulse response.
Parameters
- key: string | null
Returns Promise<void>
- Defined in audio-manager.ts:478

getActiveReverb

getActiveReverb(): string | null
Gets the key of the currently active reverb impulse response.

Returns string | null
- Defined in audio-manager.ts:485

setEffectsLowPass

setEffectsLowPass(frequency: number, Q?: number): void
Sets the low-pass filter parameters for the effects bus.
Parameters
- frequency: number
- Q: number = 1
Returns void
- Defined in audio-manager.ts:492

getEffectsLowPass

getEffectsLowPass(): FilterConfig | null
Gets the current low-pass filter configuration.

Returns FilterConfig | null
- Defined in audio-manager.ts:499

setEffectsHighPass

setEffectsHighPass(frequency: number, Q?: number): void
Sets the high-pass filter parameters for the effects bus.
Parameters
- frequency: number
- Q: number = 1
Returns void
- Defined in audio-manager.ts:506

getEffectsHighPass

getEffectsHighPass(): FilterConfig | null
Gets the current high-pass filter configuration.

Returns FilterConfig | null
- Defined in audio-manager.ts:513

isEffectsBusInitialized

isEffectsBusInitialized(): boolean
Checks if the effects bus has been initialized.

Returns boolean
- Defined in audio-manager.ts:520

getEffectsBusState

getEffectsBusState(): {
    initialized: boolean;
    wetMix: number;
    activeReverb: string
    | null;
    lowPass: FilterConfig | null;
    highPass: FilterConfig | null;
    registeredImpulses: string[];
}
Gets comprehensive state information about the effects bus.

Returns {
    initialized: boolean;
    wetMix: number;
    activeReverb: string | null;
    lowPass: FilterConfig | null;
    highPass: FilterConfig | null;
    registeredImpulses: string[];
}
- Defined in audio-manager.ts:527

setEnvironment

setEnvironment(
config: EnvironmentPreset | EnvironmentConfig | null,
): Promise<void>
Applies an environment configuration or preset.
Parameters
- config: EnvironmentPreset | EnvironmentConfig | null
Returns Promise<void>
- Defined in audio-manager.ts:543

getEnvironment

getEnvironment(): EnvironmentConfig | null
Gets the currently active environment configuration.

Returns EnvironmentConfig | null
- Defined in audio-manager.ts:550

transitionToEnvironment

transitionToEnvironment(
config: EnvironmentPreset | EnvironmentConfig | null,
duration: number,
): Promise<void>
Smoothly transitions to a new environment over time.
Parameters
- config: EnvironmentPreset | EnvironmentConfig | null
- duration: number
Returns Promise<void>
- Defined in audio-manager.ts:557

setGroupBypassEffects

setGroupBypassEffects(group: string, bypass: boolean): void
Sets whether a group should bypass the effects bus.
Parameters
- group: string
- bypass: boolean
Returns void
- Defined in audio-manager.ts:567

isGroupBypassingEffects

isGroupBypassingEffects(group: string): boolean
Checks if a group is currently bypassing the effects bus.
Parameters
- group: string
Returns boolean
- Defined in audio-manager.ts:576

getBypassedGroups

getBypassedGroups(): string[]
Gets a list of all groups that are currently bypassing effects.

Returns string[]
- Defined in audio-manager.ts:583

setListenerPosition

setListenerPosition(position: Vector3): void
Sets the position of the audio listener.
Parameters
- position: Vector3
Returns void
- Defined in audio-manager.ts:592

getListenerPosition

getListenerPosition(): Vector3
Gets the current listener position.

Returns Vector3
- Defined in audio-manager.ts:599

setListenerOrientation

setListenerOrientation(forward: Vector3, up: Vector3): void
Sets the orientation of the audio listener.
Parameters
- forward: Vector3
- up: Vector3
Returns void
- Defined in audio-manager.ts:606

getListenerOrientation

getListenerOrientation(): { forward: Vector3; up: Vector3 }
Gets the current listener orientation.

Returns { forward: Vector3; up: Vector3 }
- Defined in audio-manager.ts:613

setSpatialDefaults

setSpatialDefaults(config: Partial<SpatialConfig>): void
Sets the default spatial configuration used for new 3D sounds.
Parameters
- config: Partial<SpatialConfig>
Returns void
- Defined in audio-manager.ts:620

getSpatialDefaults

getSpatialDefaults(): SpatialConfig
Gets the current default spatial configuration.

Returns SpatialConfig
- Defined in audio-manager.ts:627

getSpatialState

getSpatialState(): {
    listenerPosition: Vector3;
    listenerOrientation: { forward: Vector3; up: Vector3 };
    defaults: SpatialConfig;
}
Gets comprehensive state information about the spatial audio system.

Returns {
    listenerPosition: Vector3;
    listenerOrientation: { forward: Vector3; up: Vector3 };
    defaults: SpatialConfig;
}
- Defined in audio-manager.ts:634

play3D

play3D(key: string, position: Vector3, options?: Play3DOptions): string | null
Plays a one-shot sound at a specific position in 3D space.
Parameters
- key: string
- position: Vector3
- Optionaloptions: Play3DOptions
Returns string | null
- Defined in audio-manager.ts:647

playContinuous3D

playContinuous3D(
    key: string,
    position: Vector3,
    channelId?: string,
    options?: Play3DOptions,
): Promise<void>
Plays continuous audio at a specific position in 3D space.
Parameters
- key: string
- position: Vector3
- channelId: string = 'default_3d'
- Optionaloptions: Play3DOptions
Returns Promise<void>
- Defined in audio-manager.ts:654

updateSoundPosition

updateSoundPosition(instanceId: string, position: Vector3): boolean
Updates the position of a playing 3D sound (one-shot).
Parameters
- instanceId: string
- position: Vector3
Returns boolean
- Defined in audio-manager.ts:666

updateChannelPosition

updateChannelPosition(channelId: string, position: Vector3): boolean
Updates the position of a continuous 3D channel.
Parameters
- channelId: string
- position: Vector3
Returns boolean
- Defined in audio-manager.ts:673

is3DSound

is3DSound(instanceId: string): boolean
Checks if a sound instance is a 3D positioned sound.
Parameters
- instanceId: string
Returns boolean
- Defined in audio-manager.ts:680

is3DChannel

is3DChannel(channelId: string): boolean
Checks if a channel is a 3D positioned channel.
Parameters
- channelId: string
Returns boolean
- Defined in audio-manager.ts:687

getSoundPosition

getSoundPosition(instanceId: string): Vector3 | null
Gets the current position of a 3D sound.
Parameters
- instanceId: string
Returns Vector3 | null
- Defined in audio-manager.ts:694

getChannelPosition

getChannelPosition(channelId: string): Vector3 | null
Gets the current position of a 3D channel.
Parameters
- channelId: string
Returns Vector3 | null
- Defined in audio-manager.ts:701

setSoundOrientation

setSoundOrientation(instanceId: string, orientation: Vector3): boolean
Sets the orientation of a playing 3D sound (one-shot).
Parameters
- instanceId: string
- orientation: Vector3
Returns boolean
- Defined in audio-manager.ts:710

setChannelOrientation

setChannelOrientation(channelId: string, orientation: Vector3): boolean
Sets the orientation of a continuous 3D channel.
Parameters
- channelId: string
- orientation: Vector3
Returns boolean
- Defined in audio-manager.ts:717

getSoundOrientation

getSoundOrientation(instanceId: string): Vector3 | null
Gets the current orientation of a 3D sound.
Parameters
- instanceId: string
Returns Vector3 | null
- Defined in audio-manager.ts:724

getChannelOrientation

getChannelOrientation(channelId: string): Vector3 | null
Gets the current orientation of a 3D channel.
Parameters
- channelId: string
Returns Vector3 | null
- Defined in audio-manager.ts:731

play2DPanned

play2DPanned(key: string, options?: Play2DPannedOptions): string | null
Plays a one-shot sound with stereo panning.
Parameters
- key: string
- Optionaloptions: Play2DPannedOptions
Returns string | null
- Defined in audio-manager.ts:738

setPan

setPan(instanceId: string, pan: number): boolean
Updates the stereo pan position of a playing 2D panned sound.
Parameters
- instanceId: string
- pan: number
Returns boolean
- Defined in audio-manager.ts:745

getSoundPan

getSoundPan(instanceId: string): number | null
Gets the current pan position of a 2D panned sound.
Parameters
- instanceId: string
Returns number | null
- Defined in audio-manager.ts:752

is2DPannedSound

is2DPannedSound(instanceId: string): boolean
Checks if a sound instance is a 2D panned sound.
Parameters
- instanceId: string
Returns boolean
- Defined in audio-manager.ts:759

registerDistanceCallback

registerDistanceCallback(
instanceId: string,
config: DistanceCallbackConfig,
): boolean
Registers distance callbacks for a 3D sound.
Parameters
- instanceId: string
- config: DistanceCallbackConfig
Returns boolean
- Defined in audio-manager.ts:766

unregisterDistanceCallback

unregisterDistanceCallback(instanceId: string): boolean
Unregisters distance callbacks for a sound.
Parameters
- instanceId: string
Returns boolean
- Defined in audio-manager.ts:773

stopAudioGroup

stopAudioGroup(group: string): void
Stops all active one-shot sounds in a specific group.
Parameters
- group: string
Returns void
- Defined in audio-manager.ts:782

destroy

destroy(): void
Destroys the AudioManager and releases all resources.

Returns void
- Defined in audio-manager.ts:789

Class AudioManager

Example

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns AudioManager

Properties

ReadonlyonTrackStart$

ReadonlyonTrackEnd$

ReadonlyonLoadComplete$

ReadonlyonError$

ReadonlyonPositionUpdate$

ReadonlyonOrientationUpdate$

ReadonlyonDistanceThreshold$

Accessors

loggingEnabled

Returns boolean

Parameters

Returns void

Methods

initAudio

Returns Promise<void>

resumeAudioContext

Returns Promise<void>

suspendAudioContext

Returns Promise<void>

isAudioReady

Returns boolean

setMasterVolume

Parameters

Returns void

getMasterVolume

Returns number

setAudioEnabled

Parameters

Returns void

setAudioVolume

Parameters

Returns void

setGroupPoolSize

Parameters

Returns void

getPoolStats

Parameters

Returns PoolStats | PoolStats[]

isLoaded

Parameters

Returns boolean

getLoadStatus

Parameters

Returns LoadStatus

preload

Parameters

Returns Promise<void>

addAudioTrack

Parameters

Returns void

playAudioTrack

Parameters

Returns void

playContinuous

Parameters

Returns void

stopContinuous

Parameters

Returns void

pauseContinuous

Parameters

Returns void

resumeContinuous

Parameters

Returns void

fadeIn

Parameters

Returns Promise<void>

fadeOut

`Readonly`onTrackStart$

`Readonly`onTrackEnd$

`Readonly`onLoadComplete$

`Readonly`onError$

`Readonly`onPositionUpdate$

`Readonly`onOrientationUpdate$

`Readonly`onDistanceThreshold$

Returns {
initialized: boolean;
wetMix: number;
activeReverb: string | null;
lowPass: FilterConfig | null;
highPass: FilterConfig | null;
registeredImpulses: string[];
}