ImageDecoder: decode() method
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{securecontext_header}}{{APIRef("WebCodecs API")}}{{AvailableInWorkers("window_and_dedicated")}}
The **decode()** method of the {{domxref("ImageDecoder")}} interface enqueues a control message to decode the frame of an image.
Syntax
decode()
decode(options)Parameters
options{{optional_inline}}- : An object containing the following members:
frameIndex{{optional_inline}}- : An integer representing the index of the frame to decode. Defaults to
0(the first frame). completeFramesOnly{{optional_inline}}- : A {{jsxref("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 {{jsxref("Promise")}} that resolves with an object containing the following members:
image- : A {{domxref("VideoFrame")}} containing the decoded image.
complete- : A {{jsxref("Boolean")}}, if
trueindicates thatimagecontains the final full-detail output.
Exceptions
If an error occurs, the promise will resolve with following exception:
InvalidStateError{{domxref("DOMException")}}- : Returned if any of the following conditions apply:
closeis true, meaning {{domxref("ImageDecoder.close()","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 {{domxref("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
{{Specifications}}
Browser compatibility
{{Compat}}