The VideoEncoder interface of the WebCodecs API encodes VideoFrame objects.
VideoEncoder
Constructor
-
VideoEncoder() -
Creates a new
VideoEncoderobject.
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 encoding.
Methods
-
VideoEncoder.configure() -
Enqueues a control message to configure the video encoder for encoding 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
|
66
|
No
|
17.0
|
VideoEncoder |
94
|
94
|
No
|
No
|
80
|
No
|
94
|
94
|
No
|
66
|
No
|
17.0
|
close |
94
|
94
|
No
|
No
|
80
|
No
|
94
|
94
|
No
|
66
|
No
|
17.0
|
configure |
94
|
94
|
No
|
No
|
80
|
No
|
94
|
94
|
No
|
66
|
No
|
17.0
|
encode |
94
|
94
|
No
|
No
|
80
|
No
|
94
|
94
|
No
|
66
|
No
|
17.0
|
encodeQueueSize |
94
|
94
|
No
|
No
|
80
|
No
|
94
|
94
|
No
|
66
|
No
|
17.0
|
flush |
94
|
94
|
No
|
No
|
80
|
No
|
94
|
94
|
No
|
66
|
No
|
17.0
|
isConfigSupported |
94
|
94
|
No
|
No
|
80
|
No
|
94
|
94
|
No
|
66
|
No
|
17.0
|
reset |
94
|
94
|
No
|
No
|
80
|
No
|
94
|
94
|
No
|
66
|
No
|
17.0
|
state |
94
|
94
|
No
|
No
|
80
|
No
|
94
|
94
|
No
|
66
|
No
|
17.0
|
See also
© 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
