Class AudioTimeout

A framework for scheduled audio events with more precise and synchronized timing than using window.setTimeout. This approach creates an empty audio buffer of the desired duration played using the shared game audio context. The onended event of the AudioBufferSourceNode provides a very precise way to synchronize audio events. For audio timing, this is preferable because it avoids numerous issues with window.setTimeout.

Example: Using a callback function

function playForDuration(sound, duration) {
  sound.play();
  const wait = new AudioTimeout(duration, {callback: () => sound.stop()})
}

Example: Using an awaited Promise

async function playForDuration(sound, duration) {
  sound.play();
  const timeout = new AudioTimeout(delay);
  await timeout.complete;
  sound.stop();
}

Example: Using the wait helper

async function playForDuration(sound, duration) {
  sound.play();
  await AudioTimeout.wait(duration);
  sound.stop();
}

Constructors

constructor

Properties

complete

Accessors

cancelled

Methods

cancel end wait

Constructors

constructor

  • new AudioTimeout(delayMS: number, options?: AudioTimeoutOptions): AudioTimeout

    Create an AudioTimeout by providing a delay and callback.

    Parameters

    • delayMS: number

      A desired delay timing in milliseconds

    • Optionaloptions: AudioTimeoutOptions = {}

      Additional options which modify timeout behavior

    Returns AudioTimeout

Properties

complete

complete: Promise<any>

Is the timeout complete? This can be used to await the completion of the AudioTimeout if necessary. The Promise resolves to the returned value of the provided callback function.

Accessors

cancelled

  • get cancelled(): boolean

    Is this audio timeout cancelled?

    Returns boolean

Methods

cancel

  • cancel(): void

    Cancel an AudioTimeout by ending it early, rejecting its completion promise, and skipping any callback function.

    Returns void

end

  • end(): void

    End the timeout, either on schedule or prematurely. Executing any callback function

    Returns void

Staticwait

  • wait(delayMS: number, options?: AudioTimeoutOptions): Promise<any>

    Schedule a task according to some audio timeout.

    Parameters

    • delayMS: number

      A desired delay timing in milliseconds

    • Optionaloptions: AudioTimeoutOptions

      Additional options which modify timeout behavior

    Returns Promise<any>

    A promise which resolves as a returned value of the callback or void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods