io.agora.rtc.VideoFrame类 参考

VideoFrame 类。

构造及析构函数说明

VideoFrame() [1/2]

io.agora.rtc.VideoFrame.VideoFrame

(

)

VideoFrame() [2/2]

io.agora.rtc.VideoFrame.VideoFrame	(	int	type,
		int	width,
		int	height,
		int	yStride,
		int	uStride,
		int	vStride,
		ByteBuffer	yBuffer,
		ByteBuffer	uBuffer,
		ByteBuffer	vBuffer,
		int	rotation,
		long	renderTimeMs,
		int	avsyncType,
		ByteBuffer	metadataBuffer,
		Object	sharedContext,
		int	textureId,
		float[]	matrix,
		ByteBuffer	alphaBuffer,
		int	alphaMode )

成员函数说明

getAlphaBuffer()

ByteBuffer io.agora.rtc.VideoFrame.getAlphaBuffer

(

)

getAlphaMode()

int io.agora.rtc.VideoFrame.getAlphaMode

(

)

getAvsyncType()

int io.agora.rtc.VideoFrame.getAvsyncType

(

)

getHeight()

int io.agora.rtc.VideoFrame.getHeight

(

)

getMatrix()

float[] io.agora.rtc.VideoFrame.getMatrix

(

)

getMetadataBuffer()

ByteBuffer io.agora.rtc.VideoFrame.getMetadataBuffer

(

)

getRenderTimeMs()

long io.agora.rtc.VideoFrame.getRenderTimeMs

(

)

getRotation()

int io.agora.rtc.VideoFrame.getRotation

(

)

getSharedContext()

Object io.agora.rtc.VideoFrame.getSharedContext

(

)

getTextureId()

int io.agora.rtc.VideoFrame.getTextureId

(

)

getType()

int io.agora.rtc.VideoFrame.getType

(

)

getUBuffer()

ByteBuffer io.agora.rtc.VideoFrame.getUBuffer

(

)

getUStride()

int io.agora.rtc.VideoFrame.getUStride

(

)

getVBuffer()

ByteBuffer io.agora.rtc.VideoFrame.getVBuffer

(

)

getVStride()

int io.agora.rtc.VideoFrame.getVStride

(

)

getWidth()

int io.agora.rtc.VideoFrame.getWidth

(

)

getYBuffer()

ByteBuffer io.agora.rtc.VideoFrame.getYBuffer

(

)

getYStride()

int io.agora.rtc.VideoFrame.getYStride

(

)

setAlphaBuffer()

void io.agora.rtc.VideoFrame.setAlphaBuffer

(

ByteBuffer

alphaBuffer

)

setAlphaMode()

void io.agora.rtc.VideoFrame.setAlphaMode

(

int

alphaMode

)

setAvsyncType()

void io.agora.rtc.VideoFrame.setAvsyncType

(

int

avsyncType

)

setHeight()

void io.agora.rtc.VideoFrame.setHeight

(

int

height

)

setMatrix()

void io.agora.rtc.VideoFrame.setMatrix

(

float[]

matrix

)

setMetadataBuffer()

void io.agora.rtc.VideoFrame.setMetadataBuffer

(

ByteBuffer

metadataBuffer

)

setRenderTimeMs()

void io.agora.rtc.VideoFrame.setRenderTimeMs

(

long

renderTimeMs

)

setRotation()

void io.agora.rtc.VideoFrame.setRotation

(

int

rotation

)

setSharedContext()

void io.agora.rtc.VideoFrame.setSharedContext

(

Object

sharedContext

)

setTextureId()

void io.agora.rtc.VideoFrame.setTextureId

(

int

textureId

)

setType()

void io.agora.rtc.VideoFrame.setType

(

int

type

)

setUBuffer()

void io.agora.rtc.VideoFrame.setUBuffer

(

ByteBuffer

uBuffer

)

setUStride()

void io.agora.rtc.VideoFrame.setUStride

(

int

uStride

)

setVBuffer()

void io.agora.rtc.VideoFrame.setVBuffer

(

ByteBuffer

vBuffer

)

setVStride()

void io.agora.rtc.VideoFrame.setVStride

(

int

vStride

)

setWidth()

void io.agora.rtc.VideoFrame.setWidth

(

int

width

)

setYBuffer()

void io.agora.rtc.VideoFrame.setYBuffer

(

ByteBuffer

yBuffer

)

setYStride()

void io.agora.rtc.VideoFrame.setYStride

(

int

yStride

)

toString()

String io.agora.rtc.VideoFrame.toString

(

)

类成员变量说明

private

alphaBuffer

ByteBuffer io.agora.rtc.VideoFrame.alphaBuffer

采用人像分割算法输出的 Alpha 通道数据。该数据跟视频帧的尺寸一致，每个像素点的取值范围为 [0,255]，其中 0 代表背景；255 代表前景（人像）。你可以通过设置该参数，实现将视频背景自渲染为各种效果，例如：透明、纯色、图片、视频等。默认值为 NULL。

private

alphaMode

int io.agora.rtc.VideoFrame.alphaMode

当视频祯中包含 Alpha 通道数据时，设置 alphaBuffer 和视频祯的相对位置：

• 0: （默认）仅视频祯，即 alphaBuffer 不和视频祯拼接。
  
• 1: alphaBuffer 位于视频帧的上方。
  
• 2: alphaBuffer 位于视频帧的下方。
  
• 3: alphaBuffer 位于视频帧的左侧。
  
• 4: alphaBuffer 位于视频帧的右侧。
  

private

avsyncType

int io.agora.rtc.VideoFrame.avsyncType

音视频同步类型。

private

height

int io.agora.rtc.VideoFrame.height

视频帧的高度 (px)。

private

matrix

float [] io.agora.rtc.VideoFrame.matrix

[仅适用于 Texture] 一个输入的 4x4 变换矩阵，典型值为一个单位矩阵。

private

metadataBuffer

ByteBuffer io.agora.rtc.VideoFrame.metadataBuffer

[仅适用于 Texture] The MetaData 的数据缓冲区，默认值为 NULL.

private

renderTimeMs

long io.agora.rtc.VideoFrame.renderTimeMs

视频帧渲染的时间戳。渲染视频时可以使用该参数实现音视频同步。

private

rotation

int io.agora.rtc.VideoFrame.rotation

视频帧顺时针旋转信息。该参数的值可以设置为 0、90、180、270。

private

sharedContext

Object io.agora.rtc.VideoFrame.sharedContext

[仅适用于 Texture] EGLContext。

private

textureId

int io.agora.rtc.VideoFrame.textureId

[仅适用于 Texture] 该视频帧的 Texture ID。

private

type

int io.agora.rtc.VideoFrame.type

视频像素格式。

• 0：未知格式。
  
• 1：I420。
  
• 2：BGRA。
  
• 3：NV21。
  
• 4：RGBA。
  
• 8：NV12。
  
• 10：GL_TEXTURE_2D。
  
• 11：GL_TEXTURE_OES。
  
• 16：I422。
  

private

uBuffer

ByteBuffer io.agora.rtc.VideoFrame.uBuffer

对 YUV 数据，表示 U 缓冲区的指针。

private

uStride

int io.agora.rtc.VideoFrame.uStride

对 YUV 数据，表示 U 缓冲区的行跨度。

private

vBuffer

ByteBuffer io.agora.rtc.VideoFrame.vBuffer

对 YUV 数据，表示 V 缓冲区的指针。

private

vStride

int io.agora.rtc.VideoFrame.vStride

对 YUV 数据，表示 V 缓冲区的行跨度。

private

width

int io.agora.rtc.VideoFrame.width

视频帧的宽度 (px)。

private

yBuffer

ByteBuffer io.agora.rtc.VideoFrame.yBuffer

对 YUV 数据，表示 Y 缓冲区的指针。

private

yStride

int io.agora.rtc.VideoFrame.yStride

对 YUV 数据，表示 Y 缓冲区的行跨度。