ContextQMD
Back to Content

AudioWorklet

files/en-us/web/api/audioworklet/index.md

latest1.8 KB
Original Source

{{APIRef("Web Audio API")}}{{securecontext_header}}

The AudioWorklet interface of the Web Audio API is used to supply custom audio processing scripts that execute in a separate thread to provide very low latency audio processing.

The worklet's code is run in the {{domxref("AudioWorkletGlobalScope")}} global execution context, using a separate Web Audio thread which is shared by the worklet and other audio nodes.

Access the audio context's instance of AudioWorklet through the {{domxref("BaseAudioContext.audioWorklet")}} property.

{{InheritanceDiagram}}

Instance properties

This interface also inherits properties defined on its parent interface, {{domxref("Worklet")}}.

  • {{domxref("AudioWorklet.port", "port")}} {{ReadOnlyInline}} {{experimental_inline}}
    • : Returns a {{domxref("MessagePort")}} for custom, asynchronous communication between code in the main thread and the global scope of an audio worklet. This allows for custom messages, such as sending and receiving control data or global settings.

Instance methods

This interface inherits methods from {{domxref('Worklet')}}. The AudioWorklet interface does not define any methods of its own.

Events

AudioWorklet has no events to which it responds.

Examples

See {{domxref("AudioWorkletNode")}} for complete examples of custom audio node creation.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also