ImageDecoder: ImageDecoder() constructor
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 insecure contexts (HTTPS), in some or allsupporting browsers.
Note: This feature is available inDedicated Web Workers.
TheImageDecoder() constructor creates a newImageDecoder object which unpacks and decodes image data.
In this article
Syntax
new ImageDecoder(init)Parameters
initAn object containing the following members:
typeA string containing theMIME type of the image file to be decoded.
dataAn
ArrayBuffer, aTypedArray, aDataView, or aReadableStreamof bytes representing an encoded image type as described bytype.premultiplyAlphaOptionalSpecifies whether the decoded image's color channels should be premultiplied by the alpha channel. If not provided set as
"default":"none""premultiply""default"
colorSpaceConversionOptionalSpecifies whether the image should be decoded using color space conversion. If not provided set as
"default". The value"default"indicates that implementation-specific behavior is used:"none""default"
desiredWidthOptionalAn integer indicating the desired width for the decoded output. Has no effect unless the image codec supports variable resolution decoding.
desiredHeightOptionalAn integer indicating the desired height for the decoded output. Has no effect unless the image codec supports variable resolution decoding.
preferAnimationOptionalA
Booleanindicating whether the initial track selection should prefer an animated track.transferAn array of
ArrayBuffers thatImageDecoderwill detach and take ownership of. If the array contains theArrayBufferbackingdata,ImageDecoderwill use that buffer directly instead of copying from it.
Examples
The following example creates a newImageDecoder with the required options.
let init = { type: "image/png", data: imageByteStream,};let imageDecoder = new ImageDecoder(init);Specifications
| Specification |
|---|
| WebCodecs> # dom-imagedecoder-imagedecoder> |