Table of Contents

Class VideoFrame

Namespace
CSharpToJavaScript.APIs.JS
Assembly
CSharpToJavaScript.dll

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

[Value("VideoFrame")]
public class VideoFrame
Inheritance
VideoFrame
Inherited Members

Remarks

VideoFrame is a transferable object.

-Video processing with WebCodecs
-WebCodecs examples

See also on MDN

Constructors

VideoFrame() 

public VideoFrame()

VideoFrame(Union225, VideoFrameBufferInit)

The VideoFrame() constructor creates a new VideoFrame object representing a frame of a video.

public VideoFrame(Union225 data, VideoFrameBufferInit init)

Parameters

data Union225
init VideoFrameBufferInit

Remarks

See also on MDN

VideoFrame(Union72, VideoFrameInit)

The VideoFrame() constructor creates a new VideoFrame object representing a frame of a video.

public VideoFrame(Union72 image, VideoFrameInit init = null)

Parameters

image Union72
init VideoFrameInit

Remarks

See also on MDN

Properties

CodedHeight

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.

[Value("codedHeight")]
public ulong CodedHeight { get; }

Property Value

ulong

An integer.

Remarks

See also on MDN

CodedRect

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

[Value("codedRect")]
public DOMRectReadOnly? CodedRect { get; }

Property Value

DOMRectReadOnly

A DOMRectReadOnly.

Remarks

See also on MDN

CodedWidth

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.

[Value("codedWidth")]
public ulong CodedWidth { get; }

Property Value

ulong

An integer.

Remarks

See also on MDN

ColorSpace

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

[Value("colorSpace")]
public VideoColorSpace ColorSpace { get; }

Property Value

VideoColorSpace

A VideoColorSpace object.

Remarks

See also on MDN

DisplayHeight

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

[Value("displayHeight")]
public ulong DisplayHeight { get; }

Property Value

ulong

An integer.

Remarks

See also on MDN

DisplayWidth

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

[Value("displayWidth")]
public ulong DisplayWidth { get; }

Property Value

ulong

An integer.

Remarks

See also on MDN

Duration

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

[Value("duration")]
public ulong? Duration { get; }

Property Value

ulong?

An integer.

Remarks

See also on MDN

Flip

NOTE
Experimental
The flip property of the VideoFrame interface returns a boolean that indicates whether the VideoFrame is horizontally mirrored. 
[Value("flip")]
public bool Flip { get; }

Property Value

bool

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

Remarks

See also on MDN

Format

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

[Value("format")]
public VideoPixelFormat? Format { get; }

Property Value

VideoPixelFormat?

A string containing a video pixel format, one of:

Remarks

See also on MDN

Rotation

NOTE
Experimental
The rotation property of the VideoFrame interface returns the rotation of the video frame. 
[Value("rotation")]
public Number Rotation { get; }

Property Value

Number

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.

Remarks

See also on MDN

Timestamp

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

[Value("timestamp")]
public long Timestamp { get; }

Property Value

long

An integer.

Remarks

See also on MDN

VisibleRect

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

[Value("visibleRect")]
public DOMRectReadOnly? VisibleRect { get; }

Property Value

DOMRectReadOnly

A DOMRectReadOnly.

Remarks

See also on MDN

Methods

AllocationSize(VideoFrameCopyToOptions)

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.

[Value("allocationSize")]
public ulong AllocationSize(VideoFrameCopyToOptions options = null)

Parameters

options VideoFrameCopyToOptions

Returns

ulong

An integer containing the number of bytes needed to hold the frame as specified by options.

Remarks

See also on MDN

Clone()

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

[Value("clone")]
public VideoFrame Clone()

Returns

VideoFrame

A new cloned VideoFrame object.

Remarks

See also on MDN

Close()

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

[Value("close")]
public GlobalObject.Undefined Close()

Returns

GlobalObject.Undefined

Undefined.

Remarks

See also on MDN

CopyTo(Union225, VideoFrameCopyToOptions)

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

[Value("copyTo")]
public Task<List<PlaneLayout>> CopyTo(Union225 destination, VideoFrameCopyToOptions options = null)

Parameters

destination Union225
options VideoFrameCopyToOptions

Returns

Task<List<PlaneLayout>>

A Promise that resolves to the layout of the copy when the copy has completed.

Remarks

See also on MDN

Metadata() 

[Value("metadata")]
public VideoFrameMetadata Metadata()

Returns

VideoFrameMetadata
Edit this page