W3cubDocs

/Web APIs

VideoEncoder

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Note: This feature is available in Dedicated Web Workers.

The VideoEncoder interface of the WebCodecs API encodes VideoFrame objects into EncodedVideoChunks.

Inherits properties from its parent, EventTarget.

VideoEncoder.encodeQueueSize Read only: An integer representing the number of encode queue requests.
VideoEncoder.state Read only: Represents the state of the underlying codec and whether it is configured for encoding.

VideoEncoder.isConfigSupported(): Returns a promise indicating whether the provided VideoEncoderConfig is supported.

Inherits methods from its parent, EventTarget.

VideoEncoder.configure(): Asynchronously prepares the encoder to accept video frames for encoding with the specified parameters.
VideoEncoder.encode(): Asynchronously encodes a VideoFrame.
VideoEncoder.flush(): Returns a promise that resolves once all pending encodes have been completed.
VideoEncoder.reset(): Cancels all pending encodes and callbacks.
VideoEncoder.close(): Ends all pending work and releases system resources.

Specification
WebCodecs> # videoencoder-interface>