Class ImageDecoder

Namespace

CSharpToJavaScript.APIs.JS

Assembly

CSharpToJavaScript.dll

The ImageDecoder interface of the 'WebCodecs API' provides a way to unpack and decode encoded image data.

[Value("ImageDecoder")]
public class ImageDecoder

Inheritance

object

ImageDecoder

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

See also on MDN

Constructors

ImageDecoder()

public ImageDecoder()

ImageDecoder(ImageDecoderInit)

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

public ImageDecoder(ImageDecoderInit init)

Parameters

init ImageDecoderInit

Remarks

See also on MDN

Properties

Complete

The complete read-only property of the ImageDecoder interface returns true if encoded data has completed buffering.

[Value("complete")]
public bool Complete { get; }

Property Value

bool

A Boolean, true if buffering is complete.

Remarks

See also on MDN

Completed

The completed read-only property of the ImageDecoder interface returns a promise that resolves once encoded data has finished buffering.

[Value("completed")]
public Task<GlobalObject.Undefined> Completed { get; }

Property Value

Task<GlobalObject.Undefined>

A {{jsxref("Promise")}} that resolves with {{jsxref("undefined")}} once Complete is true.

Remarks

See also on MDN

Tracks

The tracks read-only property of the ImageDecoder interface returns a list of the tracks in the encoded image data.

[Value("tracks")]
public ImageTrackList Tracks { get; }

Property Value

ImageTrackList

An ImageTrackList.

Remarks

See also on MDN

Type

The type read-only property of the ImageDecoder interface reflects the MIME type configured during construction.

[Value("type")]
public string Type { get; }

Property Value

string

A string containing the configured MIME type.

Remarks

See also on MDN

Methods

Close()

The close() method of the ImageDecoder interface ends all pending work and releases system resources.

[Value("close")]
public GlobalObject.Undefined Close()

Returns

GlobalObject.Undefined

None (GlobalObject.Undefined).

Remarks

See also on MDN

Decode(ImageDecodeOptions)

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

[Value("decode")]
public Task<ImageDecodeResult> Decode(ImageDecodeOptions options = null)

Parameters

options ImageDecodeOptions

Returns

Task<ImageDecodeResult>

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

Remarks

See also on MDN

IsTypeSupported(string)

The ImageDecoder.isTypeSupported() static method checks if a given MIME type can be decoded by the user agent.

[Value("isTypeSupported")]
public static Task<bool> IsTypeSupported(string type)

Parameters

type string

Returns

Task<bool>

A Promise that resolves with a boolean value indicating whether images with a format of type can be decoded by the API.

Remarks

See also on MDN

Reset()

The reset() method of the ImageDecoder interface aborts all pending decode() operations; rejecting all pending promises. All other state will be unchanged. Class methods can continue to be invoked after reset(). E.g., calling decode() after reset() is permitted.

[Value("reset")]
public GlobalObject.Undefined Reset()

Returns

GlobalObject.Undefined

None (GlobalObject.Undefined).

Remarks

See also on MDN