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.
AudioDecoder.configure()
Syntax
configure(config)
Parameters
-
config -
A dictionary object containing the following members:
-
codec- : A
stringcontaining a valid codec string.
- : A
-
sampleRate- : An integer representing the number of frame samples per second.
-
numberOfChannels- : An integer representing the number of audio channels.
-
descriptionOptional- A
BufferSourcecontaining a sequence of codec specific bytes, commonly known as extradata.
- A
-
Note: The registrations in the WebCodecs Codec Registry link to a specification detailing whether and how to populate the optional description member.
Return value
Exceptions
-
TypeErrorDOMException -
Thrown if the provided
configis invalid. -
InvalidStateErrorDOMException -
Thrown if the
stateis"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 });
Specifications
| Specification |
|---|
| WebCodecs # dom-audiodecoder-configure |
Browser compatibility
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
configure |
94
|
94
|
No
|
No
|
80
|
No
|
94
|
94
|
No
|
66
|
No
|
17.0
|
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/AudioDecoder/configure
