VideoFrame: VideoFrame() constructor

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.

options Optional

An object containing the following:

alpha Optional

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.

displayHeight Optional

The height of the VideoFrame when displayed after applying aspect-ratio adjustments.

displayWidth Optional

The width of the VideoFrame when displayed after applying aspect-ratio adjustments.

duration Optional

An integer representing the duration of the frame in microseconds.

flip Optional

A boolean. If true, horizontal mirroring is applied. Defaults to false.

metadata Optional

An object containing metadata describing the video frame, specified by the WebCodecs VideoFrame Metadata Registry, which can contain the following properties:

rtpTimestamp Optional

The RTP timestamp of the corresponding encoded frame. Only video frames originating from WebRTC sources should have rtpTimestamp metadata set.

Note: A video frame's metadata can be returned using the VideoFrame.metadata() method.

rotation Optional

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.

timestamp

An integer representing the timestamp of the frame in microseconds.

visibleRect Optional

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.

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.

options

An object containing the following:

codedHeight

Height of the VideoFrame in pixels, potentially including non-visible padding, and prior to considering potential ratio adjustments.

codedWidth

Width of the VideoFrame in pixels, potentially including non-visible padding, and prior to considering potential ratio adjustments.

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.

displayHeight Optional

The height of the VideoFrame when displayed after applying aspect ratio adjustments.

displayWidth Optional

The width of the VideoFrame when displayed after applying aspect ratio adjustments.

duration Optional

An integer representing the duration of the frame in microseconds.

flip Optional

A boolean. If true, horizontal mirroring is applied. Defaults to false.

format

A string representing the video pixel format. One of the following strings, which are fully described on the page for the format property:

• "I420"
• "I420A"
• "I422"
• "I444"
• "NV12"
• "RGBA"
• "RGBX"
• "BGRA"
• "BGRX"

layout Optional

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 layout is specified, the planes will be tightly packed.

metadata Optional

An object containing metadata describing the video frame, specified by the WebCodecs VideoFrame Metadata Registry, which can contain the following properties:

rtpTimestamp Optional

The RTP timestamp of the corresponding encoded frame.

rotation Optional

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.

timestamp

An integer representing the timestamp of the frame in microseconds.

transfer

An array of ArrayBuffers that VideoFrame will detach and take ownership of. If the array contains the ArrayBuffer backing data, VideoFrame will use that buffer directly instead of copying from it.

visibleRect Optional

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.

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