ImageDecoder.decode()

The decode() method of the ImageDecoder interface enqueues a control message to decode the frame of an image.

options Optional

An object containing the following members:

frameIndex Optional

An integer representing the index of the frame to decode. Defaults to 0 (the first frame).

completeFramesOnly Optional

A boolean defaulting to true. When false indicates that for progressive images the decoder may output an image with reduced detail.

A promise that resolves with an object containing the following members:

image

A VideoFrame containing the decoded image.

complete

A boolean, if true indicates that image contains the final full-detail output.

If an error occurs, the promise will resolve with following exception:

InvalidStateError DOMException

Returned if any of the following conditions apply:

• close is true, meaning close() has already been called.
• The requested frame does not exist.

The following example decodes the second frame (at index 1) and prints the resulting VideoFrame to the console.

console.log(imageDecoder.decode({frameIndex: 1}));