VideoDecoder: decode() method

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 decode() method of the VideoDecoder interface enqueues a control message to decode a given chunk of video.

Syntax

js
decode(chunk)

Parameters

chunk

An EncodedVideoChunk object representing a chunk of encoded video.

Return value

None (undefined).

Exceptions

InvalidStateError DOMException

Thrown if the state is not configured.

DataError DOMException

Thrown if the chunk is unable to be decoded due to relying on other frames for decoding.

Examples

The following example demonstrates how to use the decode() method to decode EncodedVideoChunk objects created from encoded video data.

js
const responses = await downloadVideoChunksFromServer(timestamp);
for (const response of responses) {
  const chunk = new EncodedVideoChunk({
    timestamp: response.timestamp,
    type: response.key ? "key" : "delta",
    data: new Uint8Array(response.body),
  });
  decoder.decode(chunk);
}

Specifications

Specification
WebCodecs
# dom-videodecoder-decode

Browser compatibility

BCD tables only load in the browser