MDN self-hosted library · e01.org

VideoEncoder

WebCodecs APIwindowanddedicated

no runnable cells web-api-interface upstream source

WebCodecs APIwindow_and_dedicated

The VideoEncoder interface of the encodes VideoFrame objects into EncodedVideoChunks.

Constructor

  • VideoEncoder()
  • : Creates a new VideoEncoder object.

Instance properties

Inherits properties from its parent, EventTarget.

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

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.

Events

  • dequeue
  • : Fires to signal a decrease in VideoEncoder.encodeQueueSize.

Specifications

Browser compatibility

See also

Video processing with WebCodecs