io.agora.rtc.ExternalVideoFrame Class Reference

Private Attributes
int	type
int	format
java.nio.ByteBuffer	buffer
int	stride
int	height
int	cropLeft
int	cropTop
int	cropRight
int	cropBottom
int	rotation
long	timestamp
Object	eglContext
int	eglType
int	textureId
float	matrix
ByteBuffer	metadataBuffer
int	fillAlphaBuffer
ByteBuffer	alphaBuffer
int	alphaMode
ColorSpace	colorSpace

Detailed Description

The ExternalVideoFrame class.

Member Data Documentation

alphaBuffer

ByteBuffer io.agora.rtc.ExternalVideoFrame.alphaBuffer

private

Portrait Segmentation meta buffer, dimension of which is the same as VideoFrame. The value range is [0,255], where 0 represents totally background, and 255 represents totally foreground. The default value is NULL.

alphaMode

int io.agora.rtc.ExternalVideoFrame.alphaMode

private

The relative positon between alphaBuffer and the frame.

• 0: （Default）Normal frame.
• 1: alphaBuffer is above the frame.
• 2: alphaBuffer is below the frame.
• 3: alphaBuffer is on the left of the frame.
• 4: alphaBuffer is on the right of the frame.

buffer

java.nio.ByteBuffer io.agora.rtc.ExternalVideoFrame.buffer

private

The video buffer.

colorSpace

ColorSpace io.agora.rtc.ExternalVideoFrame.colorSpace

private

The color space of the video frame. See ColorSpaceType.

cropBottom

int io.agora.rtc.ExternalVideoFrame.cropBottom

private

[Raw video data related] The number of pixels to be cut on the bottom. The default value is 0.

cropLeft

int io.agora.rtc.ExternalVideoFrame.cropLeft

private

[Raw video data related] The number of pixels to be cut on the left. The default value is 0.

cropRight

int io.agora.rtc.ExternalVideoFrame.cropRight

private

[Raw video data related] The number of pixels to be cut on the right. The default value is 0.

cropTop

int io.agora.rtc.ExternalVideoFrame.cropTop

private

[Raw video data related] The number of pixels to be cut on the top. The default value is 0.

eglContext

Object io.agora.rtc.ExternalVideoFrame.eglContext

private

[Texture-related parameter]

• 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

int io.agora.rtc.ExternalVideoFrame.eglType

private

[Texture-related parameter] The EGL type.

fillAlphaBuffer

int io.agora.rtc.ExternalVideoFrame.fillAlphaBuffer

private

[For BGRA or RGBA only] Whether to extract alphaBuffer from BGRA or RGBA data.

• true: Yes. Set it to true if you do not explicitly specify the alphaBuffer.
• false: (Default) No.

format

int io.agora.rtc.ExternalVideoFrame.format

private

The pixel format.

height

int io.agora.rtc.ExternalVideoFrame.height

private

The height of the video frame.

matrix

float io.agora.rtc.ExternalVideoFrame.matrix

private

[Texture-related parameter] 4x4 transformational matrix. The typical value is a unit matrix.

metadataBuffer

ByteBuffer io.agora.rtc.ExternalVideoFrame.metadataBuffer

private

[Texture related parameter] The MetaData buffer. Teh default value is NULL.

rotation

int io.agora.rtc.ExternalVideoFrame.rotation

private

[Raw video data related] Whether to rotate the video frame clockwise. You can set is as 0, 90, 180, and 270. The default value is 0.

stride

int io.agora.rtc.ExternalVideoFrame.stride

private

The stride in pixel of the video frame. For texture, this value indicates the width of the texture.

textureId

int io.agora.rtc.ExternalVideoFrame.textureId

private

[Texture-related parameter] The texture ID of the video frame.

timestamp

long io.agora.rtc.ExternalVideoFrame.timestamp

private

The timestamp (miliseconds) of the video frame. An incorrect timestamp leads to frame loss or unsynchronized audio and video.

type

int io.agora.rtc.ExternalVideoFrame.type

private

The data type of the video frame.

• 1: Raw video data.
• 2: Same as 1.
• 3: Texture.

---

The documentation for this class was generated from the following file:

• ExternalVideoFrame.java