Agora C++ API Reference for All Platforms
agora::media::IVideoFrameObserver::VideoFrame Struct Reference

#include <IAgoraMediaEngine.h>

Public Attributes

VIDEO_FRAME_TYPE type
 
int width
 
int height
 
int yStride
 
int uStride
 
int vStride
 
void * yBuffer
 
void * uBuffer
 
void * vBuffer
 
int rotation
 
int64_t renderTimeMs
 
int avsync_type
 

Detailed Description

Video frame information. The video data format is YUV 420. The buffer provides a pointer to a pointer. The interface cannot modify the pointer of the buffer, but can modify the content of the buffer only.

Member Data Documentation

◆ type

VIDEO_FRAME_TYPE agora::media::IVideoFrameObserver::VideoFrame::type

◆ width

int agora::media::IVideoFrameObserver::VideoFrame::width

Video pixel width.

◆ height

int agora::media::IVideoFrameObserver::VideoFrame::height

Video pixel height.

◆ yStride

int agora::media::IVideoFrameObserver::VideoFrame::yStride

For YUV data, the line span of the Y buffer; for RGBA data, the total data length.

◆ uStride

int agora::media::IVideoFrameObserver::VideoFrame::uStride

For YUV data, the line span of the U buffer; for RGBA data, the value is 0.

◆ vStride

int agora::media::IVideoFrameObserver::VideoFrame::vStride

For YUV data, the line span of the V buffer; for RGBA data, the value is 0.

◆ yBuffer

void* agora::media::IVideoFrameObserver::VideoFrame::yBuffer

For YUV data, the pointer to the Y buffer; for RGBA data, the data buffer.

◆ uBuffer

void* agora::media::IVideoFrameObserver::VideoFrame::uBuffer

For YUV data, the pointer to the U buffer; for RGBA data, the value is 0.

◆ vBuffer

void* agora::media::IVideoFrameObserver::VideoFrame::vBuffer

For YUV data, the pointer to the V buffer; for RGBA data, the value is 0.

◆ rotation

int agora::media::IVideoFrameObserver::VideoFrame::rotation

The clockwise rotation angle of the video frame. The supported values are 0, 90, 180, or 270 degrees.

◆ renderTimeMs

int64_t agora::media::IVideoFrameObserver::VideoFrame::renderTimeMs

The Unix timestamp (ms) when the video frame is rendered. This timestamp can be used to guide the rendering of the video frame. This parameter is required.

◆ avsync_type

int agora::media::IVideoFrameObserver::VideoFrame::avsync_type