Web Codecs APIwindow_and_dedicated
The VideoFrame() constructor creates a new VideoFrame object representing a frame of a video.
Syntax
new VideoFrame(image)
new VideoFrame(image, options)
new VideoFrame(data, options)
Parameters
The first type of constructor creates a new VideoFrame from an image. Its parameters are:
image- : An image containing the image data for the new
VideoFrame. It can be one of the following objects: an SVGImageElement, an HTMLVideoElement, an HTMLCanvasElement, an ImageBitmap, an OffscreenCanvas, or another VideoFrame.
- : An image containing the image data for the new
options- : An object containing the following:
-
alpha- : A string, describing how the user agent should behave when dealing with alpha channels. The default value is "keep".
"keep": Indicates that the user agent should preserve alpha channel data."discard": Indicates that the user agent should ignore or remove alpha channel data.
- : A string, describing how the user agent should behave when dealing with alpha channels. The default value is "keep".
-
displayHeight- : The height of the
VideoFramewhen displayed after applying aspect-ratio adjustments.
- : The height of the
-
displayWidth- : The width of the
VideoFramewhen displayed after applying aspect-ratio adjustments.
- : The width of the
-
duration- : An integer representing the duration of the frame in microseconds.
-
flip- : A boolean. If
true, horizontal mirroring is applied. Defaults tofalse.
- : A boolean. If
-
metadata-
: An object containing metadata describing the video frame, specified by the WebCodecs VideoFrame Metadata Registry, which can contain the following properties:
rtpTimestamp- : The RTP timestamp of the corresponding encoded frame. Only video frames originating from WebRTC sources should have
rtpTimestampmetadata set.
- : The RTP timestamp of the corresponding encoded frame. Only video frames originating from WebRTC sources should have
[!NOTE] A video frame's
metadatacan be returned using the VideoFrame.metadata() method.
-
-
rotation- : An integer representing the rotation (0, 90, 180, or 270) in degrees clockwise. Defaults to
0. Arbitrary numbers (including negatives) are rounded to the next quarter turn.
- : An integer representing the rotation (0, 90, 180, or 270) in degrees clockwise. Defaults to
-
timestamp- : An integer representing the timestamp of the frame in microseconds.
-
visibleRect- : An object representing the visible rectangle of the
VideoFrame, containing the following:x- : The x-coordinate.
y- : The y-coordinate.
width- : The width of the frame.
height- : The height of the frame.
- : An object representing the visible rectangle of the
-
- : An object containing the following:
The second type of constructor creates a new VideoFrame from an ArrayBuffer. Its parameters are:
data- : An ArrayBuffer, a TypedArray, or a DataView containing the data for the new
VideoFrame.
- : An ArrayBuffer, a TypedArray, or a DataView containing the data for the new
options- : An object containing the following:
codedHeight- : Height of the
VideoFramein pixels, potentially including non-visible padding, and prior to considering potential ratio adjustments.
- : Height of the
codedWidth- : Width of the
VideoFramein pixels, potentially including non-visible padding, and prior to considering potential ratio adjustments.
- : Width of the
colorSpace- : An object representing the color space of the
VideoFrame, containing the following:primaries- : A string representing the video color primaries, described on the page for the VideoColorSpace.primaries property.
transfer- : A string representing the video color transfer function, described on the page for the VideoColorSpace.transfer property.
matrix- : A string representing the video color matrix, described on the page for the VideoColorSpace.matrix property.
fullRange- : A Boolean. If
true, indicates that full-range color values are used.
- : A Boolean. If
- : An object representing the color space of the
displayHeight- : The height of the
VideoFramewhen displayed after applying aspect ratio adjustments.
- : The height of the
displayWidth- : The width of the
VideoFramewhen displayed after applying aspect ratio adjustments.
- : The width of the
duration- : An integer representing the duration of the frame in microseconds.
flip- : A boolean. If
true, horizontal mirroring is applied. Defaults tofalse.
- : A boolean. If
format- : A string representing the video pixel format. One of the following strings, which are fully described on the page for the VideoFrame.format property:
"I420""I420A""I422""I444""NV12""RGBA""RGBX""BGRA""BGRX"
- : A string representing the video pixel format. One of the following strings, which are fully described on the page for the VideoFrame.format property:
layout- : A list containing the following values for each plane in the
VideoFrame:offset- : An integer representing the offset in bytes where the given plane begins.
stride- : An integer representing the number of bytes, including padding, used by each row of the plane.
Planes may not overlap. If no
layoutis specified, the planes will be tightly packed.
- : An integer representing the number of bytes, including padding, used by each row of the plane.
Planes may not overlap. If no
- : A list containing the following values for each plane in the
metadata- : An object containing metadata describing the video frame, specified by the WebCodecs VideoFrame Metadata Registry, which can contain the following properties:
rtpTimestamp- : The RTP timestamp of the corresponding encoded frame.
- : An object containing metadata describing the video frame, specified by the WebCodecs VideoFrame Metadata Registry, which can contain the following properties:
rotation- : An integer representing the rotation (0, 90, 180, or 270) in degrees clockwise. Defaults to
0. Arbitrary numbers (including negatives) are rounded to the next quarter turn.
- : An integer representing the rotation (0, 90, 180, or 270) in degrees clockwise. Defaults to
timestamp- : An integer representing the timestamp of the frame in microseconds.
transfer- : An array of ArrayBuffers that
VideoFramewill detach and take ownership of. If the array contains the ArrayBuffer backingdata,VideoFramewill use that buffer directly instead of copying from it.
- : An array of ArrayBuffers that
visibleRect- : An object representing the visible rectangle of the
VideoFrame, containing the following:x- : The x-coordinate.
y- : The y-coordinate.
width- : The width of the frame.
height- : The height of the frame.
- : An object representing the visible rectangle of the
- : An object containing the following:
Examples
The following examples are from the article Video processing with WebCodecs. In this first example, a VideoFrame is created from a canvas.
const cnv = document.createElement("canvas");
// draw something on the canvas
// …
const frameFromCanvas = new VideoFrame(cnv, { timestamp: 0 });
In the following example a VideoFrame is created from a TypedArray.
const pixelSize = 4;
const init = {
timestamp: 0,
codedWidth: 320,
codedHeight: 200,
format: "RGBA",
};
const data = new Uint8Array(init.codedWidth * init.codedHeight * pixelSize);
for (let x = 0; x < init.codedWidth; x++) {
for (let y = 0; y < init.codedHeight; y++) {
const offset = (y * init.codedWidth + x) * pixelSize;
data[offset] = 0x7f; // Red
data[offset + 1] = 0xff; // Green
data[offset + 2] = 0xd4; // Blue
data[offset + 3] = 0x0ff; // Alpha
}
}
init.transfer = [data.buffer];
const frame = new VideoFrame(data, init);
Specifications
Browser compatibility
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
