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

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.

bitrate Optional

An integer representing the bitrate.

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 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: "opus",
  sampleRate: 44100,
  numberOfChannels: 2,
  bitrate: 128_000, // 128 kbps
};

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