AudioDecoder.configure()

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

The configure() method of the AudioDecoder interface enqueues a control message to configure the audio decoder for decoding chunks.

Syntax

configure(config)

Parameters

config

A dictionary object containing the following members:

codec

A string containing a valid codec string.

sampleRate

An integer representing the number of frame samples per second.

numberOfChannels

An integer representing the number of audio channels.

descriptionOptional

Aa 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.

AudioDecoder.configure({ codec: 'opus', sampleRate: 44100, numberOfChannels: 2 });

Specifications

Specification
WebCodecs
# dom-audiodecoder-configure

Browser compatibility

BCD tables only load in the browser