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

Public Member Functions

 VideoFormat ()
 
 VideoFormat (int w, int h, int f)
 
bool operator< (const VideoFormat &fmt) const
 
bool operator== (const VideoFormat &fmt) const
 
bool operator!= (const VideoFormat &fmt) const
 

Public Attributes

 OPTIONAL_ENUM_SIZE_T
 
int width
 
int height
 
int fps
 

Detailed Description

The format of the video frame.

Constructor & Destructor Documentation

◆ VideoFormat() [1/2]

agora::rtc::VideoFormat::VideoFormat ( )
inline

◆ VideoFormat() [2/2]

agora::rtc::VideoFormat::VideoFormat ( int  w,
int  h,
int  f 
)
inline

Member Function Documentation

◆ operator<()

bool agora::rtc::VideoFormat::operator< ( const VideoFormat fmt) const
inline

◆ operator==()

bool agora::rtc::VideoFormat::operator== ( const VideoFormat fmt) const
inline

◆ operator!=()

bool agora::rtc::VideoFormat::operator!= ( const VideoFormat fmt) const
inline

Member Data Documentation

◆ OPTIONAL_ENUM_SIZE_T

agora::rtc::VideoFormat::OPTIONAL_ENUM_SIZE_T
Initial value:
{
kMaxWidthInPixels = 3840,
kMaxHeightInPixels = 2160,
kMaxFps = 60,
}

◆ width

int agora::rtc::VideoFormat::width

The width (px) of the video.

◆ height

int agora::rtc::VideoFormat::height

The height (px) of the video.

◆ fps

int agora::rtc::VideoFormat::fps

The video frame rate (fps).