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.

Note: This feature is available in Dedicated Web Workers.

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

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

Enable JavaScript to view this browser compatibility table.

Help improve MDN

Was this page helpful to you?

Yes No

Learn how to contribute

This page was last modified on May 8, 2024 by MDN contributors.

View this page on GitHub • Report a problem with this content

WebCodecs API
VideoDecoder
Constructor
1. VideoDecoder()
Instance properties
1. decodeQueueSize
2. state
Static methods
1. isConfigSupported()
Instance methods
Events
1. dequeue
Inheritance
1. EventTarget
Related pages for WebCodecs API
Guides