ImageDecoder.ImageDecoder()

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The ImageDecoder() constructor creates a new ImageDecoder object which unpacks and decodes image data.

Syntax

new ImageDecoder(init);

Parameters

init

An object containing the following members:

type

A string containing the MIME type of the image file to be decoded.

data

A BufferSource or ReadableStream of bytes representing an encoded image type as described by type.

premultiplyAlphaOptional

One of the following, if not provided set as "default":

  • "none"
  • "premultiply"
  • "default"
colorSpaceConversionOptional

One of the following, if not provided set as "default":

  • "none"
  • "default"
desiredWidthOptional

An integer indicating the desired width for the decoded output.

desiredHeightOptional

An integer indicating the desired height for the decoded output.

preferAnimationOptional

A Boolean indicating whether the the initial track selection should prefer an animated track.

Examples

The following example creates a new ImageDecoder with the required options.

let init = {
  type: "image/png",
  data: imageByteStream
};

let imageDecoder = new ImageDecoder(init);

Specifications

Specification
WebCodecs
# dom-imagedecoder-imagedecoder

Browser compatibility

BCD tables only load in the browser