OfflineAudioContext: complete event

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since April 2021.

The complete event of the OfflineAudioContext interface is fired when the rendering of an offline audio context is complete.

This event is not cancelable and does not bubble.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

js
addEventListener("complete", (event) => {});

oncomplete = (event) => {};

Event type

An OfflineAudioCompletionEvent. Inherits from Event.

Event OfflineAudioCompletionEvent

Event properties

Also inherits properties from its parent, Event.

OfflineAudioCompletionEvent.renderedBuffer Read only

An AudioBuffer containing the result of processing an OfflineAudioContext.

Examples

When processing is complete, you might want to use the complete event handler to prompt the user that the audio can now be played, and enable the play button:

js
const offlineAudioCtx = new OfflineAudioContext();

offlineAudioCtx.addEventListener("complete", () => {
  console.log("Offline audio processing now complete");
  showModalDialog("Song processed and ready to play");
  playBtn.disabled = false;
});

You can also set up the event handler using the oncomplete property:

js
const offlineAudioCtx = new OfflineAudioContext();

offlineAudioCtx.oncomplete = () => {
  console.log("Offline audio processing now complete");
  showModalDialog("Song processed and ready to play");
  playBtn.disabled = false;
};

Specifications

Specification
Web Audio API
# OfflineAudioCompletionEvent
Web Audio API
# dom-offlineaudiocontext-oncomplete

Browser compatibility

BCD tables only load in the browser

See also