Agora C++ API Reference for All Platforms
Public Member Functions | Public Attributes | List of all members
agora::rtc::EncodedVideoFrameInfo Struct Reference

Public Member Functions

 EncodedVideoFrameInfo ()
 
 EncodedVideoFrameInfo (const EncodedVideoFrameInfo &rhs)
 
EncodedVideoFrameInfooperator= (const EncodedVideoFrameInfo &rhs)
 

Public Attributes

VIDEO_CODEC_TYPE codecType
 
int width
 
int height
 
int framesPerSecond
 
VIDEO_FRAME_TYPE frameType
 
VIDEO_ORIENTATION rotation
 
int trackId
 
int64_t captureTimeMs
 
int64_t decodeTimeMs
 
uid_t uid
 
VIDEO_STREAM_TYPE streamType
 

Detailed Description

The definition of the EncodedVideoFrameInfo struct, which contains the information of the external encoded video frame.

Constructor & Destructor Documentation

◆ EncodedVideoFrameInfo() [1/2]

agora::rtc::EncodedVideoFrameInfo::EncodedVideoFrameInfo ( )
inline

◆ EncodedVideoFrameInfo() [2/2]

agora::rtc::EncodedVideoFrameInfo::EncodedVideoFrameInfo ( const EncodedVideoFrameInfo rhs)
inline

Member Function Documentation

◆ operator=()

EncodedVideoFrameInfo& agora::rtc::EncodedVideoFrameInfo::operator= ( const EncodedVideoFrameInfo rhs)
inline

Member Data Documentation

◆ codecType

VIDEO_CODEC_TYPE agora::rtc::EncodedVideoFrameInfo::codecType

The codec type of the local video stream. See VIDEO_CODEC_TYPE. The default value is VIDEO_CODEC_H264 (2).

◆ width

int agora::rtc::EncodedVideoFrameInfo::width

The width (px) of the video frame.

◆ height

int agora::rtc::EncodedVideoFrameInfo::height

The height (px) of the video frame.

◆ framesPerSecond

int agora::rtc::EncodedVideoFrameInfo::framesPerSecond

The number of video frames per second. When this parameter is not 0, you can use it to calculate the Unix timestamp of the external encoded video frames.

◆ frameType

VIDEO_FRAME_TYPE agora::rtc::EncodedVideoFrameInfo::frameType

The video frame type: VIDEO_FRAME_TYPE.

◆ rotation

VIDEO_ORIENTATION agora::rtc::EncodedVideoFrameInfo::rotation

The rotation information of the video frame: VIDEO_ORIENTATION.

◆ trackId

int agora::rtc::EncodedVideoFrameInfo::trackId

The track ID of the video frame.

◆ captureTimeMs

int64_t agora::rtc::EncodedVideoFrameInfo::captureTimeMs

This is a input parameter which means the timestamp for capturing the video.

◆ decodeTimeMs

int64_t agora::rtc::EncodedVideoFrameInfo::decodeTimeMs

The timestamp for decoding the video.

◆ uid

uid_t agora::rtc::EncodedVideoFrameInfo::uid

ID of the user that pushes the the external encoded video frame..

◆ streamType

VIDEO_STREAM_TYPE agora::rtc::EncodedVideoFrameInfo::streamType

The stream type of video frame.