Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The configure() method of the AudioDecoder interface enqueues a control message to configure the audio decoder for decoding chunks.
js
configure(config)
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.
None (undefined).
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.
The following example configures the audioDecoder with the opus codec.
js
audioDecoder.configure({
codec: "opus",
sampleRate: 44100,
numberOfChannels: 2,
});
| Specification |
|---|
| WebCodecs # dom-audiodecoder-configure |
| 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–2023 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