VideoDecoder: decode() method

{{APIRef("WebCodecs API")}}{{SecureContext_Header}}{{AvailableInWorkers("window_and_dedicated")}}

The decode() method of the {{domxref("VideoDecoder")}} interface enqueues a control message to decode a given chunk of video.

Syntax

decode(chunk)

Parameters

• chunk
  • : An {{domxref("EncodedVideoChunk")}} object representing a chunk of encoded video.

Return value

None ({{jsxref("undefined")}}).

Exceptions

• InvalidStateError {{domxref("DOMException")}}
  • : Thrown if the {{domxref("VideoDecoder.state","state")}} is not configured.
• DataError {{domxref("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 {{domxref("EncodedVideoChunk")}} objects created from encoded video data.

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

{{Specifications}}

Browser compatibility

{{Compat}}