Class SoundHandle

constructor

• new SoundHandle(
      ctx: AudioContext,
      clip: AudioClip,
      destination: AudioNode,
      opts?: VoiceOptions,
  ): SoundHandle

  Parameters

  • ctx: AudioContext
  • clip: AudioClip
  • destination: AudioNode
  • opts: VoiceOptions = {}

  Returns SoundHandle

onEnded

done

• get done(): boolean

  True once the voice has ended and can be pruned.

  Returns boolean

spatial

• get spatial(): boolean

  True if this voice is spatialized.

  Returns boolean

setVolume

• setVolume(volume: number, ramp?: number): void

  Set the per-voice volume, optionally ramping over ramp seconds.

  Parameters

  • volume: number
  • ramp: number = 0

  Returns void

setPlaybackRate

• setPlaybackRate(rate: number): void

  Parameters

  • rate: number

  Returns void

setDetune

• setDetune(cents: number): void

  Parameters

  • cents: number

  Returns void

setPosition

• setPosition(pos: Vec3Like): void

  Move the spatial source. No-op for non-spatial voices.

  Parameters

  • pos: Vec3Like

  Returns void

follow

• follow(target: PositionProvider | null): this

  Bind the spatial position to a moving object; the owning engine syncs it each frame. Pass null to unbind. No-op for non-spatial voices.

  Parameters

  • target: PositionProvider | null

  Returns this

syncFollow

• syncFollow(): void

  Called by the engine each frame to track a follow target.

  Returns void

stop

• stop(fade?: number): void

  Stop the voice, optionally fading out over fade seconds first.

  Parameters

  • fade: number = 0

  Returns void

fadeOut

• fadeOut(duration?: number): void

  Alias for stop(duration).

  Parameters

  • duration: number = 0.5

  Returns void

dispose

• dispose(): void

  Disconnect all nodes. Safe to call after the voice ends.

  Returns void