kotlin-browser/web.codecs/AudioDecoder

AudioDecoder

open class AudioDecoder(init: AudioDecoderInit) : EventTarget(source)

The AudioDecoder interface of the WebCodecs API decodes chunks of audio. Available only in secure contexts.

MDN Reference

Constructors

AudioDecoder

constructor(init: AudioDecoderInit)

Types

Companion

object Companion

Properties

decodeQueueSize

external val decodeQueueSize: Int

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

ondequeue

external var ondequeue: EventHandler<Event, AudioDecoder, AudioDecoder>?

MDN Reference

state

external val state: CodecState

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

Functions

external fun close()

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

configure

external fun configure(config: AudioDecoderConfig)

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

decode

external fun decode(chunk: EncodedAudioChunk)

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

dispatchEvent

open external fun dispatchEvent(event: Event): Boolean

flush

inline suspend fun AudioDecoder.flush()

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

flushAsync

external fun flushAsync(): Promise<Void>

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

reset

external fun reset()

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

when

external fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>