AudioDecoder: configure() method
WebCodecs APIwindowanddedicated
WebCodecs APIwindow_and_dedicated
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. 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- : 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
descriptionmember.
Return value
None (undefined).
Exceptions
- TypeError
- : Thrown if the provided
configis invalid. InvalidStateErrorDOMException- : Thrown if the state is
"closed". NotSupportedErrorDOMException- : Thrown if the provided
configis 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,
});