Documentation
Video Call
Agora.io Community
English
search-icon
Agora C++ API Reference for All Platforms
Index IRtcEngine RtcEngineParameters IRtcEngineEventHandler Warning Codes Error Codes

#include <IAgoraRtcEngine.h>

Public Member Functions

 VideoEncoderConfiguration (const VideoDimensions &d, FRAME_RATE f, int b, ORIENTATION_MODE m)
 
 VideoEncoderConfiguration (int width, int height, FRAME_RATE f, int b, ORIENTATION_MODE m)
 
 VideoEncoderConfiguration ()
 

Public Attributes

VideoDimensions dimensions
 
FRAME_RATE frameRate
 
int bitrate
 
ORIENTATION_MODE orientationMode
 

Detailed Description

Properties of the video encoder configuration.

Constructor & Destructor Documentation

◆ VideoEncoderConfiguration() [1/3]

agora::rtc::VideoEncoderConfiguration::VideoEncoderConfiguration ( const VideoDimensions &  d,
FRAME_RATE  f,
int  b,
ORIENTATION_MODE  m 
)
inline

◆ VideoEncoderConfiguration() [2/3]

agora::rtc::VideoEncoderConfiguration::VideoEncoderConfiguration ( int  width,
int  height,
FRAME_RATE  f,
int  b,
ORIENTATION_MODE  m 
)
inline

◆ VideoEncoderConfiguration() [3/3]

agora::rtc::VideoEncoderConfiguration::VideoEncoderConfiguration ( )
inline

Member Data Documentation

◆ dimensions

VideoDimensions agora::rtc::VideoEncoderConfiguration::dimensions

The video frame dimension used to specify the video quality and measured by the total number of pixels along a frame's width and height: VideoDimensions.

◆ frameRate

FRAME_RATE agora::rtc::VideoEncoderConfiguration::frameRate

Frame rate of the video: FRAME_RATE.

◆ bitrate

int agora::rtc::VideoEncoderConfiguration::bitrate

Bitrate of the video.

Agora uses different video codecs for different profiles to optimize the user experience. For example, a communication profile prioritizes the smoothness while a live broadcast profile prioritizes the video quality (a higher bitrate). Therefore, Agora recommends setting this parameter as STANDARD_BITRATE.

Resolution Frame Rate (fps) Base Bitrate (Kbps, for Communication) Live Bitrate (Kbps, for Live Broadcast)
160 × 120 15 65 130
120 × 120 15 50 100
320 × 180 15 140 280
180 × 180 15 100 200
240 × 180 15 120 240
320 × 240 15 200 400
240 × 240 15 140 280
424 × 240 15 220 440
640 × 360 15 400 800
360 × 360 15 260 520
640 × 360 30 600 1200
360 × 360 30 400 800
480 × 360 15 320 640
480 × 360 30 490 980
640 × 480 15 500 1000

| 480 × 480 | 15 | 400 | 800 | | | 640 × 480 | 30 | 750 | 1500 | | 480 × 480 | 30 | 600 | 1200 | | 848 × 480 | 15 | 610 | 1220 | | 848 × 480 | 30 | 930 | 1860 | | 640 × 480 | 10 | 400 | 800 | | 1280 × 720 | 15 | 1130 | 2260 | | 1280 × 720 | 30 | 1710 | 3420 | | 960 × 720 | 15 | 910 | 1820 | | 960 × 720 | 30 | 1380 | 2760 | | 1920 × 1080 | 15 | 2080 | 4160 | | 1920 × 1080 | 30 | 3150 | 6300 | | 1920 × 1080 | 60 | 4780 | 6500 | | 2560 × 1440 | 30 | 4850 | 6500 | | 2560 × 1440 | 60 | 6500 | 6500 | | 3840 × 2160 | 30 | 6500 | 6500 | | 3840 × 2160 | 60 | 6500 | 6500 |

Note
The base bitrate in this table applies to a communication profile. A live broadcast profile generally requires a higher bitrate for better video quality. Agora recommends setting the bitrate mode as STANDARD_BITRATE. You can also set the bitrate as twice the base bitrate.

◆ orientationMode

ORIENTATION_MODE agora::rtc::VideoEncoderConfiguration::orientationMode

Video orientation mode of the video: ORIENTATION_MODE.