Class AudioSystem

constructor

• new AudioSystem(context?: AudioContext, events?: Events): AudioSystem

  Parameters

  • Optionalcontext: AudioContext

    An AudioContext to use instead of creating one -- lets tests (and any code that already owns a shared context) inject their own instead of relying on the global window.AudioContext.

  • Optionalevents: Events

    An optional per-instance event bus on which non-fatal audio events (like AUDIO_LOADED) are dispatched. Errors are deliberately not routed here -- load() throws so callers keep an explicit failure path, consistent with the other loaders.

  Returns AudioSystem

context

masterGain

musicGain

sfxGain

dispose

• dispose(): void

  Stops every still-running endless sound (startDrone/startFire graphs) and closes the AudioContext. Call this when tearing down the engine instance that owns this AudioSystem -- without it, both the endless sound graphs and the context itself outlive the instance for the lifetime of the page (browsers cap the number of concurrently open AudioContexts).

  Returns void

load

• load(url: string, name: string): Promise<void>

  Loads an audio file and decodes it into a buffer.

  Parameters

  • url: string

    The URL of the audio file.

  • name: string

    The unique name to identify the sound.

  Returns Promise<void>

play

• play(
      name: string,
      loop?: boolean,
      volume?: number,
  ): AudioBufferSourceNode | null

  Plays a global (non-spatial) sound.

  Parameters

  • name: string
  • loop: boolean = false
  • volume: number = 1.0

  Returns AudioBufferSourceNode | null

playFootstep

• playFootstep(): void

  Generates a retro synthesized footstep thud. See SynthSFX.playFootstep.

  Returns void

playHurt

• playHurt(): void

  Generates a retro "Ugh!" hurt sound. See SynthSFX.playHurt.

  Returns void

playMusic

• playMusic(
      name: string,
      loop?: boolean,
      volume?: number,
  ): AudioBufferSourceNode | null

  Plays a global (non-spatial) music track through the music bus, so it responds to setMusicVolume() independently of sound effects.

  Parameters

  • name: string
  • loop: boolean = true
  • volume: number = 1.0

  Returns AudioBufferSourceNode | null

playShoot

• playShoot(): void

  Generates a retro "Pew Pew" laser/gunshot sound. See SynthSFX.playShoot.

  Returns void

playSpatial

• playSpatial(
      name: string,
      position: Vector3D,
      loop?: boolean,
      volume?: number,
      refDistance?: number,
      maxDistance?: number,
  ): { panner: PannerNode; source: AudioBufferSourceNode } | null

  Plays a 3D spatial sound at a given position.

  Parameters

  • name: string
  • position: Vector3D
  • loop: boolean = false
  • volume: number = 1.0
  • refDistance: number = 2.0
  • maxDistance: number = 20.0

  Returns { panner: PannerNode; source: AudioBufferSourceNode } | null

playTone

• playTone(
      frequency?: number,
      duration?: number,
      volume?: number,
      type?: OscillatorType,
  ): void

  Generates a procedural synth tone (e.g., for musical instruments or physical impacts). See SynthSFX.playTone.

  Parameters

  • frequency: number = 440

    The base frequency in Hz.

  • duration: number = 0.5

    The duration of the tone in seconds.

  • volume: number = 0.5

    The starting volume.

  • type: OscillatorType = "sine"

    The oscillator type.

  Returns void

playWhiteNoiseBurst

• playWhiteNoiseBurst(
      duration?: number,
      volume?: number,
      centerFreq?: number,
      q?: number,
  ): void

  Plays a short one-shot burst of genuine white noise (impact "fuzz"/static crackle). See SynthSFX.playWhiteNoiseBurst.

  Parameters

  • duration: number = 0.15

    Seconds the burst plays for.

  • volume: number = 0.4

    Peak burst volume (0..1).

  • centerFreq: number = 1800

    Center of the band-pass shaping the fuzz character.

  • q: number = 1.0

    Band-pass resonance.

  Returns void

resume

• resume(): void

  Must be called after a user interaction to resume the audio context on some browsers.

  Returns void

setMasterVolume

• setMasterVolume(value: number): void

  Set the global master volume (0.0 to 1.0)

  Parameters

  • value: number

  Returns void

setMusicVolume

• setMusicVolume(value: number): void

  Set the Music volume (0.0 to 1.0)

  Parameters

  • value: number

  Returns void

setReverbLevel

• setReverbLevel(value: number): void

  Set the Reverb level (0.0 to 1.0)

  Parameters

  • value: number

  Returns void

setSFXVolume

• setSFXVolume(value: number): void

  Set the SFX volume (0.0 to 1.0)

  Parameters

  • value: number

  Returns void

startDrone

• startDrone(): SoundHandle

  Starts a creepy, pulsing low-frequency background drone. See SynthSFX.startDrone. The drone loops forever -- call .stop() on the returned handle to end it (also done automatically by dispose()).

  Returns SoundHandle

startFire

• startFire(position: Vector3D, volume?: number): SoundHandle

  Starts a procedural fire crackling noise at a specific 3D location. See SynthSFX.startFire. The noise loops forever -- call .stop() on the returned handle to end it (also done automatically by dispose()).

  Parameters

  • position: Vector3D
  • volume: number = 1.0

  Returns SoundHandle

updateListener

• updateListener(camera: CameraInterfaceData): void

  Updates the global listener position and orientation based on the camera.

  Parameters

  • camera: CameraInterfaceData

  Returns void