Agora Server Gateway SDK C++ API Reference
Public Member Functions | Public Attributes | List of all members
agora::media::base::VideoFrame Struct Reference

#include <AgoraMediaBase.h>

Public Member Functions

 VideoFrame ()

Public Attributes

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 definition of the VideoFrame struct.

Constructor & Destructor Documentation

◆ VideoFrame()

agora::media::base::VideoFrame::VideoFrame ( )

Member Data Documentation

◆ avsync_type

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

The type of audio-video synchronization.

◆ height

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

The height of the video frame.

◆ renderTimeMs

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

The timestamp to render the video stream. Use this parameter for audio-video synchronization when rendering the video.

This parameter is for rendering the video, not capturing the video.

◆ rotation

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

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

◆ type

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

The video pixel format: VIDEO_PIXEL_FORMAT.

◆ uBuffer

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

The pointer to the U buffer in the YUV data.

◆ uStride

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

The line span of U buffer in the YUV data.

◆ vBuffer

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

The pointer to the V buffer in the YUV data.

◆ vStride

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

The line span of V buffer in the YUV data.

◆ width

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

The width of the video frame.

◆ yBuffer

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

The pointer to the Y buffer in the YUV data.

◆ yStride

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

The line span of Y buffer in the YUV data.

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