ContextQMD
Back to Content

AudioEncoder: encode() method

files/en-us/web/api/audioencoder/encode/index.md

latest898 B
Original Source

{{securecontext_header}}{{APIRef("WebCodecs API")}}{{AvailableInWorkers("window_and_dedicated")}}

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

Syntax

js-nolint
encode(data)

Parameters

  • data
    • : An {{domxref("AudioData")}} object.

Return value

None ({{jsxref("undefined")}}).

Exceptions

  • InvalidStateError {{domxref("DOMException")}}
    • : Thrown if the {{domxref("AudioEncoder.state","state")}} is not "configured".
  • {{jsxref("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

{{Specifications}}

Browser compatibility

{{Compat}}