WebCodecs APIwindow_and_dedicated
The encode() method of the VideoEncoder interface asynchronously encodes a VideoFrame.
Encoded data (EncodedVideoChunk) or an error will eventually be returned via the callbacks provided to the VideoEncoder constructor.
Syntax
encode(frame)
encode(frame, options)
Parameters
frame- : A VideoFrame object.
options- : An object containing the following members:
keyFrame- : A Boolean, defaulting to
falsegiving the user agent flexibility to decide if this frame should be encoded as a key frame. Iftruethis indicates that the given frame must be encoded as a key frame.
- : A Boolean, defaulting to
vp9- : Encode options for the VP9 codec.
quantizer- : Frame quantizer value 0 to 63. Only effective if VideoEncoder was configured with
quantizerbitrate mode.
- : Frame quantizer value 0 to 63. Only effective if VideoEncoder was configured with
- : Encode options for the VP9 codec.
av1- : Encode options for the AV1 codec.
quantizer- : Frame quantizer value 0 to 63. Only effective if VideoEncoder was configured with
quantizerbitrate mode.
- : Frame quantizer value 0 to 63. Only effective if VideoEncoder was configured with
- : Encode options for the AV1 codec.
avc- : Encode options for the AVC (H.264) codec.
quantizer- : Frame quantizer value 0 to 51. Only effective if VideoEncoder was configured with
quantizerbitrate mode.
- : Frame quantizer value 0 to 51. Only effective if VideoEncoder was configured with
- : Encode options for the AVC (H.264) codec.
hevc- : Encode options for the HEVC (H.265) codec.
quantizer- : Frame quantizer value 0 to 51. Only effective if VideoEncoder was configured with
quantizerbitrate mode.
- : Frame quantizer value 0 to 51. Only effective if VideoEncoder was configured with
- : Encode options for the HEVC (H.265) codec.
- : An object containing the following members:
Return value
None (undefined).
Exceptions
InvalidStateErrorDOMException- : Thrown if the VideoEncoder.state is not
"configured".
- : Thrown if the VideoEncoder.state is not
DataErrorDOMException- : Thrown if the given
frameobject's rotation and flip do not match the rotation and flip of the first VideoFrame passed toencode()(the "active orientation").
- : Thrown if the given
Examples
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 });
Setting per-frame QP value for encoding individual frames.
const encoder = new VideoEncoder(init);
const encoderConfig = {
codec: "vp09.00.10.08",
width: 800,
height: 600,
bitrateMode: "quantizer",
framerate: 30,
latencyMode: "realtime",
};
encoder.configure(encoderConfig);
const encodeOptions = { keyFrame: false };
const qp = calculateQp(codec, frame);
if (codec.includes("vp09")) {
encodeOptions.vp9 = { quantizer: qp };
} else if (codec.includes("av01")) {
encodeOptions.av1 = { quantizer: qp };
} else if (codec.includes("avc")) {
encodeOptions.avc = { quantizer: qp };
} else if (codec.includes("hvc1") || codec.includes("hev1")) {
encodeOptions.hevc = { quantizer: qp };
}
encoder.encode(frame, encodeOptions);
Specifications
Browser compatibility
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
