The VideoEncoder
interface of the WebCodecs API encodes VideoFrame
objects into EncodedVideoChunk
s.
On this page
VideoEncoder
Constructor
-
VideoEncoder()
-
Creates a new
VideoEncoder
object.
Instance properties
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.
Events
-
dequeue
-
Fires to signal a decrease in
VideoEncoder.encodeQueueSize
.
Static methods
-
VideoEncoder.isConfigSupported()
-
Returns a promise indicating whether the provided
VideoEncoderConfig
is supported.
Instance methods
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.
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 | 16.4 | 94 | 94 | No | 66 | 16.4 | 17.0 |
VideoEncoder |
94 | 94 | No | No | 80 | 16.4 | 94 | 94 | No | 66 | 16.4 | 17.0 |
close |
94 | 94 | No | No | 80 | 16.4 | 94 | 94 | No | 66 | 16.4 | 17.0 |
configure |
94 | 94 | No | No | 80 | 16.4 | 94 | 94 | No | 66 | 16.4 | 17.0 |
dequeue_event |
106 | 106 | No | No | 92 | 16.4 | 106 | 106 | No | 72 | 16.4 | 20.0 |
encode |
94 | 94 | No | No | 80 | 16.4 | 94 | 94 | No | 66 | 16.4 | 17.0 |
encodeQueueSize |
94 | 94 | No | No | 80 | 16.4 | 94 | 94 | No | 66 | 16.4 | 17.0 |
flush |
94 | 94 | No | No | 80 | 16.4 | 94 | 94 | No | 66 | 16.4 | 17.0 |
isConfigSupported_static |
94 | 94 | No | No | 80 | 16.4 | 94 | 94 | No | 66 | 16.4 | 17.0 |
reset |
94 | 94 | No | No | 80 | 16.4 | 94 | 94 | No | 66 | 16.4 | 17.0 |
state |
94 | 94 | No | No | 80 | 16.4 | 94 | 94 | No | 66 | 16.4 | 17.0 |
See also
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/VideoEncoder