AudioEncoder: encode() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Note: This feature is available in Dedicated Web Workers.

The encode() method of the AudioEncoder interface enqueues a control message to encode a given AudioData object.

Syntax

js
encode(data)

Parameters

data

An AudioData object.

Return value

None (undefined).

Exceptions

InvalidStateError DOMException

Thrown if the state is not "configured".

TypeError

Thrown if the AudioData object has been transferred.

Examples

In the following example encode is passed an AudioData object.

js
encoder.encode(data);

Specifications

Specification
WebCodecs
# dom-audioencoder-encode

Browser compatibility

BCD tables only load in the browser