ExternalVideoFrame

The external video frame.

export class ExternalVideoFrame {
  type?: VideoBufferType;
  format?: VideoPixelFormat;
  buffer?: Uint8Array;
  stride?: number;
  height?: number;
  cropLeft?: number;
  cropTop?: number;
  cropRight?: number;
  cropBottom?: number;
  rotation?: number;
  timestamp?: number;
  eglType?: EglContextType;
  textureId?: number;
  matrix?: number[];
  metadataBuffer?: Uint8Array;
  metadataSize?: number;
  alphaBuffer?: Uint8Array;
  fillAlphaBuffer?: boolean;
  alphaStitchMode?: AlphaStitchMode;
}

Attributes

type

The video type. See VideoBufferType.

format

The pixel format. See VideoPixelFormat.

buffer

Video frame buffer.

stride

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

height

Height of the incoming video frame.

eglContext

This parameter only applies to video data in Texture format.

When using the OpenGL interface (javax.microedition.khronos.egl.*) defined by Khronos, set eglContext to this field.
When using the OpenGL interface (android.opengl.*) defined by Android, set eglContext to this field.

eglType

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

textureId

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

matrix

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

metadataBuffer

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

metadataSize

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

alphaBuffer

The alpha channel data output by using portrait segmentation algorithm. This data matches the size of the video frame, with each pixel value ranging from [0,255], where 0 represents the background and 255 represents the foreground (portrait).

By setting this parameter, you can render the video background into various effects, such as transparent, solid color, image, video, etc.

Attention: In custom video rendering scenarios, ensure that both the video frame and alphaBuffer are of the Full Range type; other types may cause abnormal alpha data rendering.

fillAlphaBuffer

This parameter only applies to video data in BGRA or RGBA format. Whether to extract the alpha channel data from the video frame and automatically fill it into alphaBuffer:

true：Extract and fill the alpha channel data.
false: (Default) Do not extract and fill the Alpha channel data.

Note: For video data in BGRA or RGBA format, you can set the Alpha channel data in either of the following ways:

Automatically by setting this parameter to true.
Manually through the alphaBuffer parameter.

alphaStitchMode

When the video frame contains alpha channel data, it represents the relative position of alphaBuffer and the video frame. See AlphaStitchMode.

cropLeft

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

This parameter only applies to raw video data.

cropTop

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

This parameter only applies to raw video data.

cropRight

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

This parameter only applies to raw video data.

cropBottom

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

This parameter only applies to raw video data.

rotation

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.

timestamp

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