AudioWorkletNode.port

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The read-only port property of the AudioWorkletNode interface returns the associated MessagePort. It can be used to communicate between the node and its associated AudioWorkletProcessor.

Note: The port at the other end of the channel is available under the port property of the processor.

Syntax

audioWorkletNodeInstance.port;

Value

The MessagePort object that is connecting the AudioWorkletNode and its associated AudioWorkletProcessor.

Examples

To demonstrate bidirectional communication capabilities, we'll create an AudioWorkletProcessor, which will output silence and respond to ping requests from its AudioWorkletNode.

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

// ping-pong-processor.js
class PingPongProcessor extends AudioWorkletProcessor {
  constructor (...args) {
    super(...args)
    this.port.onmessage = (e) => {
      console.log(e.data)
      this.port.postMessage('pong')
    }
  }
  process (inputs, outputs, parameters) {
    return true
  }
}

registerProcessor('ping-pong-processor', PingPongProcessor)

Now in our main scripts file we'll load the processor, create an instance of AudioWorkletNode passing the name of the processor, and connect the node to an audio graph.

const audioContext = new AudioContext()
await audioContext.audioWorklet.addModule('ping-pong-processor.js')
const pingPongNode = new AudioWorkletNode(audioContext, 'ping-pong-processor')
// send the message containing 'ping' string
// to the AudioWorkletProcessor from the AudioWorkletNode every second
setInterval(() => pingPongNode.port.postMessage('ping'), 1000)
pingPongNode.port.onmessage = (e) => console.log(e.data)
pingPongNode.connect(audioContext.destination)

This will output "ping" and "pong" strings to the console every second.

Specifications

Specification Status Comment
Web Audio API
The definition of 'port' in that specification.
Working Draft

Browser compatibility

DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
portChrome Full support 66Edge Full support 79Firefox Full support 76IE No support NoOpera Full support YesSafari No support NoWebView Android Full support 66Chrome Android Full support 66Firefox Android No support NoOpera Android Full support YesSafari iOS No support NoSamsung Internet Android Full support 9.0

Legend

Full support
Full support
No support
No support

See also