Public Member Functions
	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)

int	getType ()

void	setType (int type)

int	getWidth ()

void	setWidth (int width)

int	getHeight ()

void	setHeight (int height)

int	getYStride ()

void	setYStride (int yStride)

int	getUStride ()

void	setUStride (int uStride)

int	getVStride ()

void	setVStride (int vStride)

ByteBuffer	getYBuffer ()

void	setYBuffer (ByteBuffer yBuffer)

ByteBuffer	getUBuffer ()

void	setUBuffer (ByteBuffer uBuffer)

ByteBuffer	getVBuffer ()

void	setVBuffer (ByteBuffer vBuffer)

int	getRotation ()

void	setRotation (int rotation)

long	getRenderTimeMs ()

void	setRenderTimeMs (long renderTimeMs)

int	getAvsyncType ()

void	setAvsyncType (int avsyncType)

ByteBuffer	getMetadataBuffer ()

void	setMetadataBuffer (ByteBuffer metadataBuffer)

Object	getSharedContext ()

void	setSharedContext (Object sharedContext)

int	getTextureId ()

void	setTextureId (int textureId)

float[]	getMatrix ()

void	setMatrix (float[] matrix)

ByteBuffer	getAlphaBuffer ()

void	setAlphaBuffer (ByteBuffer alphaBuffer)

int	getAlphaMode ()

void	setAlphaMode (int alphaMode)

String	toString ()

Private Attributes
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

Detailed Description

The VideoFrame class.

Constructor & Destructor Documentation

◆ 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 )

Member Function Documentation

◆ 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 ( )

Member Data Documentation

◆ alphaBuffer

ByteBuffer io.agora.rtc.VideoFrame.alphaBuffer

private

Portrait Segmentation meta buffer, dimension of which is the same as VideoFrame. Pixl value is between 0-255, 0 represents totally background, 255 represents totally foreground. The default value is NULL.

◆ alphaMode

int io.agora.rtc.VideoFrame.alphaMode

private

The relative position between alphabuffer and the frame.

0: Normal frame;
1: Alphabuffer is above the frame;
2: Alphabuffer is below the frame;
3: Alphabuffer is on the left of frame;
4: Alphabuffer is on the right of frame; The default value is 0.

◆ avsyncType

int io.agora.rtc.VideoFrame.avsyncType

private

The audio video sync type.

◆ height

int io.agora.rtc.VideoFrame.height

private

Video pixel height.

◆ matrix

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

private

[Texture related parameter] Incoming 4 × 4 transformational matrix.

◆ metadataBuffer

ByteBuffer io.agora.rtc.VideoFrame.metadataBuffer

private

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

◆ renderTimeMs

long io.agora.rtc.VideoFrame.renderTimeMs

private

Timestamp to render the video stream. You can use this timestamp to synchronize audio and video when rendering the video streams.

Note: This timestamp is for rendering the video stream, not for capturing the video stream.

◆ rotation

int io.agora.rtc.VideoFrame.rotation

private

The rotation information of this frame clockwise. You can set it as 0, 90, 180, or 270.

◆ sharedContext

Object io.agora.rtc.VideoFrame.sharedContext

private

[Texture related parameter] The EGL Context.

◆ textureId

int io.agora.rtc.VideoFrame.textureId

private

[Texture related parameter] Texture ID used by the video frame.

◆ type

int io.agora.rtc.VideoFrame.type

private

The video pixel format.

0: Unknown format.
1: I420.
2: BGRA.
3: NV21.
4: RGBA.
8: NV12.
10: GL_TEXTURE_2D.
11: GL_TEXTURE_OES.
16: I422.

◆ uBuffer

ByteBuffer io.agora.rtc.VideoFrame.uBuffer

private

The U data buffer in YUV data.

◆ uStride

int io.agora.rtc.VideoFrame.uStride

private

Line span of U buffer in YUV data.

◆ vBuffer

ByteBuffer io.agora.rtc.VideoFrame.vBuffer

private

The V data buffer in YUV data.

◆ vStride

int io.agora.rtc.VideoFrame.vStride

private

Line span of V buffer in YUV data.

◆ width

int io.agora.rtc.VideoFrame.width

private

Video pixel width.

◆ yBuffer

ByteBuffer io.agora.rtc.VideoFrame.yBuffer

private

The Y data buffer in YUV data.

◆ yStride

int io.agora.rtc.VideoFrame.yStride

private

Line span of Y buffer in YUV data.

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

VideoFrame.java

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VideoFrame() [1/2]

◆ VideoFrame() [2/2]

Member Function Documentation

◆ getAlphaBuffer()

◆ getAlphaMode()

◆ getAvsyncType()

◆ getHeight()

◆ getMatrix()

◆ getMetadataBuffer()

◆ getRenderTimeMs()

◆ getRotation()

◆ getSharedContext()

◆ getTextureId()

◆ getType()

◆ getUBuffer()

◆ getUStride()

◆ getVBuffer()

◆ getVStride()

◆ getWidth()

◆ getYBuffer()

◆ getYStride()

◆ setAlphaBuffer()

◆ setAlphaMode()

◆ setAvsyncType()

◆ setHeight()

◆ setMatrix()

◆ setMetadataBuffer()

◆ setRenderTimeMs()

◆ setRotation()

◆ setSharedContext()

◆ setTextureId()

◆ setType()

◆ setUBuffer()

◆ setUStride()

◆ setVBuffer()

◆ setVStride()

◆ setWidth()

◆ setYBuffer()

◆ setYStride()

◆ toString()

Member Data Documentation

◆ alphaBuffer

◆ alphaMode

◆ avsyncType

◆ height

◆ matrix

◆ metadataBuffer

◆ renderTimeMs

◆ rotation

◆ sharedContext

◆ textureId

◆ type

◆ uBuffer

◆ uStride

◆ vBuffer

◆ vStride

◆ width

◆ yBuffer

◆ yStride