Class ExternalVideoFrame

The external video frame.

Hierarchy

  • ExternalVideoFrame

Constructors

constructor

Properties

buffer? cropBottom? cropLeft? cropRight? cropTop? eglType? format? height? matrix? metadata_buffer? metadata_size? rotation? stride? textureId? timestamp? type?

Constructors

constructor

Properties

Optional buffer

buffer?: Uint8Array

Video frame buffer.

Optional cropBottom

cropBottom?: number

Raw data related parameter. The number of pixels trimmed from the bottom. The default value is 0.

Optional cropLeft

cropLeft?: number

Raw data related parameter. The number of pixels trimmed from the left. The default value is 0.

Optional cropRight

cropRight?: number

Raw data related parameter. The number of pixels trimmed from the right. The default value is 0.

Optional cropTop

cropTop?: number

Raw data related parameter. The number of pixels trimmed from the top. The default value is 0.

Optional eglType

eglType?: EglContextType

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

Optional format

format?: VideoPixelFormat

The pixel format. See VideoPixelFormat .

Optional height

height?: number

Height of the incoming video frame.

Optional matrix

matrix?: number[]

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

Optional metadata_buffer

metadata_buffer?: Uint8Array

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

Optional metadata_size

metadata_size?: number

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

Optional rotation

rotation?: number

Raw data related parameter. The clockwise rotation of the video frame. You can set the rotation angle as 0, 90, 180, or 270. The default value is 0.

Optional stride

stride?: number

Line spacing of the incoming video frame, which must be in pixels instead of bytes. For textures, it is the width of the texture.

Optional textureId

textureId?: number

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

Optional timestamp

timestamp?: number

Timestamp (ms) of the incoming video frame. An incorrect timestamp results in frame loss or unsynchronized audio and video.

Optional type

type?: VideoBufferType

The video type. See VideoBufferType .

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc