Class AudioDecoder

Namespace

CSharpToJavaScript.APIs.JS

Assembly

CSharpToJavaScript.dll

The AudioDecoder interface of the 'WebCodecs API' decodes chunks of audio.

[Value("AudioDecoder")]
public class AudioDecoder : EventTarget

Inheritance

object

EventTarget

AudioDecoder

Inherited Members

EventTarget.AddEventListener(string, Action, Union26)

EventTarget.AddEventListener(string, Action<MouseEvent>, Union26)

EventTarget.AddEventListener(string, Action<Event>, Union26)

EventTarget.RemoveEventListener(string, Action, Union27)

EventTarget.AddEventListener(string, EventListener, Union26)

EventTarget.RemoveEventListener(string, EventListener, Union27)

EventTarget.DispatchEvent(Event)

EventTarget.When(string, ObservableEventListenerOptions)

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

AudioDecoder()

public AudioDecoder()

AudioDecoder(AudioDecoderInit)

The AudioDecoder() constructor creates a new AudioDecoder object with the provided init.output callback assigned as the output callback, the provided init.error callback as the error callback, and the State set to "unconfigured".

public AudioDecoder(AudioDecoderInit init)

Parameters

init AudioDecoderInit

Remarks

See also on MDN

Properties

DecodeQueueSize

The decodeQueueSize read-only property of the AudioDecoder interface returns the number of pending decode requests in the queue.

[Value("decodeQueueSize")]
public ulong DecodeQueueSize { get; }

Property Value

ulong

An integer containing the number of requests.

Remarks

See also on MDN

Ondequeue

[Value("ondequeue")]
public EventHandlerNonNull Ondequeue { get; set; }

Property Value

EventHandlerNonNull

State

The state read-only property of the AudioDecoder interface returns the current state of the underlying codec.

[Value("state")]
public CodecState State { get; }

Property Value

CodecState

A string containing one of the following values:

Remarks

See also on MDN

Methods

Close()

The close() method of the AudioDecoder 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

Configure(AudioDecoderConfig)

The configure() method of the AudioDecoder interface enqueues a control message to configure the audio decoder for decoding chunks.

[Value("configure")]
public GlobalObject.Undefined Configure(AudioDecoderConfig config)

Parameters

config AudioDecoderConfig

Returns

GlobalObject.Undefined

None (GlobalObject.Undefined).

Remarks

See also on MDN

Decode(EncodedAudioChunk)

The decode() method of the AudioDecoder interface enqueues a control message to decode a given chunk of audio.

[Value("decode")]
public GlobalObject.Undefined Decode(EncodedAudioChunk chunk)

Parameters

chunk EncodedAudioChunk

Returns

GlobalObject.Undefined

None (GlobalObject.Undefined).

Remarks

See also on MDN

Flush()

The flush() method of the AudioDecoder interface returns a Promise that resolves once all pending messages in the queue have been completed.

[Value("flush")]
public Task<GlobalObject.Undefined> Flush()

Returns

Task<GlobalObject.Undefined>

A Promise that resolves with undefined.

Remarks

See also on MDN

IsConfigSupported(AudioDecoderConfig)

The isConfigSupported() static method of the AudioDecoder interface checks if the given config is supported (that is, if AudioDecoder objects can be successfully configured with the given config).

[Value("isConfigSupported")]
public static Task<AudioDecoderSupport> IsConfigSupported(AudioDecoderConfig config)

Parameters

config AudioDecoderConfig

Returns

Task<AudioDecoderSupport>

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

Remarks

See also on MDN

Reset()

The reset() method of the AudioDecoder interface resets all states including configuration, control messages in the control message queue, and all pending callbacks.

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

Returns

GlobalObject.Undefined

None (GlobalObject.Undefined).

Remarks

See also on MDN