VideoDecoder.configure()

The configure() method of the VideoDecoder interface enqueues a control message to configure the video decoder for decoding chunks.

config

An object containing the following members:

codec

A string containing a valid codec string.

descriptionOptional

A BufferSource containing a sequence of codec specific bytes, commonly known as extradata.

codedWidthOptional

An integer representing the width of the VideoFrame in pixels, including any non-visible padding, before any ratio adjustments.

codedHeightOptional

An integer representing the height of the VideoFrame in pixels, including any non-visible padding, before any ratio adjustments.

displayAspectWidthOptional

An integer representing the horizontal dimension of the VideoFrame in pixels when displayed.

displayAspectHeightOptional

An integer representing the vertical dimension of the VideoFrame in pixels when displayed.

colorSpace

An object. representing a VideoColorSpace, containing the following members:

primaries

A string representing the color gamut of the video sample. One of:

• "bt709"
• "bt470bg"
• "smpte170m"

transfer

A string representing transfer characteristics. One of:

• "bt709"
• "smpte170m"
• "iec61966-2-1"

matrix

A string representing a matrix coefficient. One of:

• "rgb"
• "bt709"
• "bt470bg"
• "smpte170m"

hardwareAcceleration

A hint as to the hardware acceleration method to use. One of:

• "no-preference"
• "prefer-hardware"
• "prefer-software"

optimizeForLatency

A boolean. If truethis is a hint that the selected decoder should be optimized to minimize the number of EncodedVideoChunk objects that have to be decoded before a VideoFrame is output.

None.

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.

The following example creates a new VideoDecoder and configures it with the "vp8" codec, a codedWidth of 640 pixels and a codedHeight of 480 pixels.

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

const config = {
  codec: 'vp8',
  codedWidth: 640,
  codedHeight: 480
};

let decoder = new VideoDecoder(init);
decoder.configure(config);