VideoDecoder: VideoDecoder() constructor

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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

The VideoDecoder() constructor creates a new VideoDecoder object with the provided init.output callback assigned as the output callback, the provided init.error callback as the error callback, and the VideoDecoder.state set to "unconfigured".

Syntax

js
new VideoDecoder(options)

Parameters

options

An object containing two callbacks.

output

A callback which takes a VideoFrame object as its only argument.

error

A callback which takes an Error object as its only argument.

Examples

In the following example a VideoDecoder is created with the two required callback functions, one to deal with the decoded frame and the other to handle errors.

js
const videoDecoder = new VideoDecoder({
  output: processVideo,
  error: onEncoderError,
});

Specifications

Specification
WebCodecs
# dom-videodecoder-videodecoder

Browser compatibility

BCD tables only load in the browser