VideoEncoder

The VideoEncoder interface of the WebCodecs API decodes VideoFrame objects.

Constructor

VideoEncoder.VideoEncoder()

Creates a new VideoEncoder object.

Properties

VideoEncoder.encodeQueueSizeRead only

An integer representing the number of encode queue requests.

VideoEncoder.stateRead only

Represents the state of the underlying codec and whether it is configured for decoding.

Methods

VideoEncoder.configure()

Enqueues a control message to configure the video decoder for decoding chunks.

VideoEncoder.encode()

Enqueues a control message to encode a given VideoFrame.

VideoEncoder.flush()

Returns a promise that resolves once all pending messages in the queue have been completed.

VideoEncoder.reset()

Resets all states including configuration, control messages in the control message queue, and all pending callbacks.

VideoEncoder.close()

Ends all pending work and releases system resources.

Specifications

Specification
WebCodecs
# videoencoder-interface

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
VideoEncoder
94
94
No
No
80
No
94
94
No
No
No
No
VideoEncoder
94
94
No
No
80
No
94
94
No
No
No
No
close
94
94
No
No
80
No
94
94
No
No
No
No
configure
94
94
No
No
80
No
94
94
No
No
No
No
encode
94
94
No
No
80
No
94
94
No
No
No
No
encodeQueueSize
94
94
No
No
80
No
94
94
No
No
No
No
reset
94
94
No
No
80
No
94
94
No
No
No
No
state
94
94
No
No
80
No
94
94
No
No
No
No

See also

Video processing with WebCodecs

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/VideoEncoder