Agora Server Gateway SDK C++ API Reference
|
Typedefs | |
typedef unsigned int | uid_t |
typedef unsigned int | track_id_t |
typedef unsigned int | conn_id_t |
Variables | |
const int | STANDARD_BITRATE = 0 |
const int | COMPATIBLE_BITRATE = -1 |
static const unsigned int | DEFAULT_CONNECTION_ID = 0 |
static const unsigned int | DUMMY_CONNECTION_ID = (std::numeric_limits<unsigned int>::max)() |
typedef unsigned int agora::rtc::conn_id_t |
typedef unsigned int agora::rtc::track_id_t |
typedef unsigned int agora::rtc::uid_t |
The audio profile.
Audio application scenarios.
Reasons for a connection state change.
Connection state types.
Video degradation preferences under limited bandwidth.
The reason for the poor Quality of Experience (QoE) of the local user when receiving a remote audio stream.
States of the last mile network probe result.
Reasons for the local audio failure.
States of the local audio.
Local video state error codes.
Local video state types.
The network type.
Video output orientation modes.
Quality change of the local video in terms of target frame rate and target bit rate since last count.
The network quality types.
Enumerator | |
---|---|
QUALITY_UNKNOWN | 0: The network quality is unknown.
|
QUALITY_EXCELLENT | 1: The quality is excellent. |
QUALITY_GOOD | 2: The quality is quite good, but the bitrate may be slightly lower than excellent. |
QUALITY_POOR | 3: Users can feel the communication slightly impaired. |
QUALITY_BAD | 4: Users cannot communicate smoothly. |
QUALITY_VBAD | 5: Users can barely communicate. |
QUALITY_DOWN | 6: Users cannot communicate at all. |
Remote audio states.
Reasons for a remote audio state change.
The downscale level of the remote video stream . The higher the downscale level, the more the video downscales.
The state of the remote video.
Enumerator | |
---|---|
REMOTE_VIDEO_STATE_STOPPED | 0: The remote video is in the default state, probably due to REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED (3), REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED (5), or REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE (7). |
REMOTE_VIDEO_STATE_STARTING | 1: The first remote video packet is received. |
REMOTE_VIDEO_STATE_DECODING | 2: The remote video stream is decoded and plays normally, probably due to REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY (2), REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED (4), REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED (6), or REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY (9). |
REMOTE_VIDEO_STATE_FROZEN | 3: The remote video is frozen, probably due to REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION (1) or REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK (8). |
REMOTE_VIDEO_STATE_FAILED | 4: The remote video fails to start, probably due to REMOTE_VIDEO_STATE_REASON_INTERNAL (0). |
The reason for the remote video state change.
Error codes of the CDN streaming.
The connection state between the SDK and CDN.
Enumerator | |
---|---|
STATE_DISCONNECTED | 1: The SDK is disconnected from the CDN. The SDK changes to this state after conducting the following operations:
|
STATE_CONNECTING | 2: The SDK is connecting to the CDN. The SDK changes to this state when calling connect to connect to the CDN. |
STATE_CONNECTED | 3: The SDK is connected to the CDN. The SDK changes to this state after the SDK calls connect and successfully connects to the CDN. You can start pushing streams to the CDN. |
STATE_RECONNECTING | 4: The SDK is reconnecting to the CDN. Under circumstances such as poor network conditions or when the user switches network types, if the SDK is disconnected from the CDN, the SDK tries to reconnect to the CDN and changes to this state. |
STATE_FAILED | 5: The SDK fails to connect to the CDN. The SDK changes to this state after conducting the following operations:
In this state, if you need to connect to the CDN, you must call disconnect first to disconnect from the CDN before you call |
STATE_RECONNECTED | 6: The SDK reconnects to the CDN. Under circumstances such as poor network conditions or when the user switches network types, if the SDK is disconnected from the CDN, the SDK changes to this state when it successfully reconnects to the CDN. You can continue pushing audio and video streams to the CDN. |
The mode in which the video stream is sent.
enum agora::rtc::TCcMode |
Reasons for a user being offline.
Types of the video frame.
The rotation information.
Video source types.
const int agora::rtc::COMPATIBLE_BITRATE = -1 |
-1: Compatible bitrate mode.
In this mode, the bitrate remains the same regardless of the channel profile. If you choose this mode in the live-broadcast profile, the video frame rate may be lower than the set value.
|
static |
|
static |
const int agora::rtc::STANDARD_BITRATE = 0 |
(Recommended) 0: Standard bitrate mode.
In this mode, the bitrates differ between the live broadcast and communication profiles: