agora::media::base::VideoFrame Struct Reference

Public Attributes
VIDEO_PIXEL_FORMAT	type
int	width
int	height
int	yStride
int	uStride
int	vStride
uint8_t *	yBuffer
uint8_t *	uBuffer
uint8_t *	vBuffer
int	rotation
int64_t	renderTimeMs
int	avsync_type

Detailed Description

The detailed information of the incoming video frame.

Member Data Documentation

type

VIDEO_PIXEL_FORMAT agora::media::base::VideoFrame::type

The pixel format of the video frame. See VIDEO_PIXEL_FORMAT

width

int agora::media::base::VideoFrame::width

The width (pixel) of the video.

height

int agora::media::base::VideoFrame::height

The height (pixel) of the video.

yStride

int agora::media::base::VideoFrame::yStride

The line stride of the Y buffer in the YUV data.

uStride

int agora::media::base::VideoFrame::uStride

The line stride of the U buffer in the YUV data.

vStride

int agora::media::base::VideoFrame::vStride

The line stride of the V buffer in the YUV data.

yBuffer

uint8_t* agora::media::base::VideoFrame::yBuffer

The Y buffer in the YUV data.

uBuffer

uint8_t* agora::media::base::VideoFrame::uBuffer

The U buffer in the YUV data.

vBuffer

uint8_t* agora::media::base::VideoFrame::vBuffer

The V buffer in the YUV data.

rotation

int agora::media::base::VideoFrame::rotation

Sets the rotation angle of the video frame before rendering.

You can set the angle as 0, 90, 180, or 270.

renderTimeMs

int64_t agora::media::base::VideoFrame::renderTimeMs

The timestamp of the incoming video frame.

Note

• You must set this parameter.
• The timestamp restores the order of the captured audio frame. You can use it to synchronize the audio and video frames in the scenarios, which are related to video and external video sources.

avsync_type

int agora::media::base::VideoFrame::avsync_type

The reserved parameter.