VideoDecoder

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

MDN Reference

Constructors

Link copied to clipboard
constructor(init: VideoDecoderInit)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

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

Functions

Link copied to clipboard
fun close()

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
suspend fun flush()

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

Link copied to clipboard
Link copied to clipboard
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.

Link copied to clipboard