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 insecure contexts (HTTPS), in some or allsupporting browsers.
Note: This feature is available inDedicated Web Workers.
TheVideoEncoder interface of theWebCodecs API encodesVideoFrame objects intoEncodedVideoChunks.
Constructor
VideoEncoder()Creates a new
VideoEncoderobject.
Instance properties
Inherits properties from its parent,EventTarget.
VideoEncoder.encodeQueueSizeRead onlyAn integer representing the number of encode queue requests.
VideoEncoder.stateRead onlyRepresents the state of the underlying codec and whether it is configured for encoding.
Events
dequeueFires to signal a decrease in
VideoEncoder.encodeQueueSize.
Static methods
VideoEncoder.isConfigSupported()Returns a promise indicating whether the provided
VideoEncoderConfigis 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 |