AudioDecoder: configure() 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 configure() method of the AudioDecoder interface enqueues a control message to configure the audio decoder for decoding chunks.

Syntax

js
configure(config)

Parameters

config

A dictionary object containing the following members:

codec

A string containing a valid codec string. See "codecs" parameter for details on codec string construction.

sampleRate

An integer representing the number of frame samples per second.

numberOfChannels

An integer representing the number of audio channels.

description Optional

An ArrayBuffer, a TypedArray, or a DataView containing a sequence of codec specific bytes, commonly known as extradata.

Note: The registrations in the WebCodecs Codec Registry link to a specification detailing whether and how to populate the optional description member.

Return value

None (undefined).

Exceptions

TypeError

Thrown if the provided config is invalid.

InvalidStateError DOMException

Thrown if the state is "closed".

NotSupportedError DOMException

Thrown if the provided config is valid but the user agent cannot provide a codec that can decode this profile.

Examples

The following example configures the audioDecoder with the opus codec.

js
audioDecoder.configure({
  codec: "opus",
  sampleRate: 44100,
  numberOfChannels: 2,
});

Specifications

Specification
WebCodecs
# dom-audiodecoder-configure

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
configure

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support