agora::rtc::VideoEncoderConfiguration Struct Reference

#include <AgoraBase.h>

Public Member Functions
	VideoEncoderConfiguration (const VideoDimensions &d, int f, int b, ORIENTATION_MODE m, VIDEO_MIRROR_MODE_TYPE mirror=VIDEO_MIRROR_MODE_DISABLED)
	VideoEncoderConfiguration (int width, int height, int f, int b, ORIENTATION_MODE m, VIDEO_MIRROR_MODE_TYPE mirror=VIDEO_MIRROR_MODE_DISABLED)
	VideoEncoderConfiguration (const VideoEncoderConfiguration &config)
	VideoEncoderConfiguration ()
VideoEncoderConfiguration &	operator= (const VideoEncoderConfiguration &rhs)

Public Attributes
VIDEO_CODEC_TYPE	codecType
VideoDimensions	dimensions
int	frameRate
int	bitrate
int	minBitrate
ORIENTATION_MODE	orientationMode
DEGRADATION_PREFERENCE	degradationPreference
VIDEO_MIRROR_MODE_TYPE	mirrorMode

Detailed Description

The definition of the VideoEncoderConfiguration struct.

Constructor & Destructor Documentation

VideoEncoderConfiguration() [1/4]

agora::rtc::VideoEncoderConfiguration::VideoEncoderConfiguration ( const VideoDimensions &  d, int  f, int  b, ORIENTATION_MODE  m, VIDEO_MIRROR_MODE_TYPE  mirror = VIDEO_MIRROR_MODE_DISABLED  )

inline

VideoEncoderConfiguration() [2/4]

agora::rtc::VideoEncoderConfiguration::VideoEncoderConfiguration ( int  width, int  height, int  f, int  b, ORIENTATION_MODE  m, VIDEO_MIRROR_MODE_TYPE  mirror = VIDEO_MIRROR_MODE_DISABLED  )

inline

VideoEncoderConfiguration() [3/4]

agora::rtc::VideoEncoderConfiguration::VideoEncoderConfiguration ( const VideoEncoderConfiguration &  config )

inline

VideoEncoderConfiguration() [4/4]

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

inline

Member Function Documentation

operator=()

VideoEncoderConfiguration & agora::rtc::VideoEncoderConfiguration::operator= ( const VideoEncoderConfiguration &  rhs )

inline

Member Data Documentation

bitrate

int agora::rtc::VideoEncoderConfiguration::bitrate

The bitrate (Kbps) of the video.

• STANDARD_BITRATE(0): (Recommended) Standard bitrate mode. In this mode, the bitrates differ between the Live Broadcast and Communication profiles:
  • In the Communication profile, the video bitrate is the same as the base bitrate.
  • In the Live Broadcast profile, the video bitrate is twice the base bitrate.
• COMPATIBLE_BITRATE(-1): Compatible bitrate mode. The compatible bitrate mode. In this mode, the bitrate stays the same regardless of the profile. If you choose this mode for the Live Broadcast profile, the video frame rate may be lower than the set value.

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

codecType

VIDEO_CODEC_TYPE agora::rtc::VideoEncoderConfiguration::codecType

The video encoder code type: VIDEO_CODEC_TYPE.

degradationPreference

DEGRADATION_PREFERENCE agora::rtc::VideoEncoderConfiguration::degradationPreference

The video degradation preference under limited bandwidth: DEGRADATION_PREFERENCE.

dimensions

VideoDimensions agora::rtc::VideoEncoderConfiguration::dimensions

The video dimension: VideoDimensions.

frameRate

int agora::rtc::VideoEncoderConfiguration::frameRate

The frame rate of the video. You can set it manually, or choose one from FRAME_RATE.

minBitrate

int agora::rtc::VideoEncoderConfiguration::minBitrate

The minimum encoding bitrate (Kbps).

The Agora SDK automatically adjusts the encoding bitrate to adapt to the network conditions.

Using a value greater than the default value forces the video encoder to output high-quality images but may cause more packet loss and hence sacrifice the smoothness of the video transmission. That said, unless you have special requirements for image quality, Agora does not recommend changing this value.

Note

This parameter applies to the live-broadcast profile only.

mirrorMode

VIDEO_MIRROR_MODE_TYPE agora::rtc::VideoEncoderConfiguration::mirrorMode

If mirror_type is set to VIDEO_MIRROR_MODE_ENABLED, then the video frame would be mirrored before encoding.

orientationMode

ORIENTATION_MODE agora::rtc::VideoEncoderConfiguration::orientationMode

The video orientation mode.

---

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

• AgoraBase.h