dom / latest / audioencoder / configure.html /

AudioEncoder.configure()

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

The configure() method of the AudioEncoder interface enqueues a control message to configure the audio encoder for encoding chunks.

Syntax

configure(config)

Parameters

config

A dictionary object containing the following members:

codec

A string containing a valid codec string.

sampleRate Optional

An integer representing the number of frame samples per second.

numberOfChannels Optional

An integer representing the number of audio channels.

bitrate Optional

An integer representing the bitrate.

Return value

None.

Exceptions

TypeError DOMException

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 creates a new AudioEncoder and configures it with some of the available options.

const init = {
  output: handleOutput,
  error: (e) => {
    console.log(e.message);
  }
};

let config = {
  codec: 'vp8',
  bitrate: 2_000_000, // 2 Mbps
};

let encoder = new AudioEncoder(init);
encoder.configure(config);

Specifications

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/AudioEncoder/configure