AudioWorkletGlobalScope.registerProcessor

The registerProcessor method of the AudioWorkletGlobalScope interface registers a class constructor derived from AudioWorkletProcessor interface under a specified name.

name

A string representing the name under which the processor will be registered.

processorCtor

The constructor of a class derived from AudioWorkletProcessor.

NotSupportedError DOMException

Thrown under the following conditions:

• The name is an empty string.
• A constructor under the given name is already registered. Registering the same name twice is not allowed.

TypeError DOMException

Thrown under the following conditions:

• The processorCtor is not a callable constructor.
• The parameterDescriptors property of the constructor exists and doesn't return an array of AudioParamDescriptor-based objects.

In this example we create a custom AudioWorkletNode that outputs silence.

First, we need to define a custom AudioWorkletProcessor and register it. Note that this should be done in a separate file.

// test-processor.js
class TestProcessor extends AudioWorkletProcessor {
  process (inputs, outputs, parameters) {
    return true
  }
}

registerProcessor('test-processor', TestProcessor)

Next, in our main script file we'll load the processor, create an instance of AudioWorkletNode — passing it the processor name that we used when calling registerProcessor — and connect it to an audio graph.

const audioContext = new AudioContext()
await audioContext.audioWorklet.addModule('test-processor.js')
const node = new AudioWorkletNode(audioContext, 'test-processor')
node.connect(audioContext.destination)

• Using the Web Audio API