Class VideoFrame

Configurations of the video frame. Note that the buffer provides a pointer to a pointer. This interface cannot modify the pointer of the buffer, but it can modify the content of the buffer.

Hierarchy

  • VideoFrame

Constructors

Properties

avsync_type?: number

Reserved for future use.

height?: number

The height of the video, in pixels.

matrix?: number[]

This parameter only applies to video data in Texture format. Incoming 4 × 4 transformational matrix. The typical value is a unit matrix.

metadata_buffer?: Uint8Array

This parameter only applies to video data in Texture format. The MetaData buffer. The default value is NULL.

metadata_size?: number

This parameter only applies to video data in Texture format. The MetaData size. The default value is 0.

renderTimeMs?: number

The Unix timestamp (ms) when the video frame is rendered. This timestamp can be used to guide the rendering of the video frame. It is required.

rotation?: number

The clockwise rotation of the video frame before rendering. Supported values include 0, 90, 180, and 270 degrees.

textureId?: number

This parameter only applies to video data in Texture format. Texture ID.

The pixel format. See VideoPixelFormat .

uBuffer?: Uint8Array

For YUV data, the pointer to the U buffer; for RGBA data, the value is 0.

uStride?: number

For YUV data, the line span of the U buffer; for RGBA data, the value is 0.

vBuffer?: Uint8Array

For YUV data, the pointer to the V buffer; for RGBA data, the value is 0.

vStride?: number

For YUV data, the line span of the V buffer; for RGBA data, the value is 0.

width?: number

The width of the video, in pixels.

yBuffer?: Uint8Array

For YUV data, the pointer to the Y buffer; for RGBA data, the data buffer.

yStride?: number

For YUV data, the line span of the Y buffer; for RGBA data, the total data length.

Generated using TypeDoc