The encode() method of the VideoEncoder interface enqueues a control message to encode a given VideoFrame.

frame

A VideoFrame object.

optionsOptional

An object containing the following member:

keyFrame

A boolean, defaulting to false giving the user agent flexibility to decide if this frame should be encoded as a key frame. If true this indicates that the given frame must be encoded as a key frame.

Undefined.

InvalidStateError DOMException

Thrown if the state is not "configured".

DataError DOMException

Thrown if the chunk cannot be decoded due to relying on other frames for decoding.

In the following example encode is passed a VideoFrame, and the options parameter indicating that this frame should be considered a keyframe.

encoder.encode(frame, { keyFrame: true });