Agora C++ API Reference for All Platforms
|
Namespaces | |
base | |
capability | |
commons | |
extension | |
internal | |
media | |
rtc | |
rtm | |
util | |
utils | |
Classes | |
class | agora_refptr |
class | AtomicOps |
struct | in_place_t |
struct | nullopt_t |
class | Optional |
class | RefCountedObject |
class | RefCounter |
class | RefCountInterface |
struct | SpatialAudioParams |
struct | UserInfo |
Typedefs | |
typedef agora::commons::cjson::JsonWrapper | any_document_t |
typedef const char * | user_id_t |
typedef void * | view_t |
typedef util::AList< UserInfo > | UserList |
Functions | |
template<typename T , typename... types> | |
agora_refptr< T > | make_refptr (types &&... args) |
template<typename T > | |
agora_refptr< T > | make_refptr () |
template<typename T , typename P0 > | |
agora_refptr< T > | make_refptr (const P0 &p0) |
const nullopt_t | nullopt (0) |
Variables | |
const in_place_t | in_place = {} |
OPTIONAL_ENUM_CLASS | RefCountReleaseStatus { kDroppedLastRef, kOtherRefsRemained } |
typedef commons::cjson::JsonWrapper agora::any_document_t |
typedef const char* agora::user_id_t |
typedef void* agora::view_t |
typedef util::AList<UserInfo> agora::UserList |
The channel profile.
Enumerator | |
---|---|
CHANNEL_PROFILE_COMMUNICATION | 0: Communication. This profile prioritizes smoothness and applies to the one-to-one scenario. |
CHANNEL_PROFILE_LIVE_BROADCASTING | 1: (Default) Live Broadcast. This profile prioritizes supporting a large audience in a live broadcast channel. |
__deprecated | 2: Gaming.
3: Cloud Gaming.
4: Communication 1v1.
|
__deprecated | 2: Gaming.
3: Cloud Gaming.
4: Communication 1v1.
|
__deprecated | 2: Gaming.
3: Cloud Gaming.
4: Communication 1v1.
|
The warning codes.
The error codes.
Enumerator | |
---|---|
ERR_OK | 0: No error occurs. |
ERR_FAILED | 1: A general error occurs (no specified reason). |
ERR_INVALID_ARGUMENT | 2: The argument is invalid. For example, the specific channel name includes illegal characters. |
ERR_NOT_READY | 3: The SDK module is not ready. Choose one of the following solutions:
|
ERR_NOT_SUPPORTED | 4: The SDK does not support this function. |
ERR_REFUSED | 5: The request is rejected. |
ERR_BUFFER_TOO_SMALL | 6: The buffer size is not big enough to store the returned data. |
ERR_NOT_INITIALIZED | 7: The SDK is not initialized before calling this method. |
ERR_INVALID_STATE | 8: The state is invalid. |
ERR_NO_PERMISSION | 9: No permission. This is for internal use only, and does not return to the app through any method or callback. |
ERR_TIMEDOUT | 10: An API timeout occurs. Some API methods require the SDK to return the execution result, and this error occurs if the request takes too long (more than 10 seconds) for the SDK to process. |
ERR_CANCELED | 11: The request is cancelled. This is for internal use only, and does not return to the app through any method or callback. |
ERR_TOO_OFTEN | 12: The method is called too often. This is for internal use only, and does not return to the app through any method or callback. |
ERR_BIND_SOCKET | 13: The SDK fails to bind to the network socket. This is for internal use only, and does not return to the app through any method or callback. |
ERR_NET_DOWN | 14: The network is unavailable. This is for internal use only, and does not return to the app through any method or callback. |
ERR_JOIN_CHANNEL_REJECTED | 17: The request to join the channel is rejected. This error usually occurs when the user is already in the channel, and still calls the method to join the channel, for example, joinChannel(). |
ERR_LEAVE_CHANNEL_REJECTED | 18: The request to leave the channel is rejected. This error usually occurs when the user has already left the channel, and still calls the method to leave the channel, for example, leaveChannel. |
ERR_ALREADY_IN_USE | 19: The resources have been occupied and cannot be reused. |
ERR_ABORTED | 20: The SDK gives up the request due to too many requests. This is for internal use only, and does not return to the app through any method or callback. |
ERR_INIT_NET_ENGINE | 21: On Windows, specific firewall settings can cause the SDK to fail to initialize and crash. |
ERR_RESOURCE_LIMITED | 22: The app uses too much of the system resource and the SDK fails to allocate any resource. |
ERR_INVALID_APP_ID | 101: The App ID is invalid, usually because the data format of the App ID is incorrect. Solution: Check the data format of your App ID. Ensure that you use the correct App ID to initialize the Agora service. |
ERR_INVALID_CHANNEL_NAME | 102: The specified channel name is invalid. Please try to rejoin the channel with a valid channel name. |
ERR_NO_SERVER_RESOURCES | 103: Fails to get server resources in the specified region. Please try to specify another region when calling initialize. |
ERR_TOKEN_EXPIRED | 109: The token has expired, usually for the following reasons:
Solution: Regardless of whether token authorization times out or the token privilege expires, you need to generate a new token on your server, and try to join the channel. |
ERR_INVALID_TOKEN | 110: The token is invalid, usually for one of the following reasons:
Solution:
|
ERR_CONNECTION_INTERRUPTED | 111: The internet connection is interrupted. This applies to the Agora Web SDK only. |
ERR_CONNECTION_LOST | 112: The internet connection is lost. This applies to the Agora Web SDK only. |
ERR_NOT_IN_CHANNEL | 113: The user is not in the channel when calling the sendStreamMessage() method. |
ERR_SIZE_TOO_LARGE | 114: The data size is over 1024 bytes when the user calls the sendStreamMessage() method. |
ERR_BITRATE_LIMIT | 115: The bitrate of the sent data exceeds the limit of 6 Kbps when the user calls the sendStreamMessage(). |
ERR_TOO_MANY_DATA_STREAMS | 116: Too many data streams (over 5) are created when the user calls the createDataStream() method. |
ERR_STREAM_MESSAGE_TIMEOUT | 117: A timeout occurs for the data stream transmission. |
ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED | 119: Switching the user role fails. Please try to rejoin the channel. |
ERR_DECRYPTION_FAILED | 120: Decryption fails. The user may have tried to join the channel with a wrong password. Check your settings or try rejoining the channel. |
ERR_INVALID_USER_ID | 121: The user ID is invalid. |
ERR_CLIENT_IS_BANNED_BY_SERVER | 123: The app is banned by the server. |
ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH | 130: Encryption is enabled when the user calls the addPublishStreamUrl() method (CDN live streaming does not support encrypted streams). |
ERR_LICENSE_CREDENTIAL_INVALID | 131: License credential is invalid |
ERR_INVALID_USER_ACCOUNT | 134: The user account is invalid, usually because the data format of the user account is incorrect. |
ERR_MODULE_NOT_FOUND | 157: The necessary dynamical library is not integrated. For example, if you call the enableDeepLearningDenoise but do not integrate the dynamical library for the deep-learning noise reduction into your project, the SDK reports this error code. |
ERR_CERT_RAW | |
ERR_CERT_JSON_PART | |
ERR_CERT_JSON_INVAL | |
ERR_CERT_JSON_NOMEM | |
ERR_CERT_CUSTOM | |
ERR_CERT_CREDENTIAL | |
ERR_CERT_SIGN | |
ERR_CERT_FAIL | |
ERR_CERT_BUF | |
ERR_CERT_NULL | |
ERR_CERT_DUEDATE | |
ERR_CERT_REQUEST | |
ERR_PCMSEND_FORMAT | |
ERR_PCMSEND_BUFFEROVERFLOW | |
ERR_LOAD_MEDIA_ENGINE | 1001: Fails to load the media engine. |
ERR_ADM_GENERAL_ERROR | 1005: Audio device module: A general error occurs in the Audio Device Module (no specified reason). Check if the audio device is used by another app, or try rejoining the channel. |
ERR_ADM_INIT_PLAYOUT | 1008: Audio Device Module: An error occurs in initializing the playback device. |
ERR_ADM_START_PLAYOUT | 1009: Audio Device Module: An error occurs in starting the playback device. |
ERR_ADM_STOP_PLAYOUT | 1010: Audio Device Module: An error occurs in stopping the playback device. |
ERR_ADM_INIT_RECORDING | 1011: Audio Device Module: An error occurs in initializing the recording device. |
ERR_ADM_START_RECORDING | 1012: Audio Device Module: An error occurs in starting the recording device. |
ERR_ADM_STOP_RECORDING | 1013: Audio Device Module: An error occurs in stopping the recording device. |
ERR_VDM_CAMERA_NOT_AUTHORIZED | 1501: Video Device Module: The camera is not authorized. |
The operational permission of the SDK on the audio session.
|
inline |
|
inline |
|
inline |
const nullopt_t agora::nullopt | ( | 0 | ) |
const in_place_t agora::in_place = {} |
OPTIONAL_ENUM_CLASS agora::RefCountReleaseStatus { kDroppedLastRef, kOtherRefsRemained } |