AudioEncoder: encode() method

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

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

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