Skip to main content

VideoFrame

The VideoFrame interface of the Web Codecs API represents a frame of a video.

MDN Reference

Methods​

allocationSize()​

allocationSize(options?): number;

The allocationSize() method of the VideoFrame interface returns the number of bytes required to hold the video as filtered by options passed into the method.

MDN Reference

Parameters​

ParameterType
options?VideoFrameCopyToOptions

Returns​

number

clone()​

clone(): VideoFrame;

The clone() method of the VideoFrame interface creates a new VideoFrame object referencing the same media resource as the original.

MDN Reference

Returns​

VideoFrame

close()​

close(): void;

The close() method of the VideoFrame interface clears all states and releases the reference to the media resource.

MDN Reference

Returns​

void

copyTo()​

copyTo(destination, options?): Promise<PlaneLayout[]>;

The copyTo() method of the VideoFrame interface copies the contents of the VideoFrame to an ArrayBuffer.

MDN Reference

Parameters​

ParameterType
destinationAllowSharedBufferSource
options?VideoFrameCopyToOptions

Returns​

Promise<PlaneLayout[]>

Properties​

codedHeight​

readonly codedHeight: number;

The codedHeight property of the VideoFrame interface returns the height of the VideoFrame in pixels, potentially including non-visible padding, and prior to considering potential ratio adjustments.

MDN Reference

codedRect​

readonly codedRect: DOMRectReadOnly | null;

The codedRect property of the VideoFrame interface returns a DOMRectReadOnly with the width and height matching VideoFrame.codedWidth and VideoFrame.codedHeight.

MDN Reference

codedWidth​

readonly codedWidth: number;

The codedWidth property of the VideoFrame interface returns the width of the VideoFrame in pixels, potentially including non-visible padding, and prior to considering potential ratio adjustments.

MDN Reference

colorSpace​

readonly colorSpace: VideoColorSpace;

The colorSpace property of the VideoFrame interface returns a VideoColorSpace object representing the color space of the video.

MDN Reference

displayHeight​

readonly displayHeight: number;

The displayHeight property of the VideoFrame interface returns the height of the VideoFrame after applying aspect ratio adjustments.

MDN Reference

displayWidth​

readonly displayWidth: number;

The displayWidth property of the VideoFrame interface returns the width of the VideoFrame after applying aspect ratio adjustments.

MDN Reference

duration​

readonly duration: number | null;

The duration property of the VideoFrame interface returns an integer indicating the duration of the video in microseconds.

MDN Reference

format​

readonly format: VideoPixelFormat | null;

The format property of the VideoFrame interface returns the pixel format of the VideoFrame.

MDN Reference

timestamp​

readonly timestamp: number;

The timestamp property of the VideoFrame interface returns an integer indicating the timestamp of the video in microseconds.

MDN Reference

visibleRect​

readonly visibleRect: DOMRectReadOnly | null;

The visibleRect property of the VideoFrame interface returns a DOMRectReadOnly describing the visible rectangle of pixels for this VideoFrame.

MDN Reference