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

#include <NGIAgoraRtmpConnection.h>

Public Member Functions

 RtmpStreamingVideoConfiguration ()
 

Public Attributes

int width
 
int height
 
int framerate
 
int bitrate
 
int maxBitrate
 
int minBitrate
 
unsigned int gopInMs
 
int encoderHwSwMode
 
ORIENTATION_MODE orientationMode
 

Detailed Description

The video encoding configuration for the media push.

Constructor & Destructor Documentation

◆ RtmpStreamingVideoConfiguration()

agora::rtc::RtmpStreamingVideoConfiguration::RtmpStreamingVideoConfiguration ( )
inline

Member Data Documentation

◆ bitrate

int agora::rtc::RtmpStreamingVideoConfiguration::bitrate

The encoding bitrate (Kbps) of the video. The default value is 800.

◆ encoderHwSwMode

int agora::rtc::RtmpStreamingVideoConfiguration::encoderHwSwMode

Sets the video encoder as follows:

  • 0: The default encoder.
  • 1: Hardware encoder.
  • 2: Software encoder.

◆ framerate

int agora::rtc::RtmpStreamingVideoConfiguration::framerate

The frame rate (fps) of the video encoder. The default value is 15.

◆ gopInMs

unsigned int agora::rtc::RtmpStreamingVideoConfiguration::gopInMs

The time interval (ms) between two keyframes. The default value is 2,000.

◆ height

int agora::rtc::RtmpStreamingVideoConfiguration::height

The height (px) of the video. The default value is 360.

Note
The video size determined by this parameter and the width parameter does not affect the orientation mode of the video encoding. To set the orientation mode of the video encoding, see the orientationMode parameter.

◆ maxBitrate

int agora::rtc::RtmpStreamingVideoConfiguration::maxBitrate

Reserved for future use.

◆ minBitrate

int agora::rtc::RtmpStreamingVideoConfiguration::minBitrate

Reserved for future use.

◆ orientationMode

ORIENTATION_MODE agora::rtc::RtmpStreamingVideoConfiguration::orientationMode

The orientation mode of the video encoding. See ORIENTATION_MODE.

◆ width

int agora::rtc::RtmpStreamingVideoConfiguration::width

The width (px) of the video. The default value is 640.

Note
The video size determined by this parameter and the height parameter does not affect the orientation mode of the video encoding. To set the orientation mode of the video encoding, see the orientationMode parameter.

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