大网数据广告活动
Web 标准与前端开发

ImageDecoder: decode() method

· 52CE 我爱测

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

WebCodecs APIwindow_and_dedicated

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

Syntax

decode()
decode(options)

Parameters

  • options
    • : An object containing the following members:
      • frameIndex
        • : An integer representing the index of the frame to decode. Defaults to 0 (the first frame).
      • completeFramesOnly
        • : A Boolean defaulting to true. When true, the Promise returned by the method resolves only when the image is fully decoded. When false, the method will return a new Promise that may resolve with a partially decoded image. The method can be called repeatedly until result.complete is true, with each step providing an image with the next available level of detail.

Return value

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.

Exceptions

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 ImageDecoder.close() has already been called.
      • The requested frame does not exist.

Examples

Synchronous decoding of a completed image frame

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

let result = await imageDecoder.decode({ frameIndex: 1 });
console.log(result.image);

Partial decoding of a progressive image frame

The following example decodes the first frame repeatedly until it's complete:

let complete = false;
while (!complete) {
  // The promise returned by `decode()` will only resolve when a new
  // level of detail is available or the frame is complete. I.e.,
  // calling `decode()` in a loop like this won't needlessly spin.
  let result = await imageDecoder.decode({ completeFramesOnly: false });

  // Do something with `result.image`.

  complete = result.complete;
}

Specifications

Browser compatibility

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。