kotlin-browser/web.codecs/VideoDecoder

VideoDecoder

open class VideoDecoder(init: VideoDecoderInit) : EventTarget, JsCloseable(source)

The VideoDecoder interface of the WebCodecs API decodes chunks of video. Available only in secure contexts.

MDN Reference

Constructors

VideoDecoder

constructor(init: VideoDecoderInit)

Types

Companion

object Companion

Properties

decodeQueueSize

external val decodeQueueSize: Int

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

ondequeue

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

MDN Reference

state

external val state: CodecState

The state property of the VideoDecoder interface returns the current state of the underlying codec.

Functions

open external override fun close()

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

configure

external fun configure(config: VideoDecoderConfig)

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

decode

external fun decode(chunk: EncodedVideoChunk)

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

dispatchEvent

open external fun dispatchEvent(event: Event): Boolean

flush

inline suspend fun VideoDecoder.flush()

The flush() method of the VideoDecoder 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 VideoDecoder 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 VideoDecoder 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>