diff --git a/cpp/android/include/AgoraBase.h b/cpp/android/include/AgoraBase.h index ecb0c5a..0ec0450 100644 --- a/cpp/android/include/AgoraBase.h +++ b/cpp/android/include/AgoraBase.h @@ -13,7 +13,9 @@ #include #if defined(_WIN32) +#ifndef WIN32_LEAN_AND_MEAN #define WIN32_LEAN_AND_MEAN +#endif #include #define AGORA_CALL __cdecl #if defined(AGORARTC_EXPORT) @@ -41,715 +43,748 @@ namespace agora { namespace util { -template +template class AutoPtr { - typedef T value_type; - typedef T* pointer_type; -public: - AutoPtr(pointer_type p=0) - :ptr_(p) - {} - ~AutoPtr() { - if (ptr_) - ptr_->release(); - } - operator bool() const { return ptr_ != (pointer_type)0; } - value_type& operator*() const { - return *get(); - } - - pointer_type operator->() const { - return get(); - } - - pointer_type get() const { - return ptr_; + typedef T value_type; + typedef T* pointer_type; + + public: + AutoPtr(pointer_type p = 0) : ptr_(p) {} + ~AutoPtr() { + if (ptr_) ptr_->release(); + } + operator bool() const { return ptr_ != (pointer_type)0; } + value_type& operator*() const { return *get(); } + + pointer_type operator->() const { return get(); } + + pointer_type get() const { return ptr_; } + + pointer_type release() { + pointer_type tmp = ptr_; + ptr_ = 0; + return tmp; + } + + void reset(pointer_type ptr = 0) { + if (ptr != ptr_ && ptr_) ptr_->release(); + ptr_ = ptr; + } + template + bool queryInterface(C1* c, C2 iid) { + pointer_type p = NULL; + if (c && !c->queryInterface(iid, (void**)&p)) { + reset(p); } + return p != NULL; + } - pointer_type release() { - pointer_type tmp = ptr_; - ptr_ = 0; - return tmp; - } + private: + AutoPtr(const AutoPtr&); + AutoPtr& operator=(const AutoPtr&); - void reset(pointer_type ptr = 0) { - if (ptr != ptr_ && ptr_) - ptr_->release(); - ptr_ = ptr; - } - template - bool queryInterface(C1* c, C2 iid) { - pointer_type p = NULL; - if (c && !c->queryInterface(iid, (void**)&p)) - { - reset(p); - } - return p != NULL; - } -private: - AutoPtr(const AutoPtr&); - AutoPtr& operator=(const AutoPtr&); -private: - pointer_type ptr_; + private: + pointer_type ptr_; }; class IString { -protected: - virtual ~IString(){} -public: - virtual bool empty() const = 0; - virtual const char* c_str() = 0; - virtual const char* data() = 0; - virtual size_t length() = 0; - virtual void release() = 0; + protected: + virtual ~IString() {} + + public: + virtual bool empty() const = 0; + virtual const char* c_str() = 0; + virtual const char* data() = 0; + virtual size_t length() = 0; + virtual void release() = 0; }; typedef AutoPtr AString; -}//namespace util +} // namespace util -enum INTERFACE_ID_TYPE -{ - AGORA_IID_AUDIO_DEVICE_MANAGER = 1, - AGORA_IID_VIDEO_DEVICE_MANAGER = 2, - AGORA_IID_RTC_ENGINE_PARAMETER = 3, - AGORA_IID_MEDIA_ENGINE = 4, - AGORA_IID_SIGNALING_ENGINE = 8, +enum INTERFACE_ID_TYPE { + AGORA_IID_AUDIO_DEVICE_MANAGER = 1, + AGORA_IID_VIDEO_DEVICE_MANAGER = 2, + AGORA_IID_RTC_ENGINE_PARAMETER = 3, + AGORA_IID_MEDIA_ENGINE = 4, + AGORA_IID_SIGNALING_ENGINE = 8, }; - /** Warning code. - */ -enum WARN_CODE_TYPE -{ +/** Warning code. + */ +enum WARN_CODE_TYPE { /** 8: The specified view is invalid. Specify a view when using the video call function. + */ + WARN_INVALID_VIEW = 8, + /** 16: Failed to initialize the video function, possibly caused by a lack of resources. The users cannot see the video while the voice communication is not affected. + */ + WARN_INIT_VIDEO = 16, + /** 20: The request is pending, usually due to some module not being ready, and the SDK postponed processing the request. + */ + WARN_PENDING = 20, + /** 103: No channel resources are available. Maybe because the server cannot allocate any channel resource. + */ + WARN_NO_AVAILABLE_CHANNEL = 103, + /** 104: A timeout occurs when looking up the channel. When joining a channel, the SDK looks up the specified channel. This warning usually occurs when the network condition is too poor for the SDK to connect to the server. + */ + WARN_LOOKUP_CHANNEL_TIMEOUT = 104, + /** **DEPRECATED** 105: The server rejects the request to look up the channel. The server cannot process this request or the request is illegal. + + Deprecated as of v2.4.1. Use CONNECTION_CHANGED_REJECTED_BY_SERVER(10) in the \ref agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged" callback instead. */ - WARN_INVALID_VIEW = 8, - /** 16: Failed to initialize the video function, possibly caused by a lack of resources. The users cannot see the video while the voice communication is not affected. - */ - WARN_INIT_VIDEO = 16, - /** 20: The request is pending, usually due to some module not being ready, and the SDK postponed processing the request. - */ - WARN_PENDING = 20, - /** 103: No channel resources are available. Maybe because the server cannot allocate any channel resource. - */ - WARN_NO_AVAILABLE_CHANNEL = 103, - /** 104: A timeout occurs when looking up the channel. When joining a channel, the SDK looks up the specified channel. This warning usually occurs when the network condition is too poor for the SDK to connect to the server. - */ - WARN_LOOKUP_CHANNEL_TIMEOUT = 104, - /** **DEPRECATED** 105: The server rejects the request to look up the channel. The server cannot process this request or the request is illegal. - - Deprecated as of v2.4.1. Use CONNECTION_CHANGED_REJECTED_BY_SERVER(10) in the \ref agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged" callback instead. - */ - WARN_LOOKUP_CHANNEL_REJECTED = 105, - /** 106: A timeout occurs when opening the channel. Once the specific channel is found, the SDK opens the channel. This warning usually occurs when the network condition is too poor for the SDK to connect to the server. - */ - WARN_OPEN_CHANNEL_TIMEOUT = 106, - /** 107: The server rejects the request to open the channel. The server cannot process this request or the request is illegal. - */ - WARN_OPEN_CHANNEL_REJECTED = 107, - - // sdk: 100~1000 - /** 111: A timeout occurs when switching to the live video. - */ - WARN_SWITCH_LIVE_VIDEO_TIMEOUT = 111, - /** 118: A timeout occurs when setting the client role in the live interactive streaming profile. - */ - WARN_SET_CLIENT_ROLE_TIMEOUT = 118, - /** 121: The ticket to open the channel is invalid. - */ - WARN_OPEN_CHANNEL_INVALID_TICKET = 121, - /** 122: Try connecting to another server. - */ - WARN_OPEN_CHANNEL_TRY_NEXT_VOS = 122, - /** 131: The channel connection cannot be recovered. - */ - WARN_CHANNEL_CONNECTION_UNRECOVERABLE = 131, - /** 132: The IP address has changed. - */ - WARN_CHANNEL_CONNECTION_IP_CHANGED = 132, - /** 133: The port has changed. - */ - WARN_CHANNEL_CONNECTION_PORT_CHANGED = 133, - /** 134: The socket error occurs, try to rejoin channel. - */ - WARN_CHANNEL_SOCKET_ERROR = 134, - /** 701: An error occurs in opening the audio mixing file. - */ - WARN_AUDIO_MIXING_OPEN_ERROR = 701, - /** 1014: Audio Device Module: A warning occurs in the playback device. - */ - WARN_ADM_RUNTIME_PLAYOUT_WARNING = 1014, - /** 1016: Audio Device Module: a warning occurs in the recording device. - */ - WARN_ADM_RUNTIME_RECORDING_WARNING = 1016, - /** 1019: Audio Device Module: no valid audio data is recorded. - */ - WARN_ADM_RECORD_AUDIO_SILENCE = 1019, - /** 1020: Audio device module: The audio playback frequency is abnormal, which may cause audio freezes. This abnormality is caused by high CPU usage. Agora recommends stopping other apps. - */ - WARN_ADM_PLAYOUT_MALFUNCTION = 1020, - /** 1021: Audio device module: the audio recording frequency is abnormal, which may cause audio freezes. This abnormality is caused by high CPU usage. Agora recommends stopping other apps. - */ - WARN_ADM_RECORD_MALFUNCTION = 1021, - /** 1025: The audio playback or recording is interrupted by system events (such as a phone call). - */ - WARN_ADM_CALL_INTERRUPTION = 1025, - /** 1029: During a call, the audio session category should be set to - * AVAudioSessionCategoryPlayAndRecord, and RtcEngine monitors this value. - * If the audio session category is set to other values, this warning code - * is triggered and RtcEngine will forcefully set it back to - * AVAudioSessionCategoryPlayAndRecord. - */ - WARN_ADM_IOS_CATEGORY_NOT_PLAYANDRECORD = 1029, - /** 1031: Audio Device Module: The recorded audio voice is too low. - */ - WARN_ADM_RECORD_AUDIO_LOWLEVEL = 1031, - /** 1032: Audio Device Module: The playback audio voice is too low. - */ - WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL = 1032, - /** 1033: Audio device module: The audio recording device is occupied. - */ - WARN_ADM_RECORD_AUDIO_IS_ACTIVE = 1033, - /** 1040: Audio device module: An exception occurs with the audio drive. - * Solutions: - * - Disable or re-enable the audio device. - * - Re-enable your device. - * - Update the sound card drive. - */ - WARN_ADM_WINDOWS_NO_DATA_READY_EVENT = 1040, - /** 1042: Audio device module: The audio recording device is different from the audio playback device, - * which may cause echoes problem. Agora recommends using the same audio device to record and playback - * audio. - */ - WARN_ADM_INCONSISTENT_AUDIO_DEVICE = 1042, - /** 1051: (Communication profile only) Audio processing module: A howling sound is detected when recording the audio data. - */ - WARN_APM_HOWLING = 1051, - /** 1052: Audio Device Module: The device is in the glitch state. - */ - WARN_ADM_GLITCH_STATE = 1052, - /** 1053: Audio Processing Module: A residual echo is detected, which may be caused by the belated scheduling of system threads or the signal overflow. - */ - WARN_APM_RESIDUAL_ECHO = 1053, - /// @cond - WARN_ADM_WIN_CORE_NO_RECORDING_DEVICE = 1322, - /// @endcond - /** 1323: Audio device module: No available playback device. - * Solution: Plug in the audio device. - */ - WARN_ADM_WIN_CORE_NO_PLAYOUT_DEVICE = 1323, - /** Audio device module: The capture device is released improperly. - * Solutions: - * - Disable or re-enable the audio device. - * - Re-enable your device. - * - Update the sound card drive. - */ - WARN_ADM_WIN_CORE_IMPROPER_CAPTURE_RELEASE = 1324, - /** 1610: The origin resolution of the remote video is beyond the range where the super-resolution algorithm can be applied. - */ - WARN_SUPER_RESOLUTION_STREAM_OVER_LIMITATION = 1610, - /** 1611: Another user is already using the super-resolution algorithm. - */ - WARN_SUPER_RESOLUTION_USER_COUNT_OVER_LIMITATION = 1611, - /** 1612: The device does not support the super-resolution algorithm. - */ - WARN_SUPER_RESOLUTION_DEVICE_NOT_SUPPORTED = 1612, - /// @cond - WARN_RTM_LOGIN_TIMEOUT = 2005, - WARN_RTM_KEEP_ALIVE_TIMEOUT = 2009 - /// @endcond + WARN_LOOKUP_CHANNEL_REJECTED = 105, + /** 106: A timeout occurs when opening the channel. Once the specific channel is found, the SDK opens the channel. This warning usually occurs when the network condition is too poor for the SDK to connect to the server. + */ + WARN_OPEN_CHANNEL_TIMEOUT = 106, + /** 107: The server rejects the request to open the channel. The server cannot process this request or the request is illegal. + */ + WARN_OPEN_CHANNEL_REJECTED = 107, + + // sdk: 100~1000 + /** 111: A timeout occurs when switching to the live video. + */ + WARN_SWITCH_LIVE_VIDEO_TIMEOUT = 111, + /** 118: A timeout occurs when setting the client role in the interactive live streaming profile. + */ + WARN_SET_CLIENT_ROLE_TIMEOUT = 118, + /** 121: The ticket to open the channel is invalid. + */ + WARN_OPEN_CHANNEL_INVALID_TICKET = 121, + /** 122: Try connecting to another server. + */ + WARN_OPEN_CHANNEL_TRY_NEXT_VOS = 122, + /** 131: The channel connection cannot be recovered. + */ + WARN_CHANNEL_CONNECTION_UNRECOVERABLE = 131, + /** 132: The IP address has changed. + */ + WARN_CHANNEL_CONNECTION_IP_CHANGED = 132, + /** 133: The port has changed. + */ + WARN_CHANNEL_CONNECTION_PORT_CHANGED = 133, + /** 134: The socket error occurs, try to rejoin channel. + */ + WARN_CHANNEL_SOCKET_ERROR = 134, + /** 701: An error occurs in opening the audio mixing file. + */ + WARN_AUDIO_MIXING_OPEN_ERROR = 701, + /** 1014: Audio Device Module: A warning occurs in the playback device. + */ + WARN_ADM_RUNTIME_PLAYOUT_WARNING = 1014, + /** 1016: Audio Device Module: A warning occurs in the audio capturing device. + */ + WARN_ADM_RUNTIME_RECORDING_WARNING = 1016, + /** 1019: Audio Device Module: No valid audio data is captured. + */ + WARN_ADM_RECORD_AUDIO_SILENCE = 1019, + /** 1020: Audio device module: The audio playback frequency is abnormal, which may cause audio freezes. This abnormality is caused by high CPU usage. Agora recommends stopping other apps. + */ + WARN_ADM_PLAYOUT_MALFUNCTION = 1020, + /** 1021: Audio device module: the audio capturing frequency is abnormal, which may cause audio freezes. This abnormality is caused by high CPU usage. Agora recommends stopping other apps. + */ + WARN_ADM_RECORD_MALFUNCTION = 1021, + /** 1025: The audio playback or capturing is interrupted by system events (such as a phone call). + */ + WARN_ADM_CALL_INTERRUPTION = 1025, + /** 1029: During a call, the audio session category should be set to + * AVAudioSessionCategoryPlayAndRecord, and RtcEngine monitors this value. + * If the audio session category is set to other values, this warning code + * is triggered and RtcEngine will forcefully set it back to + * AVAudioSessionCategoryPlayAndRecord. + */ + WARN_ADM_IOS_CATEGORY_NOT_PLAYANDRECORD = 1029, + /** 1031: Audio Device Module: The captured audio voice is too low. + */ + WARN_ADM_RECORD_AUDIO_LOWLEVEL = 1031, + /** 1032: Audio Device Module: The playback audio voice is too low. + */ + WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL = 1032, + /** 1033: Audio device module: The audio capturing device is occupied. + */ + WARN_ADM_RECORD_AUDIO_IS_ACTIVE = 1033, + /** 1040: Audio device module: An exception occurs with the audio drive. + * Solutions: + * - Disable or re-enable the audio device. + * - Re-enable your device. + * - Update the sound card drive. + */ + WARN_ADM_WINDOWS_NO_DATA_READY_EVENT = 1040, + /** 1042: Audio device module: The audio capturing device is different from the audio playback device, + * which may cause echoes problem. Agora recommends using the same audio device to capture and playback + * audio. + */ + WARN_ADM_INCONSISTENT_AUDIO_DEVICE = 1042, + /** 1051: (Communication profile only) Audio processing module: A howling sound is detected when capturing the audio data. + */ + WARN_APM_HOWLING = 1051, + /** 1052: Audio Device Module: The device is in the glitch state. + */ + WARN_ADM_GLITCH_STATE = 1052, + /** 1053: Audio Processing Module: A residual echo is detected, which may be caused by the belated scheduling of system threads or the signal overflow. + */ + WARN_APM_RESIDUAL_ECHO = 1053, + /// @cond + WARN_ADM_WIN_CORE_NO_RECORDING_DEVICE = 1322, + /// @endcond + /** 1323: Audio device module: No available playback device. + * Solution: Plug in the audio device. + */ + WARN_ADM_WIN_CORE_NO_PLAYOUT_DEVICE = 1323, + /** Audio device module: The capture device is released improperly. + * Solutions: + * - Disable or re-enable the audio device. + * - Re-enable your device. + * - Update the sound card drive. + */ + WARN_ADM_WIN_CORE_IMPROPER_CAPTURE_RELEASE = 1324, + /** 1610: The origin resolution of the remote video is beyond the range where the super-resolution algorithm can be applied. + */ + WARN_SUPER_RESOLUTION_STREAM_OVER_LIMITATION = 1610, + /** 1611: Another user is already using the super-resolution algorithm. + */ + WARN_SUPER_RESOLUTION_USER_COUNT_OVER_LIMITATION = 1611, + /** 1612: The device does not support the super-resolution algorithm. + */ + WARN_SUPER_RESOLUTION_DEVICE_NOT_SUPPORTED = 1612, + /// @cond + WARN_RTM_LOGIN_TIMEOUT = 2005, + WARN_RTM_KEEP_ALIVE_TIMEOUT = 2009 + /// @endcond }; /** Error code. -*/ -enum ERROR_CODE_TYPE -{ + */ +enum ERROR_CODE_TYPE { /** 0: No error occurs. - */ - ERR_OK = 0, - //1~1000 - /** 1: A general error occurs (no specified reason). - */ - ERR_FAILED = 1, - /** 2: An invalid parameter is used. For example, the specific channel name includes illegal characters. - */ - ERR_INVALID_ARGUMENT = 2, - /** 3: The SDK module is not ready. Possible solutions: - - - Check the audio device. - - Check the completeness of the application. - - Re-initialize the RTC engine. - */ - ERR_NOT_READY = 3, - /** 4: The SDK does not support this function. - */ - ERR_NOT_SUPPORTED = 4, - /** 5: The request is rejected. - */ - ERR_REFUSED = 5, - /** 6: The buffer size is not big enough to store the returned data. - */ - ERR_BUFFER_TOO_SMALL = 6, - /** 7: The SDK is not initialized before calling this method. - */ - ERR_NOT_INITIALIZED = 7, - /** 9: No permission exists. Check if the user has granted access to the audio or video device. - */ - ERR_NO_PERMISSION = 9, - /** 10: An API method 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_TIMEDOUT = 10, - /** 11: The request is canceled. This is for internal SDK use only, and it does not return to the application through any method or callback. - */ - ERR_CANCELED = 11, - /** 12: The method is called too often. This is for internal SDK use only, and it does not return to the application through any method or callback. - */ - ERR_TOO_OFTEN = 12, - /** 13: The SDK fails to bind to the network socket. This is for internal SDK use only, and it does not return to the application through any method or callback. - */ - ERR_BIND_SOCKET = 13, - /** 14: The network is unavailable. This is for internal SDK use only, and it does not return to the application through any method or callback. - */ - ERR_NET_DOWN = 14, - /** 15: No network buffers are available. This is for internal SDK internal use only, and it does not return to the application through any method or callback. - */ - ERR_NET_NOBUFS = 15, - /** 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, \ref agora::rtc::IRtcEngine::joinChannel "joinChannel". - * - This error usually occurs when the user tries to join a channel - * during \ref agora::rtc::IRtcEngine::startEchoTest "startEchoTest". Once you - * call \ref agora::rtc::IRtcEngine::startEchoTest "startEchoTest", you need to - * call \ref agora::rtc::IRtcEngine::stopEchoTest "stopEchoTest" before joining a channel. - * - The user tries to join the channel with a token that is expired. - */ - ERR_JOIN_CHANNEL_REJECTED = 17, - /** 18: The request to leave the channel is rejected. - - This error usually occurs: - - - When the user has left the channel and still calls \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" to leave the channel. In this case, stop calling \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel". - - When the user has not joined the channel and still calls \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" to leave the channel. In this case, no extra operation is needed. - */ - ERR_LEAVE_CHANNEL_REJECTED = 18, - /** 19: Resources are occupied and cannot be reused. - */ - ERR_ALREADY_IN_USE = 19, - /** 20: The SDK gives up the request due to too many requests. - */ - ERR_ABORTED = 20, - /** 21: In Windows, specific firewall settings can cause the SDK to fail to initialize and crash. - */ - ERR_INIT_NET_ENGINE = 21, - /** 22: The application uses too much of the system resources and the SDK fails to allocate the resources. - */ - ERR_RESOURCE_LIMITED = 22, - /** 101: The specified App ID is invalid. Please try to rejoin the channel with a valid App ID. - */ - ERR_INVALID_APP_ID = 101, - /** 102: The specified channel name is invalid. Please try to rejoin the channel with a valid channel name. - */ - ERR_INVALID_CHANNEL_NAME = 102, - /** 103: Fails to get server resources in the specified region. Please try to specify another region when calling \ref agora::rtc::IRtcEngine::initialize "initialize". - */ - ERR_NO_SERVER_RESOURCES = 103, - /** **DEPRECATED** 109: Deprecated as of v2.4.1. Use CONNECTION_CHANGED_TOKEN_EXPIRED(9) in the \ref agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged" callback instead. - - The token expired due to one of the following reasons: - - - Authorized Timestamp expired: The timestamp is represented by the number of seconds elapsed since 1/1/1970. The user can use the Token to access the Agora service within 24 hours after the Token is generated. If the user does not access the Agora service after 24 hours, this Token is no longer valid. - - Call Expiration Timestamp expired: The timestamp is the exact time when a user can no longer use the Agora service (for example, when a user is forced to leave an ongoing call). When a value is set for the Call Expiration Timestamp, it does not mean that the token will expire, but that the user will be banned from the channel. - */ - ERR_TOKEN_EXPIRED = 109, - /** **DEPRECATED** 110: Deprecated as of v2.4.1. Use CONNECTION_CHANGED_INVALID_TOKEN(8) in the \ref agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged" callback instead. - - The token is invalid due to one of the following reasons: - - - The App Certificate for the project is enabled in Console, but the user is still using the App ID. Once the App Certificate is enabled, the user must use a token. - - The uid is mandatory, and users must set the same uid as the one set in the \ref agora::rtc::IRtcEngine::joinChannel "joinChannel" method. - */ - ERR_INVALID_TOKEN = 110, - /** 111: The internet connection is interrupted. This applies to the Agora Web SDK only. - */ - ERR_CONNECTION_INTERRUPTED = 111, // only used in web sdk - /** 112: The internet connection is lost. This applies to the Agora Web SDK only. - */ - ERR_CONNECTION_LOST = 112, // only used in web sdk - /** 113: The user is not in the channel when calling the method. - */ - ERR_NOT_IN_CHANNEL = 113, - /** 114: The size of the sent data is over 1024 bytes when the user calls the \ref agora::rtc::IRtcEngine::sendStreamMessage "sendStreamMessage" method. - */ - ERR_SIZE_TOO_LARGE = 114, - /** 115: The bitrate of the sent data exceeds the limit of 6 Kbps when the user calls the \ref agora::rtc::IRtcEngine::sendStreamMessage "sendStreamMessage" method. - */ - ERR_BITRATE_LIMIT = 115, - /** 116: Too many data streams (over 5 streams) are created when the user calls the \ref agora::rtc::IRtcEngine::createDataStream "createDataStream" method. - */ - ERR_TOO_MANY_DATA_STREAMS = 116, - /** 117: The data stream transmission timed out. - */ - ERR_STREAM_MESSAGE_TIMEOUT = 117, - /** 119: Switching roles fail. Please try to rejoin the channel. - */ - ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED = 119, - /** 120: Decryption fails. The user may have used a different encryption password to join the channel. Check your settings or try rejoining the channel. - */ - ERR_DECRYPTION_FAILED = 120, - /** 123: The user is banned by the server. This error occurs when the user is kicked off the channel from the server. - */ - ERR_CLIENT_IS_BANNED_BY_SERVER = 123, - /** 124: Incorrect watermark file parameter. - */ - ERR_WATERMARK_PARAM = 124, - /** 125: Incorrect watermark file path. - */ - ERR_WATERMARK_PATH = 125, - /** 126: Incorrect watermark file format. - */ - ERR_WATERMARK_PNG = 126, - /** 127: Incorrect watermark file information. - */ - ERR_WATERMARKR_INFO = 127, - /** 128: Incorrect watermark file data format. - */ - ERR_WATERMARK_ARGB = 128, - /** 129: An error occurs in reading the watermark file. - */ - ERR_WATERMARK_READ = 129, - /** 130: Encryption is enabled when the user calls the \ref agora::rtc::IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" method (CDN live streaming does not support encrypted streams). - */ - ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH = 130, - /** 134: The user account is invalid. */ - ERR_INVALID_USER_ACCOUNT = 134, - - /** 151: CDN related errors. Remove the original URL address and add a new one by calling the \ref agora::rtc::IRtcEngine::removePublishStreamUrl "removePublishStreamUrl" and \ref agora::rtc::IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" methods. - */ - ERR_PUBLISH_STREAM_CDN_ERROR = 151, - /** 152: The host publishes more than 10 URLs. Delete the unnecessary URLs before adding new ones. - */ - ERR_PUBLISH_STREAM_NUM_REACH_LIMIT = 152, - /** 153: The host manipulates other hosts' URLs. Check your app logic. - */ - ERR_PUBLISH_STREAM_NOT_AUTHORIZED = 153, - /** 154: An error occurs in Agora's streaming server. Call the addPublishStreamUrl method to publish the streaming again. - */ - ERR_PUBLISH_STREAM_INTERNAL_SERVER_ERROR = 154, - /** 155: The server fails to find the stream. - */ - ERR_PUBLISH_STREAM_NOT_FOUND = 155, - /** 156: The format of the RTMP stream URL is not supported. Check whether the URL format is correct. - */ - ERR_PUBLISH_STREAM_FORMAT_NOT_SUPPORTED = 156, - - //signaling: 400~600 - ERR_LOGOUT_OTHER = 400, // - ERR_LOGOUT_USER = 401, // logout by user - ERR_LOGOUT_NET = 402, // network failure - ERR_LOGOUT_KICKED = 403, // login in other device - ERR_LOGOUT_PACKET = 404, // - ERR_LOGOUT_TOKEN_EXPIRED = 405, // token expired - ERR_LOGOUT_OLDVERSION = 406, // - ERR_LOGOUT_TOKEN_WRONG = 407, - ERR_LOGOUT_ALREADY_LOGOUT = 408, - ERR_LOGIN_OTHER = 420, - ERR_LOGIN_NET = 421, - ERR_LOGIN_FAILED = 422, - ERR_LOGIN_CANCELED = 423, - ERR_LOGIN_TOKEN_EXPIRED = 424, - ERR_LOGIN_OLD_VERSION = 425, - ERR_LOGIN_TOKEN_WRONG = 426, - ERR_LOGIN_TOKEN_KICKED = 427, - ERR_LOGIN_ALREADY_LOGIN = 428, - ERR_JOIN_CHANNEL_OTHER = 440, - ERR_SEND_MESSAGE_OTHER = 440, - ERR_SEND_MESSAGE_TIMEOUT = 441, - ERR_QUERY_USERNUM_OTHER = 450, - ERR_QUERY_USERNUM_TIMEOUT = 451, - ERR_QUERY_USERNUM_BYUSER = 452, - ERR_LEAVE_CHANNEL_OTHER = 460, - ERR_LEAVE_CHANNEL_KICKED = 461, - ERR_LEAVE_CHANNEL_BYUSER = 462, - ERR_LEAVE_CHANNEL_LOGOUT = 463, - ERR_LEAVE_CHANNEL_DISCONNECTED = 464, - ERR_INVITE_OTHER = 470, - ERR_INVITE_REINVITE = 471, - ERR_INVITE_NET = 472, - ERR_INVITE_PEER_OFFLINE = 473, - ERR_INVITE_TIMEOUT = 474, - ERR_INVITE_CANT_RECV = 475, - - - //1001~2000 - /** 1001: Fails to load the media engine. - */ - ERR_LOAD_MEDIA_ENGINE = 1001, - /** 1002: Fails to start the call after enabling the media engine. - */ - ERR_START_CALL = 1002, - /** **DEPRECATED** 1003: Fails to start the camera. - - Deprecated as of v2.4.1. Use LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE(4) in the \ref agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged" callback instead. - */ - ERR_START_CAMERA = 1003, - /** 1004: Fails to start the video rendering module. - */ - ERR_START_VIDEO_RENDER = 1004, - /** 1005: A general error occurs in the Audio Device Module (no specified reason). Check if the audio device is used by another application, or try rejoining the channel. - */ - ERR_ADM_GENERAL_ERROR = 1005, - /** 1006: Audio Device Module: An error occurs in using the Java resources. - */ - ERR_ADM_JAVA_RESOURCE = 1006, - /** 1007: Audio Device Module: An error occurs in setting the sampling frequency. - */ - ERR_ADM_SAMPLE_RATE = 1007, - /** 1008: Audio Device Module: An error occurs in initializing the playback device. - */ - ERR_ADM_INIT_PLAYOUT = 1008, - /** 1009: Audio Device Module: An error occurs in starting the playback device. - */ - ERR_ADM_START_PLAYOUT = 1009, - /** 1010: Audio Device Module: An error occurs in stopping the playback device. - */ - ERR_ADM_STOP_PLAYOUT = 1010, - /** 1011: Audio Device Module: An error occurs in initializing the recording device. - */ - ERR_ADM_INIT_RECORDING = 1011, - /** 1012: Audio Device Module: An error occurs in starting the recording device. - */ - ERR_ADM_START_RECORDING = 1012, - /** 1013: Audio Device Module: An error occurs in stopping the recording device. - */ - ERR_ADM_STOP_RECORDING = 1013, - /** 1015: Audio Device Module: A playback error occurs. Check your playback device and try rejoining the channel. - */ - ERR_ADM_RUNTIME_PLAYOUT_ERROR = 1015, - /** 1017: Audio Device Module: A recording error occurs. - */ - ERR_ADM_RUNTIME_RECORDING_ERROR = 1017, - /** 1018: Audio Device Module: Fails to record. - */ - ERR_ADM_RECORD_AUDIO_FAILED = 1018, - /** 1022: Audio Device Module: An error occurs in initializing the - * loopback device. - */ - ERR_ADM_INIT_LOOPBACK = 1022, - /** 1023: Audio Device Module: An error occurs in starting the loopback - * device. - */ - ERR_ADM_START_LOOPBACK = 1023, - /** 1027: Audio Device Module: No recording permission exists. Check if the - * recording permission is granted. - */ - ERR_ADM_NO_PERMISSION = 1027, - /** 1033: Audio device module: The device is occupied. - */ - ERR_ADM_RECORD_AUDIO_IS_ACTIVE = 1033, - /** 1101: Audio device module: A fatal exception occurs. - */ - ERR_ADM_ANDROID_JNI_JAVA_RESOURCE = 1101, - /** 1108: Audio device module: The recording frequency is lower than 50. - * 0 indicates that the recording is not yet started. We recommend - * checking your recording permission. - */ - ERR_ADM_ANDROID_JNI_NO_RECORD_FREQUENCY = 1108, - /** 1109: The playback frequency is lower than 50. 0 indicates that the - * playback is not yet started. We recommend checking if you have created - * too many AudioTrack instances. - */ - ERR_ADM_ANDROID_JNI_NO_PLAYBACK_FREQUENCY = 1109, - /** 1111: Audio device module: AudioRecord fails to start up. A ROM system - * error occurs. We recommend the following options to debug: - * - Restart your App. - * - Restart your cellphone. - * - Check your recording permission. - */ - ERR_ADM_ANDROID_JNI_JAVA_START_RECORD = 1111, - /** 1112: Audio device module: AudioTrack fails to start up. A ROM system - * error occurs. We recommend the following options to debug: - * - Restart your App. - * - Restart your cellphone. - * - Check your playback permission. - */ - ERR_ADM_ANDROID_JNI_JAVA_START_PLAYBACK = 1112, - /** 1115: Audio device module: AudioRecord returns error. The SDK will - * automatically restart AudioRecord. */ - ERR_ADM_ANDROID_JNI_JAVA_RECORD_ERROR = 1115, - /** **DEPRECATED** */ - ERR_ADM_ANDROID_OPENSL_CREATE_ENGINE = 1151, - /** **DEPRECATED** */ - ERR_ADM_ANDROID_OPENSL_CREATE_AUDIO_RECORDER = 1153, - /** **DEPRECATED** */ - ERR_ADM_ANDROID_OPENSL_START_RECORDER_THREAD = 1156, - /** **DEPRECATED** */ - ERR_ADM_ANDROID_OPENSL_CREATE_AUDIO_PLAYER = 1157, - /** **DEPRECATED** */ - ERR_ADM_ANDROID_OPENSL_START_PLAYER_THREAD = 1160, - /** 1201: Audio device module: The current device does not support audio - * input, possibly because you have mistakenly configured the audio session - * category, or because some other app is occupying the input device. We - * recommend terminating all background apps and re-joining the channel. */ - ERR_ADM_IOS_INPUT_NOT_AVAILABLE = 1201, - /** 1206: Audio device module: Cannot activate the Audio Session.*/ - ERR_ADM_IOS_ACTIVATE_SESSION_FAIL = 1206, - /** 1210: Audio device module: Fails to initialize the audio device, - * normally because the audio device parameters are wrongly set.*/ - ERR_ADM_IOS_VPIO_INIT_FAIL = 1210, - /** 1213: Audio device module: Fails to re-initialize the audio device, - * normally because the audio device parameters are wrongly set.*/ - ERR_ADM_IOS_VPIO_REINIT_FAIL = 1213, - /** 1214: Fails to re-start up the Audio Unit, possibly because the audio - * session category is not compatible with the settings of the Audio Unit. - */ - ERR_ADM_IOS_VPIO_RESTART_FAIL = 1214, - - ERR_ADM_IOS_SET_RENDER_CALLBACK_FAIL = 1219, - - /** **DEPRECATED** */ - ERR_ADM_IOS_SESSION_SAMPLERATR_ZERO = 1221, - /** 1301: Audio device module: An audio driver abnormality or a - * compatibility issue occurs. Solutions: Disable and restart the audio - * device, or reboot the system.*/ - ERR_ADM_WIN_CORE_INIT = 1301, - /** 1303: Audio device module: A recording driver abnormality or a - * compatibility issue occurs. Solutions: Disable and restart the audio - * device, or reboot the system. */ - ERR_ADM_WIN_CORE_INIT_RECORDING = 1303, - /** 1306: Audio device module: A playout driver abnormality or a - * compatibility issue occurs. Solutions: Disable and restart the audio - * device, or reboot the system. */ - ERR_ADM_WIN_CORE_INIT_PLAYOUT = 1306, - /** 1307: Audio device module: No audio device is available. Solutions: - * Plug in a proper audio device. */ - ERR_ADM_WIN_CORE_INIT_PLAYOUT_NULL = 1307, - /** 1309: Audio device module: An audio driver abnormality or a - * compatibility issue occurs. Solutions: Disable and restart the audio - * device, or reboot the system. */ - ERR_ADM_WIN_CORE_START_RECORDING = 1309, - /** 1311: Audio device module: Insufficient system memory or poor device - * performance. Solutions: Reboot the system or replace the device. - */ - ERR_ADM_WIN_CORE_CREATE_REC_THREAD = 1311, - /** 1314: Audio device module: An audio driver abnormality occurs. - * Solutions: - * - Disable and then re-enable the audio device. - * - Reboot the system. - * - Upgrade your audio card driver.*/ - ERR_ADM_WIN_CORE_CAPTURE_NOT_STARTUP = 1314, - /** 1319: Audio device module: Insufficient system memory or poor device - * performance. Solutions: Reboot the system or replace the device. */ - ERR_ADM_WIN_CORE_CREATE_RENDER_THREAD = 1319, - /** 1320: Audio device module: An audio driver abnormality occurs. - * Solutions: - * - Disable and then re-enable the audio device. - * - Reboot the system. - * - Replace the device. */ - ERR_ADM_WIN_CORE_RENDER_NOT_STARTUP = 1320, - /** 1322: Audio device module: No audio sampling device is available. - * Solutions: Plug in a proper recording device. */ - ERR_ADM_WIN_CORE_NO_RECORDING_DEVICE = 1322, - /** 1323: Audio device module: No audio playout device is available. - * Solutions: Plug in a proper playback device.*/ - ERR_ADM_WIN_CORE_NO_PLAYOUT_DEVICE = 1323, - /** 1351: Audio device module: An audio driver abnormality or a - * compatibility issue occurs. Solutions: - * - Disable and then re-enable the audio device. - * - Reboot the system. - * - Upgrade your audio card driver. */ - ERR_ADM_WIN_WAVE_INIT = 1351, - /** 1353: Audio device module: An audio driver abnormality occurs. - * Solutions: - * - Disable and then re-enable the audio device. - * - Reboot the system. - * - Upgrade your audio card driver. */ - ERR_ADM_WIN_WAVE_INIT_RECORDING = 1353, - /** 1354: Audio device module: An audio driver abnormality occurs. - * Solutions: - * - Disable and then re-enable the audio device. - * - Reboot the system. - * - Upgrade your audio card driver. */ - ERR_ADM_WIN_WAVE_INIT_MICROPHONE = 1354, - /** 1355: Audio device module: An audio driver abnormality occurs. - * Solutions: - * - Disable and then re-enable the audio device. - * - Reboot the system. - * - Upgrade your audio card driver. */ - ERR_ADM_WIN_WAVE_INIT_PLAYOUT = 1355, - /** 1356: Audio device module: An audio driver abnormality occurs. - * Solutions: - * - Disable and then re-enable the audio device. - * - Reboot the system. - * - Upgrade your audio card driver. */ - ERR_ADM_WIN_WAVE_INIT_SPEAKER = 1356, - /** 1357: Audio device module: An audio driver abnormality occurs. - * Solutions: - * - Disable and then re-enable the audio device. - * - Reboot the system. - * - Upgrade your audio card driver. */ - ERR_ADM_WIN_WAVE_START_RECORDING = 1357, - /** 1358: Audio device module: An audio driver abnormality occurs. - * Solutions: - * - Disable and then re-enable the audio device. - * - Reboot the system. - * - Upgrade your audio card driver.*/ - ERR_ADM_WIN_WAVE_START_PLAYOUT = 1358, - /** 1359: Audio Device Module: No recording device exists. - */ - ERR_ADM_NO_RECORDING_DEVICE = 1359, - /** 1360: Audio Device Module: No playback device exists. - */ - ERR_ADM_NO_PLAYOUT_DEVICE = 1360, - - // VDM error code starts from 1500 - /** 1501: Video Device Module: The camera is unauthorized. - */ - ERR_VDM_CAMERA_NOT_AUTHORIZED = 1501, - - // VDM error code starts from 1500 - /** **DEPRECATED** 1502: Video Device Module: The camera in use. - - Deprecated as of v2.4.1. Use LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY(3) in the \ref agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged" callback instead. - */ - ERR_VDM_WIN_DEVICE_IN_USE = 1502, - - // VCM error code starts from 1600 - /** 1600: Video Device Module: An unknown error occurs. - */ - ERR_VCM_UNKNOWN_ERROR = 1600, - /** 1601: Video Device Module: An error occurs in initializing the video encoder. - */ - ERR_VCM_ENCODER_INIT_ERROR = 1601, - /** 1602: Video Device Module: An error occurs in encoding. - */ - ERR_VCM_ENCODER_ENCODE_ERROR = 1602, - /** 1603: Video Device Module: An error occurs in setting the video encoder. - */ - ERR_VCM_ENCODER_SET_ERROR = 1603, + */ + ERR_OK = 0, + // 1~1000 + /** 1: A general error occurs (no specified reason). + */ + ERR_FAILED = 1, + /** 2: An invalid parameter is used. For example, the specific channel name includes illegal characters. + */ + ERR_INVALID_ARGUMENT = 2, + /** 3: The SDK module is not ready. Possible solutions: + + - Check the audio device. + - Check the completeness of the application. + - Re-initialize the RTC engine. + */ + ERR_NOT_READY = 3, + /** 4: The SDK does not support this function. + */ + ERR_NOT_SUPPORTED = 4, + /** 5: The request is rejected. + */ + ERR_REFUSED = 5, + /** 6: The buffer size is not big enough to store the returned data. + */ + ERR_BUFFER_TOO_SMALL = 6, + /** 7: The SDK is not initialized before calling this method. + */ + ERR_NOT_INITIALIZED = 7, + /** 9: No permission exists. Check if the user has granted access to the audio or video device. + */ + ERR_NO_PERMISSION = 9, + /** 10: An API method 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_TIMEDOUT = 10, + /** 11: The request is canceled. This is for internal SDK use only, and it does not return to the application through any method or callback. + */ + ERR_CANCELED = 11, + /** 12: The method is called too often. + */ + ERR_TOO_OFTEN = 12, + /** 13: The SDK fails to bind to the network socket. This is for internal SDK use only, and it does not return to the application through any method or callback. + */ + ERR_BIND_SOCKET = 13, + /** 14: The network is unavailable. This is for internal SDK use only, and it does not return to the application through any method or callback. + */ + ERR_NET_DOWN = 14, + /** 15: No network buffers are available. This is for internal SDK internal use only, and it does not return to the application through any method or callback. + */ + ERR_NET_NOBUFS = 15, + /** 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, \ref agora::rtc::IRtcEngine::joinChannel "joinChannel". + * - This error usually occurs when the user tries to join a channel + * during \ref agora::rtc::IRtcEngine::startEchoTest "startEchoTest". Once you + * call \ref agora::rtc::IRtcEngine::startEchoTest "startEchoTest", you need to + * call \ref agora::rtc::IRtcEngine::stopEchoTest "stopEchoTest" before joining a channel. + * - The user tries to join the channel with a token that is expired. + */ + ERR_JOIN_CHANNEL_REJECTED = 17, + /** 18: The request to leave the channel is rejected. + + This error usually occurs: + + - When the user has left the channel and still calls \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" to leave the channel. In this case, stop calling \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel". + - When the user has not joined the channel and still calls \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" to leave the channel. In this case, no extra operation is needed. + */ + ERR_LEAVE_CHANNEL_REJECTED = 18, + /** 19: Resources are occupied and cannot be reused. + */ + ERR_ALREADY_IN_USE = 19, + /** 20: The SDK gives up the request due to too many requests. + */ + ERR_ABORTED = 20, + /** 21: In Windows, specific firewall settings can cause the SDK to fail to initialize and crash. + */ + ERR_INIT_NET_ENGINE = 21, + /** 22: The application uses too much of the system resources and the SDK fails to allocate the resources. + */ + ERR_RESOURCE_LIMITED = 22, + /** 101: The specified App ID is invalid. Please try to rejoin the channel with a valid App ID. + */ + ERR_INVALID_APP_ID = 101, + /** 102: The specified channel name is invalid. Please try to rejoin the channel with a valid channel name. + */ + ERR_INVALID_CHANNEL_NAME = 102, + /** 103: Fails to get server resources in the specified region. Please try to specify another region when calling \ref agora::rtc::IRtcEngine::initialize "initialize". + */ + ERR_NO_SERVER_RESOURCES = 103, + /** **DEPRECATED** 109: Deprecated as of v2.4.1. Use CONNECTION_CHANGED_TOKEN_EXPIRED(9) in the \ref agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged" callback instead. + + The token expired due to one of the following reasons: + + - Authorized Timestamp expired: The timestamp is represented by the number of seconds elapsed since 1/1/1970. The user can use the Token to access the Agora service within 24 hours after the Token is generated. If the user does not access the Agora service after 24 hours, this Token is no longer valid. + - Call Expiration Timestamp expired: The timestamp is the exact time when a user can no longer use the Agora service (for example, when a user is forced to leave an ongoing call). When a value is set for the Call Expiration Timestamp, it does not mean that the token will expire, but that the user will be banned from the channel. + */ + ERR_TOKEN_EXPIRED = 109, + /** **DEPRECATED** 110: Deprecated as of v2.4.1. Use CONNECTION_CHANGED_INVALID_TOKEN(8) in the \ref agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged" callback instead. + + The token is invalid due to one of the following reasons: + + - The App Certificate for the project is enabled in Console, but the user is still using the App ID. Once the App Certificate is enabled, the user must use a token. + - The uid is mandatory, and users must set the same uid as the one set in the \ref agora::rtc::IRtcEngine::joinChannel "joinChannel" method. + */ + ERR_INVALID_TOKEN = 110, + /** 111: The internet connection is interrupted. This applies to the Agora Web SDK only. + */ + ERR_CONNECTION_INTERRUPTED = 111, // only used in web sdk + /** 112: The internet connection is lost. This applies to the Agora Web SDK only. + */ + ERR_CONNECTION_LOST = 112, // only used in web sdk + /** 113: The user is not in the channel when calling the method. + */ + ERR_NOT_IN_CHANNEL = 113, + /** 114: The size of the sent data is over 1024 bytes when the user calls the \ref agora::rtc::IRtcEngine::sendStreamMessage "sendStreamMessage" method. + */ + ERR_SIZE_TOO_LARGE = 114, + /** 115: The bitrate of the sent data exceeds the limit of 6 Kbps when the user calls the \ref agora::rtc::IRtcEngine::sendStreamMessage "sendStreamMessage" method. + */ + ERR_BITRATE_LIMIT = 115, + /** 116: Too many data streams (over 5 streams) are created when the user calls the \ref agora::rtc::IRtcEngine::createDataStream "createDataStream" method. + */ + ERR_TOO_MANY_DATA_STREAMS = 116, + /** 117: The data stream transmission timed out. + */ + ERR_STREAM_MESSAGE_TIMEOUT = 117, + /** 119: Switching roles fail. Please try to rejoin the channel. + */ + ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED = 119, + /** 120: Decryption fails. The user may have used a different encryption password to join the channel. Check your settings or try rejoining the channel. + */ + ERR_DECRYPTION_FAILED = 120, + /** 123: The user is banned by the server. This error occurs when the user is kicked out the channel from the server. + */ + ERR_CLIENT_IS_BANNED_BY_SERVER = 123, + /** 124: Incorrect watermark file parameter. + */ + ERR_WATERMARK_PARAM = 124, + /** 125: Incorrect watermark file path. + */ + ERR_WATERMARK_PATH = 125, + /** 126: Incorrect watermark file format. + */ + ERR_WATERMARK_PNG = 126, + /** 127: Incorrect watermark file information. + */ + ERR_WATERMARKR_INFO = 127, + /** 128: Incorrect watermark file data format. + */ + ERR_WATERMARK_ARGB = 128, + /** 129: An error occurs in reading the watermark file. + */ + ERR_WATERMARK_READ = 129, + /** 130: Encryption is enabled when the user calls the \ref agora::rtc::IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" method (CDN live streaming does not support encrypted streams). + */ + ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH = 130, + /** 134: The user account is invalid. */ + ERR_INVALID_USER_ACCOUNT = 134, + + /** 151: CDN related errors. Remove the original URL address and add a new one by calling the \ref agora::rtc::IRtcEngine::removePublishStreamUrl "removePublishStreamUrl" and \ref agora::rtc::IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" methods. + */ + ERR_PUBLISH_STREAM_CDN_ERROR = 151, + /** 152: The host publishes more than 10 URLs. Delete the unnecessary URLs before adding new ones. + */ + ERR_PUBLISH_STREAM_NUM_REACH_LIMIT = 152, + /** 153: The host manipulates other hosts' URLs. Check your app logic. + */ + ERR_PUBLISH_STREAM_NOT_AUTHORIZED = 153, + /** 154: An error occurs in Agora's streaming server. Call the addPublishStreamUrl method to publish the streaming again. + */ + ERR_PUBLISH_STREAM_INTERNAL_SERVER_ERROR = 154, + /** 155: The server fails to find the stream. + */ + ERR_PUBLISH_STREAM_NOT_FOUND = 155, + /** 156: The format of the RTMP or RTMPS stream URL is not supported. Check whether the URL format is correct. + */ + ERR_PUBLISH_STREAM_FORMAT_NOT_SUPPORTED = 156, + /** 157: The necessary dynamical library is not integrated. For example, if you call + * the \ref agora::rtc::IRtcEngine::enableDeepLearningDenoise "enableDeepLearningDenoise" but do not integrate the dynamical + * library for the deep-learning noise reduction into your project, the SDK reports this error code. + * + */ + ERR_MODULE_NOT_FOUND = 157, + /// @cond + /** 158: The dynamical library for the super-resolution algorithm is not integrated. + * When you call the \ref agora::rtc::IRtcEngine::enableRemoteSuperResolution "enableRemoteSuperResolution" method but + * do not integrate the dynamical library for the super-resolution algorithm + * into your project, the SDK reports this error code. + */ + ERR_MODULE_SUPER_RESOLUTION_NOT_FOUND = 158, + /// @endcond + + /** 160: The client is already recording audio. To start a new recording, + * call \ref agora::rtc::IRtcEngine::stopAudioRecording "stopAudioRecording" to stop + * the current recording first, and then + * call \ref agora::rtc::IRtcEngine::startAudioRecording(const AudioRecordingConfiguration&) "startAudioRecording". + * + * @since v3.4.0 + */ + ERR_ALREADY_IN_RECORDING = 160, + + // signaling: 400~600 + ERR_LOGOUT_OTHER = 400, // + ERR_LOGOUT_USER = 401, // logout by user + ERR_LOGOUT_NET = 402, // network failure + ERR_LOGOUT_KICKED = 403, // login in other device + ERR_LOGOUT_PACKET = 404, // + ERR_LOGOUT_TOKEN_EXPIRED = 405, // token expired + ERR_LOGOUT_OLDVERSION = 406, // + ERR_LOGOUT_TOKEN_WRONG = 407, + ERR_LOGOUT_ALREADY_LOGOUT = 408, + ERR_LOGIN_OTHER = 420, + ERR_LOGIN_NET = 421, + ERR_LOGIN_FAILED = 422, + ERR_LOGIN_CANCELED = 423, + ERR_LOGIN_TOKEN_EXPIRED = 424, + ERR_LOGIN_OLD_VERSION = 425, + ERR_LOGIN_TOKEN_WRONG = 426, + ERR_LOGIN_TOKEN_KICKED = 427, + ERR_LOGIN_ALREADY_LOGIN = 428, + ERR_JOIN_CHANNEL_OTHER = 440, + ERR_SEND_MESSAGE_OTHER = 440, + ERR_SEND_MESSAGE_TIMEOUT = 441, + ERR_QUERY_USERNUM_OTHER = 450, + ERR_QUERY_USERNUM_TIMEOUT = 451, + ERR_QUERY_USERNUM_BYUSER = 452, + ERR_LEAVE_CHANNEL_OTHER = 460, + ERR_LEAVE_CHANNEL_KICKED = 461, + ERR_LEAVE_CHANNEL_BYUSER = 462, + ERR_LEAVE_CHANNEL_LOGOUT = 463, + ERR_LEAVE_CHANNEL_DISCONNECTED = 464, + ERR_INVITE_OTHER = 470, + ERR_INVITE_REINVITE = 471, + ERR_INVITE_NET = 472, + ERR_INVITE_PEER_OFFLINE = 473, + ERR_INVITE_TIMEOUT = 474, + ERR_INVITE_CANT_RECV = 475, + + // 1001~2000 + /** 1001: Fails to load the media engine. + */ + ERR_LOAD_MEDIA_ENGINE = 1001, + /** 1002: Fails to start the call after enabling the media engine. + */ + ERR_START_CALL = 1002, + /** **DEPRECATED** 1003: Fails to start the camera. + + Deprecated as of v2.4.1. Use LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE(4) in the \ref agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged" callback instead. + */ + ERR_START_CAMERA = 1003, + /** 1004: Fails to start the video rendering module. + */ + ERR_START_VIDEO_RENDER = 1004, + /** 1005: A general error occurs in the Audio Device Module (no specified reason). Check if the audio device is used by another application, or try rejoining the channel. + */ + ERR_ADM_GENERAL_ERROR = 1005, + /** 1006: Audio Device Module: An error occurs in using the Java resources. + */ + ERR_ADM_JAVA_RESOURCE = 1006, + /** 1007: Audio Device Module: An error occurs in setting the sampling frequency. + */ + ERR_ADM_SAMPLE_RATE = 1007, + /** 1008: Audio Device Module: An error occurs in initializing the playback device. + */ + ERR_ADM_INIT_PLAYOUT = 1008, + /** 1009: Audio Device Module: An error occurs in starting the playback device. + */ + ERR_ADM_START_PLAYOUT = 1009, + /** 1010: Audio Device Module: An error occurs in stopping the playback device. + */ + ERR_ADM_STOP_PLAYOUT = 1010, + /** 1011: Audio Device Module: An error occurs in initializing the capturing device. + */ + ERR_ADM_INIT_RECORDING = 1011, + /** 1012: Audio Device Module: An error occurs in starting the capturing device. + */ + ERR_ADM_START_RECORDING = 1012, + /** 1013: Audio Device Module: An error occurs in stopping the capturing device. + */ + ERR_ADM_STOP_RECORDING = 1013, + /** 1015: Audio Device Module: A playback error occurs. Check your playback device and try rejoining the channel. + */ + ERR_ADM_RUNTIME_PLAYOUT_ERROR = 1015, + /** 1017: Audio Device Module: A capturing error occurs. + */ + ERR_ADM_RUNTIME_RECORDING_ERROR = 1017, + /** 1018: Audio Device Module: Fails to record. + */ + ERR_ADM_RECORD_AUDIO_FAILED = 1018, + /** 1022: Audio Device Module: An error occurs in initializing the + * loopback device. + */ + ERR_ADM_INIT_LOOPBACK = 1022, + /** 1023: Audio Device Module: An error occurs in starting the loopback + * device. + */ + ERR_ADM_START_LOOPBACK = 1023, + /** 1027: Audio Device Module: No recording permission exists. Check if the + * recording permission is granted. + */ + ERR_ADM_NO_PERMISSION = 1027, + /** 1033: Audio device module: The device is occupied. + */ + ERR_ADM_RECORD_AUDIO_IS_ACTIVE = 1033, + /** 1101: Audio device module: A fatal exception occurs. + */ + ERR_ADM_ANDROID_JNI_JAVA_RESOURCE = 1101, + /** 1108: Audio device module: The capturing frequency is lower than 50. + * 0 indicates that the capturing is not yet started. We recommend + * checking your recording permission. + */ + ERR_ADM_ANDROID_JNI_NO_RECORD_FREQUENCY = 1108, + /** 1109: The playback frequency is lower than 50. 0 indicates that the + * playback is not yet started. We recommend checking if you have created + * too many AudioTrack instances. + */ + ERR_ADM_ANDROID_JNI_NO_PLAYBACK_FREQUENCY = 1109, + /** 1111: Audio device module: AudioRecord fails to start up. A ROM system + * error occurs. We recommend the following options to debug: + * - Restart your App. + * - Restart your cellphone. + * - Check your recording permission. + */ + ERR_ADM_ANDROID_JNI_JAVA_START_RECORD = 1111, + /** 1112: Audio device module: AudioTrack fails to start up. A ROM system + * error occurs. We recommend the following options to debug: + * - Restart your App. + * - Restart your cellphone. + * - Check your playback permission. + */ + ERR_ADM_ANDROID_JNI_JAVA_START_PLAYBACK = 1112, + /** 1115: Audio device module: AudioRecord returns error. The SDK will + * automatically restart AudioRecord. */ + ERR_ADM_ANDROID_JNI_JAVA_RECORD_ERROR = 1115, + /** **DEPRECATED** */ + ERR_ADM_ANDROID_OPENSL_CREATE_ENGINE = 1151, + /** **DEPRECATED** */ + ERR_ADM_ANDROID_OPENSL_CREATE_AUDIO_RECORDER = 1153, + /** **DEPRECATED** */ + ERR_ADM_ANDROID_OPENSL_START_RECORDER_THREAD = 1156, + /** **DEPRECATED** */ + ERR_ADM_ANDROID_OPENSL_CREATE_AUDIO_PLAYER = 1157, + /** **DEPRECATED** */ + ERR_ADM_ANDROID_OPENSL_START_PLAYER_THREAD = 1160, + /** 1201: Audio device module: The current device does not support audio + * input, possibly because you have mistakenly configured the audio session + * category, or because some other app is occupying the input device. We + * recommend terminating all background apps and re-joining the channel. */ + ERR_ADM_IOS_INPUT_NOT_AVAILABLE = 1201, + /** 1206: Audio device module: Cannot activate the Audio Session.*/ + ERR_ADM_IOS_ACTIVATE_SESSION_FAIL = 1206, + /** 1210: Audio device module: Fails to initialize the audio device, + * normally because the audio device parameters are wrongly set.*/ + ERR_ADM_IOS_VPIO_INIT_FAIL = 1210, + /** 1213: Audio device module: Fails to re-initialize the audio device, + * normally because the audio device parameters are wrongly set.*/ + ERR_ADM_IOS_VPIO_REINIT_FAIL = 1213, + /** 1214: Fails to re-start up the Audio Unit, possibly because the audio + * session category is not compatible with the settings of the Audio Unit. + */ + ERR_ADM_IOS_VPIO_RESTART_FAIL = 1214, + + ERR_ADM_IOS_SET_RENDER_CALLBACK_FAIL = 1219, + + /** **DEPRECATED** */ + ERR_ADM_IOS_SESSION_SAMPLERATR_ZERO = 1221, + /** 1301: Audio device module: An audio driver abnormality or a + * compatibility issue occurs. Solutions: Disable and restart the audio + * device, or reboot the system.*/ + ERR_ADM_WIN_CORE_INIT = 1301, + /** 1303: Audio device module: A recording driver abnormality or a + * compatibility issue occurs. Solutions: Disable and restart the audio + * device, or reboot the system. */ + ERR_ADM_WIN_CORE_INIT_RECORDING = 1303, + /** 1306: Audio device module: A playout driver abnormality or a + * compatibility issue occurs. Solutions: Disable and restart the audio + * device, or reboot the system. */ + ERR_ADM_WIN_CORE_INIT_PLAYOUT = 1306, + /** 1307: Audio device module: No audio device is available. Solutions: + * Plug in a proper audio device. */ + ERR_ADM_WIN_CORE_INIT_PLAYOUT_NULL = 1307, + /** 1309: Audio device module: An audio driver abnormality or a + * compatibility issue occurs. Solutions: Disable and restart the audio + * device, or reboot the system. */ + ERR_ADM_WIN_CORE_START_RECORDING = 1309, + /** 1311: Audio device module: Insufficient system memory or poor device + * performance. Solutions: Reboot the system or replace the device. + */ + ERR_ADM_WIN_CORE_CREATE_REC_THREAD = 1311, + /** 1314: Audio device module: An audio driver abnormality occurs. + * Solutions: + * - Disable and then re-enable the audio device. + * - Reboot the system. + * - Upgrade your audio card driver.*/ + ERR_ADM_WIN_CORE_CAPTURE_NOT_STARTUP = 1314, + /** 1319: Audio device module: Insufficient system memory or poor device + * performance. Solutions: Reboot the system or replace the device. */ + ERR_ADM_WIN_CORE_CREATE_RENDER_THREAD = 1319, + /** 1320: Audio device module: An audio driver abnormality occurs. + * Solutions: + * - Disable and then re-enable the audio device. + * - Reboot the system. + * - Replace the device. */ + ERR_ADM_WIN_CORE_RENDER_NOT_STARTUP = 1320, + /** 1322: Audio device module: No audio sampling device is available. + * Solutions: Plug in a proper capturing device. */ + ERR_ADM_WIN_CORE_NO_RECORDING_DEVICE = 1322, + /** 1323: Audio device module: No audio playout device is available. + * Solutions: Plug in a proper playback device.*/ + ERR_ADM_WIN_CORE_NO_PLAYOUT_DEVICE = 1323, + /** 1351: Audio device module: An audio driver abnormality or a + * compatibility issue occurs. Solutions: + * - Disable and then re-enable the audio device. + * - Reboot the system. + * - Upgrade your audio card driver. */ + ERR_ADM_WIN_WAVE_INIT = 1351, + /** 1353: Audio device module: An audio driver abnormality occurs. + * Solutions: + * - Disable and then re-enable the audio device. + * - Reboot the system. + * - Upgrade your audio card driver. */ + ERR_ADM_WIN_WAVE_INIT_RECORDING = 1353, + /** 1354: Audio device module: An audio driver abnormality occurs. + * Solutions: + * - Disable and then re-enable the audio device. + * - Reboot the system. + * - Upgrade your audio card driver. */ + ERR_ADM_WIN_WAVE_INIT_MICROPHONE = 1354, + /** 1355: Audio device module: An audio driver abnormality occurs. + * Solutions: + * - Disable and then re-enable the audio device. + * - Reboot the system. + * - Upgrade your audio card driver. */ + ERR_ADM_WIN_WAVE_INIT_PLAYOUT = 1355, + /** 1356: Audio device module: An audio driver abnormality occurs. + * Solutions: + * - Disable and then re-enable the audio device. + * - Reboot the system. + * - Upgrade your audio card driver. */ + ERR_ADM_WIN_WAVE_INIT_SPEAKER = 1356, + /** 1357: Audio device module: An audio driver abnormality occurs. + * Solutions: + * - Disable and then re-enable the audio device. + * - Reboot the system. + * - Upgrade your audio card driver. */ + ERR_ADM_WIN_WAVE_START_RECORDING = 1357, + /** 1358: Audio device module: An audio driver abnormality occurs. + * Solutions: + * - Disable and then re-enable the audio device. + * - Reboot the system. + * - Upgrade your audio card driver.*/ + ERR_ADM_WIN_WAVE_START_PLAYOUT = 1358, + /** 1359: Audio Device Module: No capturing device exists. + */ + ERR_ADM_NO_RECORDING_DEVICE = 1359, + /** 1360: Audio Device Module: No playback device exists. + */ + ERR_ADM_NO_PLAYOUT_DEVICE = 1360, + + // VDM error code starts from 1500 + /// @cond + /** 1500: Video Device Module: There is no camera device. + */ + ERR_VDM_CAMERA_NO_DEVICE = 1500, + /// @endcond + + /** 1501: Video Device Module: The camera is unauthorized. + */ + ERR_VDM_CAMERA_NOT_AUTHORIZED = 1501, + + /** **DEPRECATED** 1502: Video Device Module: The camera in use. + Deprecated as of v2.4.1. Use LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY(3) in the \ref agora::rtc::IRtcEngineEventHandler::onLocalVideoStateChanged "onLocalVideoStateChanged" callback instead. + */ + ERR_VDM_WIN_DEVICE_IN_USE = 1502, + + // VCM error code starts from 1600 + /** 1600: Video Device Module: An unknown error occurs. + */ + ERR_VCM_UNKNOWN_ERROR = 1600, + /** 1601: Video Device Module: An error occurs in initializing the video encoder. + */ + ERR_VCM_ENCODER_INIT_ERROR = 1601, + /** 1602: Video Device Module: An error occurs in encoding. + */ + ERR_VCM_ENCODER_ENCODE_ERROR = 1602, + /** 1603: Video Device Module: An error occurs in setting the video encoder. + */ + ERR_VCM_ENCODER_SET_ERROR = 1603, }; - /** Output log filter level. */ -enum LOG_FILTER_TYPE -{ -/** 0: Do not output any log information. */ - LOG_FILTER_OFF = 0, - /** 0x080f: Output all log information. - Set your log filter as debug if you want to get the most complete log file. */ - LOG_FILTER_DEBUG = 0x080f, - /** 0x000f: Output CRITICAL, ERROR, WARNING, and INFO level log information. - We recommend setting your log filter as this level. - */ - LOG_FILTER_INFO = 0x000f, - /** 0x000e: Outputs CRITICAL, ERROR, and WARNING level log information. - */ - LOG_FILTER_WARN = 0x000e, - /** 0x000c: Outputs CRITICAL and ERROR level log information. */ - LOG_FILTER_ERROR = 0x000c, - /** 0x0008: Outputs CRITICAL level log information. */ - LOG_FILTER_CRITICAL = 0x0008, - /// @cond - LOG_FILTER_MASK = 0x80f, - /// @endcond +/** Output log filter level. */ +enum LOG_FILTER_TYPE { + /** 0: Do not output any log information. */ + LOG_FILTER_OFF = 0, + /** 0x080f: Output all log information. + Set your log filter as debug if you want to get the most complete log file. */ + LOG_FILTER_DEBUG = 0x080f, + /** 0x000f: Output CRITICAL, ERROR, WARNING, and INFO level log information. + We recommend setting your log filter as this level. + */ + LOG_FILTER_INFO = 0x000f, + /** 0x000e: Outputs CRITICAL, ERROR, and WARNING level log information. + */ + LOG_FILTER_WARN = 0x000e, + /** 0x000c: Outputs CRITICAL and ERROR level log information. */ + LOG_FILTER_ERROR = 0x000c, + /** 0x0008: Outputs CRITICAL level log information. */ + LOG_FILTER_CRITICAL = 0x0008, + /// @cond + LOG_FILTER_MASK = 0x80f, + /// @endcond +}; +/** The output log level of the SDK. + * + * @since v3.3.0 + */ +enum class LOG_LEVEL { + /** 0x0000: Do not output any log. */ + LOG_LEVEL_NONE = 0x0000, + /** 0x0001: (Default) Output logs of the FATAL, ERROR, WARN and INFO level. We recommend setting your log filter as this level. + */ + LOG_LEVEL_INFO = 0x0001, + /** 0x0002: Output logs of the FATAL, ERROR and WARN level. + */ + LOG_LEVEL_WARN = 0x0002, + /** 0x0004: Output logs of the FATAL and ERROR level. */ + LOG_LEVEL_ERROR = 0x0004, + /** 0x0008: Output logs of the FATAL level. */ + LOG_LEVEL_FATAL = 0x0008, }; -} // namespace agora +} // namespace agora #endif diff --git a/cpp/android/include/AgoraRtcCryptoCppLoader.h b/cpp/android/include/AgoraRtcCryptoCppLoader.h deleted file mode 100644 index 58e4902..0000000 --- a/cpp/android/include/AgoraRtcCryptoCppLoader.h +++ /dev/null @@ -1,18 +0,0 @@ -// -// AgoraRtcCryptoCppLoader.h -// AgoraRtcCryptoLoader -// -// Copyright © 2019 Agora IO. All rights reserved. -// - -#ifndef AgoraRtcCryptoCppLoader_h -#define AgoraRtcCryptoCppLoader_h - -class AgoraRtcCryptoCppLoader -{ -public: - AgoraRtcCryptoCppLoader(); - ~AgoraRtcCryptoCppLoader(); -}; - -#endif /* AgoraRtcCryptoCppLoader_h */ diff --git a/cpp/android/include/IAgoraLog.h b/cpp/android/include/IAgoraLog.h new file mode 100644 index 0000000..f648c46 --- /dev/null +++ b/cpp/android/include/IAgoraLog.h @@ -0,0 +1,34 @@ +// +// Agora Media SDK +// +// Copyright (c) 2015 Agora IO. All rights reserved. +// + +#pragma once + +#include + +namespace agora { +namespace commons { +/* +The SDK uses ILogWriter class Write interface to write logs as application +The application inherits the methods Write() to implentation their own log writ + +Write has default implementation, it writes logs to files. +Application can use setLogFile() to change file location, see description of set +*/ +class ILogWriter { + public: + /** user defined log Write function + @param message message content + @param length message length + @return + - 0: success + - <0: failure + */ + virtual int32_t writeLog(const char* message, uint16_t length) = 0; + virtual ~ILogWriter() {} +}; + +} // namespace commons +} // namespace agora diff --git a/cpp/android/include/IAgoraMediaEngine.h b/cpp/android/include/IAgoraMediaEngine.h index e44fb6c..6ee8dc5 100644 --- a/cpp/android/include/IAgoraMediaEngine.h +++ b/cpp/android/include/IAgoraMediaEngine.h @@ -31,73 +31,93 @@ class IAudioFrameObserver { */ AUDIO_FRAME_TYPE type; /** The number of samples per channel in the audio frame. - */ - int samples; //number of samples for each channel in this frame + */ + int samples; // number of samples for each channel in this frame /**The number of bytes per audio sample, which is usually 16-bit (2-byte). */ - int bytesPerSample; //number of bytes per sample: 2 for PCM16 + int bytesPerSample; // number of bytes per sample: 2 for PCM16 /** The number of audio channels. - 1: Mono - 2: Stereo (the data is interleaved) */ - int channels; //number of channels (data are interleaved if stereo) + int channels; // number of channels (data are interleaved if stereo) /** The sample rate. */ - int samplesPerSec; //sampling rate + int samplesPerSec; // sampling rate /** The data buffer of the audio frame. When the audio frame uses a stereo channel, the data buffer is interleaved. The size of the data buffer is as follows: `buffer` = `samples` × `channels` × `bytesPerSample`. */ - void* buffer; //data buffer - /** The timestamp (ms) of the external audio frame. You can use this parameter for the following purposes: - - Restore the order of the captured audio frame. - - Synchronize audio and video frames in video-related scenarios, including where external video sources are used. - */ + void* buffer; // data buffer + /** The timestamp (ms) of the external audio frame. You can use this parameter for the following purposes: + - Restore the order of the captured audio frame. + - Synchronize audio and video frames in video-related scenarios, including where external video sources are used. + */ int64_t renderTimeMs; /** Reserved parameter. - */ + */ int avsync_type; }; public: - /** Retrieves the recorded audio frame. - - @param audioFrame Pointer to AudioFrame. - @return - - true: Valid buffer in AudioFrame, and the recorded audio frame is sent out. - - false: Invalid buffer in AudioFrame, and the recorded audio frame is discarded. + /** Gets the captured audio frame. + * + * @note To ensure that the captured audio frame has the expected format, + * Agora recommends that you + * call \ref agora::rtc::IRtcEngine::setRecordingAudioFrameParameters "setRecordingAudioFrameParameters" + * after calling \ref IMediaEngine::registerAudioFrameObserver "registerAudioFrameObserver" to + * set the audio capturing format. + * + * @param audioFrame Pointer to AudioFrame. + * @return + * - true: Valid buffer in AudioFrame, and the captured audio frame is sent out. + * - false: Invalid buffer in AudioFrame, and the captured audio frame is discarded. */ virtual bool onRecordAudioFrame(AudioFrame& audioFrame) = 0; - /** Retrieves the audio playback frame for getting the audio. - - @param audioFrame Pointer to AudioFrame. - @return - - true: Valid buffer in AudioFrame, and the audio playback frame is sent out. - - false: Invalid buffer in AudioFrame, and the audio playback frame is discarded. + /** Gets the audio playback frame for getting the audio. + * + * @note To ensure that the audio playback frame has the expected format, Agora + * recommends that you call \ref agora::rtc::IRtcEngine::setPlaybackAudioFrameParameters "setPlaybackAudioFrameParameters" + * after calling \ref IMediaEngine::registerAudioFrameObserver "registerAudioFrameObserver" to + * set the audio playback format. + * + * @param audioFrame Pointer to AudioFrame. + * @return + * - true: Valid buffer in AudioFrame, and the audio playback frame is sent out. + * - false: Invalid buffer in AudioFrame, and the audio playback frame is discarded. */ virtual bool onPlaybackAudioFrame(AudioFrame& audioFrame) = 0; - /** Retrieves the mixed recorded and playback audio frame. - - - @note This callback only returns the single-channel data. - - @param audioFrame Pointer to AudioFrame. - @return - - true: Valid buffer in AudioFrame and the mixed recorded and playback audio frame is sent out. - - false: Invalid buffer in AudioFrame and the mixed recorded and playback audio frame is discarded. + /** Gets the mixed captured and playback audio frame. + * + * @note + * - This callback only returns the single-channel data. + * - To ensure that the mixed captured and playback audio frame has the + * expected format, Agora recommends that you call + * \ref agora::rtc::IRtcEngine::setMixedAudioFrameParameters "setMixedAudioFrameParameters" + * after calling \ref IMediaEngine::registerAudioFrameObserver "registerAudioFrameObserver" to + * set the mixed audio format. + * + * @param audioFrame Pointer to AudioFrame. + * @return + * - true: Valid buffer in AudioFrame and the mixed captured and playback audio frame is sent out. + * - false: Invalid buffer in AudioFrame and the mixed captured and playback audio frame is discarded. */ virtual bool onMixedAudioFrame(AudioFrame& audioFrame) = 0; - /** Retrieves the audio frame of a specified user before mixing. - - The SDK triggers this callback if isMultipleChannelFrameWanted returns false. - - @param uid The user ID - @param audioFrame Pointer to AudioFrame. - @return - - true: Valid buffer in AudioFrame, and the mixed recorded and playback audio frame is sent out. - - false: Invalid buffer in AudioFrame, and the mixed recorded and playback audio frame is discarded. - */ - virtual bool onPlaybackAudioFrameBeforeMixing(unsigned int uid, - AudioFrame& audioFrame) = 0; + /** Gets the audio frame of a specified user before mixing. + * + * The SDK triggers this callback if \ref IAudioFrameObserver::isMultipleChannelFrameWanted "isMultipleChannelFrameWanted" returns false. + * + * @note To ensure that the audio playback frame has the expected format, Agora + * recommends that you call \ref agora::rtc::IRtcEngine::setPlaybackAudioFrameParameters "setPlaybackAudioFrameParameters" + * after calling \ref IMediaEngine::registerAudioFrameObserver "registerAudioFrameObserver" to + * set the audio playback format. + * + * @param uid The user ID + * @param audioFrame Pointer to AudioFrame. + * @return + * - true: Valid buffer in AudioFrame, and the mixed captured and playback audio frame is sent out. + * - false: Invalid buffer in AudioFrame, and the mixed captured and playback audio frame is discarded. + */ + virtual bool onPlaybackAudioFrameBeforeMixing(unsigned int uid, AudioFrame& audioFrame) = 0; /** Determines whether to receive audio data from multiple channels. @since v3.0.1 @@ -122,21 +142,24 @@ class IAudioFrameObserver { virtual bool isMultipleChannelFrameWanted() { return false; } /** Gets the before-mixing playback audio frame from multiple channels. - - After you successfully register the audio frame observer, if you set the return - value of \ref IAudioFrameObserver::isMultipleChannelFrameWanted "isMultipleChannelFrameWanted" as true, the SDK triggers this callback each - time it receives a before-mixing audio frame from any of the channel. - - @param channelId The channel ID of this audio frame. - @param uid The ID of the user sending this audio frame. - @param audioFrame The pointer to AudioFrame. - @return - - `true`: The data in AudioFrame is valid, and send this audio frame. - - `false`: The data in AudioFrame in invalid, and do not send this audio frame. - */ - virtual bool onPlaybackAudioFrameBeforeMixingEx(const char *channelId, - unsigned int uid, AudioFrame& audioFrame) { return true; } - + * + * After you successfully register the audio frame observer, if you set the return + * value of \ref IAudioFrameObserver::isMultipleChannelFrameWanted "isMultipleChannelFrameWanted" as true, the SDK triggers this callback each + * time it receives a before-mixing audio frame from any of the channel. + * + * @note To ensure that the audio playback frame has the expected format, Agora + * recommends that you call \ref agora::rtc::IRtcEngine::setPlaybackAudioFrameParameters "setPlaybackAudioFrameParameters" + * after calling \ref IMediaEngine::registerAudioFrameObserver "registerAudioFrameObserver" to + * set the audio playback format. + * + * @param channelId The channel ID of this audio frame. + * @param uid The ID of the user sending this audio frame. + * @param audioFrame The pointer to AudioFrame. + * @return + * - `true`: The data in AudioFrame is valid, and send this audio frame. + * - `false`: The data in AudioFrame in invalid, and do not send this audio frame. + */ + virtual bool onPlaybackAudioFrameBeforeMixingEx(const char* channelId, unsigned int uid, AudioFrame& audioFrame) { return true; } }; /** @@ -144,20 +167,20 @@ class IAudioFrameObserver { */ class IVideoFrameObserver { public: - /** The video frame type. */ + /** The video frame type. */ enum VIDEO_FRAME_TYPE { /** - * 0: YUV420 + * 0: (Default) YUV 420 */ FRAME_TYPE_YUV420 = 0, // YUV 420 format /** - * 1: YUV422 + * 1: YUV 422 */ FRAME_TYPE_YUV422 = 1, // YUV 422 format /** * 2: RGBA */ - FRAME_TYPE_RGBA = 2, // RGBA format + FRAME_TYPE_RGBA = 2, // RGBA format }; /** * The frame position of the video observer. @@ -176,42 +199,42 @@ class IVideoFrameObserver { */ POSITION_PRE_ENCODER = 1 << 2, }; - /** Video frame information. The video data format is YUV420. The buffer provides a pointer to a pointer. The interface cannot modify the pointer of the buffer, but can modify the content of the buffer only. + /** Video frame information. The video data format is YUV 420. The buffer provides a pointer to a pointer. The interface cannot modify the pointer of the buffer, but can modify the content of the buffer only. */ struct VideoFrame { VIDEO_FRAME_TYPE type; /** Video pixel width. */ - int width; //width of video frame + int width; // width of video frame /** Video pixel height. */ - int height; //height of video frame + int height; // height of video frame /** Line span of the Y buffer within the YUV data. */ - int yStride; //stride of Y data buffer + int yStride; // stride of Y data buffer /** Line span of the U buffer within the YUV data. */ - int uStride; //stride of U data buffer + int uStride; // stride of U data buffer /** Line span of the V buffer within the YUV data. */ - int vStride; //stride of V data buffer + int vStride; // stride of V data buffer /** Pointer to the Y buffer pointer within the YUV data. */ - void* yBuffer; //Y data buffer + void* yBuffer; // Y data buffer /** Pointer to the U buffer pointer within the YUV data. */ - void* uBuffer; //U data buffer + void* uBuffer; // U data buffer /** Pointer to the V buffer pointer within the YUV data. */ - void* vBuffer; //V data buffer + void* vBuffer; // V data buffer /** Set the rotation of this frame before rendering the video. Supports 0, 90, 180, 270 degrees clockwise. */ - int rotation; // rotation of this frame (0, 90, 180, 270) - /** The timestamp (ms) of the external audio frame. It is mandatory. You can use this parameter for the following purposes: - - Restore the order of the captured audio frame. - - Synchronize audio and video frames in video-related scenarios, including scenarios where external video sources are used. - @note This timestamp is for rendering the video stream, and not for capturing the video stream. - */ + int rotation; // rotation of this frame (0, 90, 180, 270) + /** The timestamp (ms) of the external audio frame. It is mandatory. You can use this parameter for the following purposes: + - Restore the order of the captured audio frame. + - Synchronize audio and video frames in video-related scenarios, including scenarios where external video sources are used. + @note This timestamp is for rendering the video stream, and not for capturing the video stream. + */ int64_t renderTimeMs; int avsync_type; }; @@ -229,7 +252,7 @@ class IVideoFrameObserver { * - The video data that this callback gets has not been pre-processed, without the watermark, the cropped content, the rotation, and the image enhancement. * * @param videoFrame Pointer to VideoFrame. - * @return Whether or not to ignore the current video frame if the pre-processing fails: + * @return whether to ignore the current video frame if the pre-processing fails: * - true: Do not ignore. * - false: Ignore the current video frame, and do not send it back to the SDK. */ @@ -255,8 +278,11 @@ class IVideoFrameObserver { virtual bool onPreEncodeVideoFrame(VideoFrame& videoFrame) { return true; } /** Occurs each time the SDK receives a video frame sent by the remote user. * - * After you successfully register the video frame observer and isMultipleChannelFrameWanted return false, the SDK triggers this callback each time a video frame is received. - * In this callback, you can get the video data sent by the remote user. You can then post-process the data according to your scenarios. + * After you successfully register the video frame observer and + * \ref IVideoFrameObserver::isMultipleChannelFrameWanted "isMultipleChannelFrameWanted" + * return false, the SDK triggers this callback each time a video frame is received. + * In this callback, you can get the video data sent by the remote user. You can then + * post-process the data according to your scenarios. * * After post-processing, you can send the processed data back to the SDK by setting the `videoFrame` parameter in this callback. * @@ -265,54 +291,55 @@ class IVideoFrameObserver { * * @param uid ID of the remote user who sends the current video frame. * @param videoFrame Pointer to VideoFrame. - * @return Whether or not to ignore the current video frame if the post-processing fails: + * @return whether to ignore the current video frame if the post-processing fails: * - true: Do not ignore. * - false: Ignore the current video frame, and do not send it back to the SDK. */ virtual bool onRenderVideoFrame(unsigned int uid, VideoFrame& videoFrame) = 0; /** Occurs each time the SDK receives a video frame and prompts you to set the video format. * - * YUV420 is the default video format. If you want to receive other video formats, register this callback in the IVideoFrameObserver class. + * YUV 420 is the default video format. If you want to receive other video formats, register this callback in the IVideoFrameObserver class. * * After you successfully register the video frame observer, the SDK triggers this callback each time it receives a video frame. * You need to set your preferred video data in the return value of this callback. * * @return Sets the video format: #VIDEO_FRAME_TYPE - * - #FRAME_TYPE_YUV420 (0): (Default) YUV420. - * - #FRAME_TYPE_RGBA (2): RGBA */ virtual VIDEO_FRAME_TYPE getVideoFormatPreference() { return FRAME_TYPE_YUV420; } - /** Occurs each time the SDK receives a video frame and prompts you whether or not to rotate the captured video according to the rotation member in the VideoFrame class. + /** Occurs each time the SDK receives a video frame and prompts you whether to + * rotate the raw video frame according to the rotation member in the VideoFrame class. * - * The SDK does not rotate the captured video by default. If you want to rotate the captured video according to the rotation member in the VideoFrame class, register this callback in the IVideoFrameObserver class. + * The SDK does not rotate the raw video frame by default. If you want to receive + * the raw video frame rotated according to the rotation member in the VideoFrame + * class, register this callback in the IVideoFrameObserver class. * - * After you successfully register the video frame observer, the SDK triggers this callback each time it receives a video frame. You need to set whether or not to rotate the video frame in the return value of this callback. + * After you successfully register the video frame observer, the SDK triggers this + * callback each time it receives a video frame. You need to set whether to rotate + * the raw video frame in the return value of this callback. * - * @note - * This callback applies to RGBA video data only. + * @note This callback applies to the video frame in the YUV 420 and RGBA formats only. * - * @return Sets whether or not to rotate the captured video: + * @return Sets whether to rotate the raw video frame: * - true: Rotate. - * - false: （Default) Do not rotate. + * - false: (Default) Do not rotate. */ virtual bool getRotationApplied() { return false; } - /** Occurs each time the SDK receives a video frame and prompts you whether or not to mirror the captured video. + /** Occurs each time the SDK receives a video frame and prompts you whether to mirror the raw video frame. * - * The SDK does not mirror the captured video by default. Register this callback in the IVideoFrameObserver class if you want to mirror the captured video. + * The SDK does not mirror the raw video frame by default. If you want to receive the raw video frame mirrored, register this callback in the IVideoFrameObserver class. * * After you successfully register the video frame observer, the SDK triggers this callback each time a video frame is received. - * You need to set whether or not to mirror the captured video in the return value of this callback. + * You need to set whether to mirror the raw video frame in the return value of this callback. * - * @note - * This callback applies to RGBA video data only. + * @note This callback applies to the video frame in the YUV 420 and RGBA formats only. * - * @return Sets whether or not to mirror the captured video: + * @return Sets whether to mirror the raw video frame: * - true: Mirror. * - false: (Default) Do not mirror. */ virtual bool getMirrorApplied() { return false; } - /** @since v3.0.0 - + /** + **DEPRECATED** Sets whether to output the acquired video frame smoothly. If you want the video frames acquired from \ref IVideoFrameObserver::onRenderVideoFrame "onRenderVideoFrame" to be more evenly spaced, you can register the `getSmoothRenderingEnabled` callback in the `IVideoFrameObserver` class and set its return value as `true`. @@ -321,11 +348,11 @@ class IVideoFrameObserver { - Register this callback before joining a channel. - This callback applies to scenarios where the acquired video frame is self-rendered after being processed, not to scenarios where the video frame is sent back to the SDK after being processed. - @return Set whether or not to smooth the video frames: + @return Set whether to smooth the video frames: - true: Smooth the video frame. - false: (Default) Do not smooth. */ - virtual bool getSmoothRenderingEnabled(){ return false; } + virtual bool getSmoothRenderingEnabled() { return false; } /** * Sets the frame position for the video observer. * @since v3.0.1 @@ -348,6 +375,8 @@ class IVideoFrameObserver { /** Determines whether to receive video data from multiple channels. + @since v3.0.1 + After you register the video frame observer, the SDK triggers this callback every time it captures a video frame. @@ -384,17 +413,12 @@ class IVideoFrameObserver { - `true`: Send this video frame. - `false`: Do not send this video frame. */ - virtual bool onRenderVideoFrameEx(const char *channelId, unsigned int uid, VideoFrame& videoFrame) { return true; } + virtual bool onRenderVideoFrameEx(const char* channelId, unsigned int uid, VideoFrame& videoFrame) { return true; } }; class IVideoFrame { public: - enum PLANE_TYPE { - Y_PLANE = 0, - U_PLANE = 1, - V_PLANE = 2, - NUM_OF_PLANES = 3 - }; + enum PLANE_TYPE { Y_PLANE = 0, U_PLANE = 1, V_PLANE = 2, NUM_OF_PLANES = 3 }; enum VIDEO_TYPE { VIDEO_TYPE_UNKNOWN = 0, VIDEO_TYPE_I420 = 1, @@ -439,28 +463,27 @@ class IVideoFrame { - 0: Success. - < 0: Failure. */ - virtual int convertFrame(VIDEO_TYPE dst_video_type, int dst_sample_size, - unsigned char* dst_frame) const = 0; - /** Retrieves the specified component in the YUV space. + virtual int convertFrame(VIDEO_TYPE dst_video_type, int dst_sample_size, unsigned char* dst_frame) const = 0; + /** Gets the specified component in the YUV space. @param type Component type: #PLANE_TYPE */ virtual int allocated_size(PLANE_TYPE type) const = 0; - /** Retrieves the stride of the specified component in the YUV space. + /** Gets the stride of the specified component in the YUV space. @param type Component type: #PLANE_TYPE */ virtual int stride(PLANE_TYPE type) const = 0; - /** Retrieves the width of the frame. + /** Gets the width of the frame. */ virtual int width() const = 0; - /** Retrieves the height of the frame. + /** Gets the height of the frame. */ virtual int height() const = 0; - /** Retrieves the timestamp (ms) of the frame. + /** Gets the timestamp (ms) of the frame. */ virtual unsigned int timestamp() const = 0; - /** Retrieves the render time (ms). + /** Gets the render time (ms). */ virtual int64_t render_time_ms() const = 0; /** Checks if a plane is of zero size. @@ -477,10 +500,10 @@ class IVideoFrame { class IExternalVideoRenderCallback { public: /** Occurs when the video view size has changed. - */ + */ virtual void onViewSizeChanged(int width, int height) = 0; /** Occurs when the video view is destroyed. - */ + */ virtual void onViewDestroyed() = 0; }; /** **DEPRECATED** */ @@ -517,110 +540,151 @@ class IExternalVideoRender { public: virtual void release() = 0; virtual int initialize() = 0; - virtual int deliverFrame(const IVideoFrame& videoFrame, int rotation, - bool mirrored) = 0; + virtual int deliverFrame(const IVideoFrame& videoFrame, int rotation, bool mirrored) = 0; }; class IExternalVideoRenderFactory { public: - virtual IExternalVideoRender* createRenderInstance( - const ExternalVideoRenerContext& context) = 0; + virtual IExternalVideoRender* createRenderInstance(const ExternalVideoRenerContext& context) = 0; }; /** The external video frame. */ -struct ExternalVideoFrame -{ - /** The video buffer type. - */ - enum VIDEO_BUFFER_TYPE - { - /** 1: The video buffer in the format of raw data. - */ - VIDEO_BUFFER_RAW_DATA = 1, - }; - - /** The video pixel format. - * - * @note The SDK does not support the alpha channel, and discards any alpha value passed to the SDK. - */ - enum VIDEO_PIXEL_FORMAT - { - /** 0: The video pixel format is unknown. - */ - VIDEO_PIXEL_UNKNOWN = 0, - /** 1: The video pixel format is I420. - */ - VIDEO_PIXEL_I420 = 1, - /** 2: The video pixel format is BGRA. - */ - VIDEO_PIXEL_BGRA = 2, - /** 3: The video pixel format is NV21. - */ - VIDEO_PIXEL_NV21 = 3, - /** 4: The video pixel format is RGBA. - */ - VIDEO_PIXEL_RGBA = 4, - /** 5: The video pixel format is IMC2. - */ - VIDEO_PIXEL_IMC2 = 5, - /** 7: The video pixel format is ARGB. - */ - VIDEO_PIXEL_ARGB = 7, - /** 8: The video pixel format is NV12. - */ - VIDEO_PIXEL_NV12 = 8, - /** 16: The video pixel format is I422. - */ - VIDEO_PIXEL_I422 = 16, - }; - - /** The buffer type. See #VIDEO_BUFFER_TYPE - */ - VIDEO_BUFFER_TYPE type; - /** The pixel format. See #VIDEO_PIXEL_FORMAT - */ - VIDEO_PIXEL_FORMAT format; - /** The video buffer. - */ - void* buffer; - /** Line spacing of the incoming video frame, which must be in pixels instead of bytes. For textures, it is the width of the texture. - */ - int stride; - /** Height of the incoming video frame. - */ - int height; - /** [Raw data related parameter] The number of pixels trimmed from the left. The default value is 0. - */ - int cropLeft; - /** [Raw data related parameter] The number of pixels trimmed from the top. The default value is 0. - */ - int cropTop; - /** [Raw data related parameter] The number of pixels trimmed from the right. The default value is 0. - */ - int cropRight; - /** [Raw data related parameter] The number of pixels trimmed from the bottom. The default value is 0. - */ - int cropBottom; - /** [Raw data related parameter] The clockwise rotation of the video frame. You can set the rotation angle as 0, 90, 180, or 270. The default value is 0. - */ - int rotation; - /** Timestamp (ms) of the incoming video frame. An incorrect timestamp results in frame loss or unsynchronized audio and video. - */ - long long timestamp; - - ExternalVideoFrame() - :cropLeft(0) - ,cropTop(0) - ,cropRight(0) - ,cropBottom(0) - ,rotation(0) - {} +struct ExternalVideoFrame { + /** The video buffer type. + */ + enum VIDEO_BUFFER_TYPE { + /** 1: The video buffer in the format of raw data. + */ + VIDEO_BUFFER_RAW_DATA = 1, + }; + + /** The video pixel format. + * + * @note The SDK does not support the alpha channel, and discards any alpha value passed to the SDK. + */ + enum VIDEO_PIXEL_FORMAT { + /** 0: The video pixel format is unknown. + */ + VIDEO_PIXEL_UNKNOWN = 0, + /** 1: The video pixel format is I420. + */ + VIDEO_PIXEL_I420 = 1, + /** 2: The video pixel format is BGRA. + */ + VIDEO_PIXEL_BGRA = 2, + /** 3: The video pixel format is NV21. + */ + VIDEO_PIXEL_NV21 = 3, + /** 4: The video pixel format is RGBA. + */ + VIDEO_PIXEL_RGBA = 4, + /** 5: The video pixel format is IMC2. + */ + VIDEO_PIXEL_IMC2 = 5, + /** 7: The video pixel format is ARGB. + */ + VIDEO_PIXEL_ARGB = 7, + /** 8: The video pixel format is NV12. + */ + VIDEO_PIXEL_NV12 = 8, + /** 16: The video pixel format is I422. + */ + VIDEO_PIXEL_I422 = 16, + }; + + /** The buffer type. See #VIDEO_BUFFER_TYPE + */ + VIDEO_BUFFER_TYPE type; + /** The pixel format. See #VIDEO_PIXEL_FORMAT + */ + VIDEO_PIXEL_FORMAT format; + /** The video buffer. + */ + void* buffer; + /** Line spacing of the incoming video frame, which must be in pixels instead of bytes. For textures, it is the width of the texture. + */ + int stride; + /** Height of the incoming video frame. + */ + int height; + /** [Raw data related parameter] The number of pixels trimmed from the left. The default value is 0. + */ + int cropLeft; + /** [Raw data related parameter] The number of pixels trimmed from the top. The default value is 0. + */ + int cropTop; + /** [Raw data related parameter] The number of pixels trimmed from the right. The default value is 0. + */ + int cropRight; + /** [Raw data related parameter] The number of pixels trimmed from the bottom. The default value is 0. + */ + int cropBottom; + /** [Raw data related parameter] The clockwise rotation of the video frame. You can set the rotation angle as 0, 90, 180, or 270. The default value is 0. + */ + int rotation; + /** Timestamp (ms) of the incoming video frame. An incorrect timestamp results in frame loss or unsynchronized audio and video. + */ + long long timestamp; + + ExternalVideoFrame() : cropLeft(0), cropTop(0), cropRight(0), cropBottom(0), rotation(0) {} }; +enum CODEC_VIDEO_FRAME_TYPE { CODEC_VIDEO_FRAME_TYPE_BLANK_FRAME = 0, CODEC_VIDEO_FRAME_TYPE_KEY_FRAME = 3, CODEC_VIDEO_FRAME_TYPE_DELTA_FRAME = 4, CODEC_VIDEO_FRAME_TYPE_B_FRAME = 5, CODEC_VIDEO_FRAME_TYPE_UNKNOW }; + +enum VIDEO_ROTATION { VIDEO_ROTATION_0 = 0, VIDEO_ROTATION_90 = 90, VIDEO_ROTATION_180 = 180, VIDEO_ROTATION_270 = 270 }; + +/** Video codec types */ +enum VIDEO_CODEC_TYPE { + /** Standard VP8 */ + VIDEO_CODEC_VP8 = 1, + /** Standard H264 */ + VIDEO_CODEC_H264 = 2, + /** Enhanced VP8 */ + VIDEO_CODEC_EVP = 3, + /** Enhanced H264 */ + VIDEO_CODEC_E264 = 4, +}; +/// @cond +/** The struct of VideoEncodedFrame. */ +struct VideoEncodedFrame { + VideoEncodedFrame() : codecType(VIDEO_CODEC_H264), width(0), height(0), buffer(nullptr), length(0), frameType(CODEC_VIDEO_FRAME_TYPE_BLANK_FRAME), rotation(VIDEO_ROTATION_0), renderTimeMs(0) {} + /** + * The video codec: #VIDEO_CODEC_TYPE. + */ + VIDEO_CODEC_TYPE codecType; + /** The width (px) of the video. */ + int width; + /** The height (px) of the video. */ + int height; + /** The buffer of video encoded frame */ + const uint8_t* buffer; + /** The Length of video encoded frame buffer. */ + unsigned int length; + /** The frame type of the encoded video frame */ + CODEC_VIDEO_FRAME_TYPE frameType; + /** The rotation information of the encoded video frame */ + VIDEO_ROTATION rotation; + /** The timestamp for rendering the video. */ + int64_t renderTimeMs; +}; + +class IVideoEncodedFrameObserver { + public: + /** + * Occurs each time the SDK receives an encoded video image. + * @param videoEncodedFrame The information of the encoded video frame: VideoEncodedFrame. + * + */ + virtual bool onVideoEncodedFrame(const VideoEncodedFrame& videoEncodedFrame) = 0; + + virtual ~IVideoEncodedFrameObserver() {} +}; +/// @endcond + class IMediaEngine { public: - virtual ~IMediaEngine () {}; + virtual ~IMediaEngine(){}; virtual void release() = 0; /** Registers an audio frame observer object. @@ -670,9 +734,7 @@ class IMediaEngine { - 0: Success. - < 0: Failure. */ - virtual int pushAudioFrame(MEDIA_SOURCE_TYPE type, - IAudioFrameObserver::AudioFrame* frame, - bool wrap) = 0; + virtual int pushAudioFrame(MEDIA_SOURCE_TYPE type, IAudioFrameObserver::AudioFrame* frame, bool wrap) = 0; /** Pushes the external audio frame. @param frame Pointer to the audio frame: \ref IAudioFrameObserver::AudioFrame "AudioFrame". @@ -694,7 +756,7 @@ class IMediaEngine { * * @note * - Once you call the \ref agora::media::IMediaEngine::pullAudioFrame - * "pullAudioFrame" method successfully, the app will not retrieve any audio + * "pullAudioFrame" method successfully, the app will not get any audio * data from the * \ref agora::media::IAudioFrameObserver::onPlaybackAudioFrame * "onPlaybackAudioFrame" callback. @@ -717,34 +779,36 @@ class IMediaEngine { * - < 0: Failure. */ virtual int pullAudioFrame(IAudioFrameObserver::AudioFrame* frame) = 0; - /** Configures the external video source. + /** Configures the external video source. + + @note Ensure that you call this method before joining a channel. - @note Ensure that you call this method before joining a channel. + @param enable Sets whether to use the external video source: + - true: Use the external video source. + - false: (Default) Do not use the external video source. - @param enable Sets whether to use the external video source: - - true: Use the external video source. - - false: (Default) Do not use the external video source. + @param useTexture Sets whether to use texture as an input: + - true: Use texture as an input. + - false: (Default) Do not use texture as an input. - @param useTexture Sets whether to use texture as an input: - - true: Use texture as an input. - - false: (Default) Do not use texture as an input. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setExternalVideoSource(bool enable, bool useTexture) = 0; + /** Pushes the video frame using the \ref ExternalVideoFrame "ExternalVideoFrame" and passes the video frame to the Agora SDK. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setExternalVideoSource(bool enable, bool useTexture) = 0; - /** Pushes the video frame using the \ref ExternalVideoFrame "ExternalVideoFrame" and passes the video frame to the Agora SDK. + @param frame Video frame to be pushed. See \ref ExternalVideoFrame "ExternalVideoFrame". - @param frame Video frame to be pushed. See \ref ExternalVideoFrame "ExternalVideoFrame". + @note In the `COMMUNICATION` profile, this method does not support video frames in the Texture format. - @note In the `COMMUNICATION` profile, this method does not support video frames in the Texture format. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int pushVideoFrame(ExternalVideoFrame* frame) = 0; - @return - - 0: Success. - - < 0: Failure. - */ - virtual int pushVideoFrame(ExternalVideoFrame *frame) = 0; + virtual int registerVideoEncodedFrameObserver(IVideoEncodedFrameObserver* observer) = 0; }; } // namespace media diff --git a/cpp/android/include/IAgoraRtcChannel.h b/cpp/android/include/IAgoraRtcChannel.h index f354183..b13c140 100644 --- a/cpp/android/include/IAgoraRtcChannel.h +++ b/cpp/android/include/IAgoraRtcChannel.h @@ -10,1512 +10,1550 @@ namespace agora { namespace rtc { -/** The channel media options. */ -struct ChannelMediaOptions { - /** Determines whether to subscribe to audio streams when the user joins the channel: - - true: (Default) Subscribe. - - false: Do not subscribe. - - This member serves a similar function to the \ref agora::rtc::IChannel::muteAllRemoteAudioStreams "muteAllRemoteAudioStreams" method. After joining the channel, - you can call the `muteAllRemoteAudioStreams` method to set whether to subscribe to audio streams in the channel. - */ - bool autoSubscribeAudio; - /** Determines whether to subscribe to video streams when the user joins the channel: - - true: (Default) Subscribe. - - false: Do not subscribe. - - This member serves a similar function to the \ref agora::rtc::IChannel::muteAllRemoteVideoStreams "muteAllRemoteVideoStreams" method. After joining the channel, - you can call the `muteAllRemoteVideoStreams` method to set whether to subscribe to video streams in the channel. - */ - bool autoSubscribeVideo; - ChannelMediaOptions() - : autoSubscribeAudio(true) - , autoSubscribeVideo(true) - {} -}; /** The IChannel class. */ class IChannel; /** The IChannelEventHandler class. */ -class IChannelEventHandler -{ -public: - virtual ~IChannelEventHandler() {} - /** Reports the warning code of `IChannel`. - - @param rtcChannel IChannel - @param warn The warning code: #WARN_CODE_TYPE - @param msg The warning message. - - */ - virtual void onChannelWarning(IChannel *rtcChannel, int warn, const char* msg) { - (void)rtcChannel; - (void)warn; - (void)msg; - } - /** Reports the error code of `IChannel`. - - @param rtcChannel IChannel - @param err The error code: #ERROR_CODE_TYPE - @param msg The error message. - */ - virtual void onChannelError(IChannel *rtcChannel, int err, const char* msg) { - (void)rtcChannel; - (void)err; - (void)msg; - } - /** Occurs when a user joins a channel. - - This callback notifies the application that a user joins a specified channel. - - @param rtcChannel IChannel - @param uid The user ID. If the `uid` is not specified in the \ref IChannel::joinChannel "joinChannel" method, the server automatically assigns a `uid`. - - @param elapsed Time elapsed (ms) from the local user calling \ref IChannel::joinChannel "joinChannel" until this callback is triggered. - */ - virtual void onJoinChannelSuccess(IChannel *rtcChannel, uid_t uid, int elapsed) { - (void)rtcChannel; - (void)uid; - (void)elapsed; - } - /** Occurs when a user rejoins the channel after being disconnected due to network problems. - - @param rtcChannel IChannel - @param uid The user ID. - @param elapsed Time elapsed (ms) from the local user starting to reconnect until this callback is triggered. - - */ - virtual void onRejoinChannelSuccess(IChannel *rtcChannel, uid_t uid, int elapsed) { - (void)rtcChannel; - (void)uid; - (void)elapsed; - } - /** Occurs when a user leaves the channel. - - This callback notifies the application that a user leaves the channel when the application calls the \ref agora::rtc::IChannel::leaveChannel "leaveChannel" method. - - The application retrieves information, such as the call duration and statistics. - - @param rtcChannel IChannel - @param stats The call statistics: RtcStats. - */ - virtual void onLeaveChannel(IChannel *rtcChannel, const RtcStats& stats) { - (void)rtcChannel; - (void)stats; - } - /** Occurs when the user role switches in the live interactive streaming. For example, from a host to an audience or vice versa. - - This callback notifies the application of a user role switch when the application calls the \ref IChannel::setClientRole "setClientRole" method. - - The SDK triggers this callback when the local user switches the user role by calling the \ref IChannel::setClientRole "setClientRole" method after joining the channel. - - @param rtcChannel IChannel - @param oldRole Role that the user switches from: #CLIENT_ROLE_TYPE. - @param newRole Role that the user switches to: #CLIENT_ROLE_TYPE. - */ - virtual void onClientRoleChanged(IChannel *rtcChannel, CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole) { - (void)rtcChannel; - (void)oldRole; - (void)newRole; - } - /** Occurs when a remote user (`COMMUNICATION`)/ host (`LIVE_BROADCASTING`) joins the channel. - - - `COMMUNICATION` profile: This callback notifies the application that another user joins the channel. If other users are already in the channel, the SDK also reports to the application on the existing users. - - `LIVE_BROADCASTING` profile: This callback notifies the application that the host joins the channel. If other hosts are already in the channel, the SDK also reports to the application on the existing hosts. We recommend limiting the number of hosts to 17. - - The SDK triggers this callback under one of the following circumstances: - - A remote user/host joins the channel by calling the \ref agora::rtc::IChannel::joinChannel "joinChannel" method. - - A remote user switches the user role to the host by calling the \ref agora::rtc::IChannel::setClientRole "setClientRole" method after joining the channel. - - A remote user/host rejoins the channel after a network interruption. - - The host injects an online media stream into the channel by calling the \ref agora::rtc::IChannel::addInjectStreamUrl "addInjectStreamUrl" method. - - @note In the `LIVE_BROADCASTING` profile: - - The host receives this callback when another host joins the channel. - - The audience in the channel receives this callback when a new host joins the channel. - - When a web application joins the channel, the SDK triggers this callback as long as the web application publishes streams. - - @param rtcChannel IChannel - @param uid User ID of the user or host joining the channel. - @param elapsed Time delay (ms) from the local user calling the \ref IChannel::joinChannel "joinChannel" method until the SDK triggers this callback. - */ - virtual void onUserJoined(IChannel *rtcChannel, uid_t uid, int elapsed) { - (void)rtcChannel; - (void)uid; - (void)elapsed; - } - /** Occurs when a remote user ( `COMMUNICATION`)/host (`LIVE_BROADCASTING`) leaves the channel. - - Reasons why the user is offline: - - - Leave the channel: When the user/host leaves the channel, the user/host sends a goodbye message. When the message is received, the SDK assumes that the user/host leaves the channel. - - Drop offline: When no data packet of the user or host is received for a certain period of time, the SDK assumes that the user/host drops offline. Unreliable network connections may lead to false detections, so we recommend using the Agora RTM SDK for more reliable offline detection. - - @param rtcChannel IChannel - @param uid User ID of the user leaving the channel or going offline. - @param reason Reason why the user is offline: #USER_OFFLINE_REASON_TYPE. - */ - virtual void onUserOffline(IChannel *rtcChannel, uid_t uid, USER_OFFLINE_REASON_TYPE reason) { - (void)rtcChannel; - (void)uid; - (void)reason; - } - /** Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the server is interrupted. - - The SDK triggers this callback when it cannot connect to the server 10 seconds after calling the \ref IChannel::joinChannel "joinChannel" method, whether or not it is in the channel. - - This callback is different from \ref agora::rtc::IRtcEngineEventHandler::onConnectionInterrupted "onConnectionInterrupted": - - - The SDK triggers the `onConnectionInterrupted` callback when it loses connection with the server for more than four seconds after it successfully joins the channel. - - The SDK triggers the `onConnectionLost` callback when it loses connection with the server for more than 10 seconds, whether or not it joins the channel. - - If the SDK fails to rejoin the channel 20 minutes after being disconnected from Agora's edge server, the SDK stops rejoining the channel. - - @param rtcChannel IChannel - */ - virtual void onConnectionLost(IChannel *rtcChannel) { - (void)rtcChannel; - } - /** Occurs when the token expires. - - After a token is specified by calling the \ref IChannel::joinChannel "joinChannel" method, if the SDK losses connection with the Agora server due to network issues, the token may expire after a certain period of time and a new token may be required to reconnect to the server. - - Once you receive this callback, generate a new token on your app server, and call - \ref agora::rtc::IChannel::renewToken "renewToken" to pass the new token to the SDK. - - @param rtcChannel IChannel - */ - virtual void onRequestToken(IChannel *rtcChannel) { - (void)rtcChannel; - } - /** Occurs when the token expires in 30 seconds. - - The user becomes offline if the token used in the \ref IChannel::joinChannel "joinChannel" method expires. The SDK triggers this callback 30 seconds before the token expires to remind the application to get a new token. Upon receiving this callback, generate a new token on the server and call the \ref IChannel::renewToken "renewToken" method to pass the new token to the SDK. - - @param rtcChannel IChannel - @param token Token that expires in 30 seconds. - */ - virtual void onTokenPrivilegeWillExpire(IChannel *rtcChannel, const char* token) { - (void)rtcChannel; - (void)token; - } - /** Reports the statistics of the current call. - - The SDK triggers this callback once every two seconds after the user joins the channel. - - @param rtcChannel IChannel - @param stats Statistics of the RtcEngine: RtcStats. - */ - virtual void onRtcStats(IChannel *rtcChannel, const RtcStats& stats) { - (void)rtcChannel; - (void)stats; - } - /** Reports the last mile network quality of each user in the channel once every two seconds. - - Last mile refers to the connection between the local device and Agora's edge server. This callback reports once every two seconds the last mile network conditions of each user in the channel. If a channel includes multiple users, the SDK triggers this callback as many times. - - @param rtcChannel IChannel - @param uid User ID. The network quality of the user with this @p uid is reported. If @p uid is 0, the local network quality is reported. - @param txQuality Uplink transmission quality rating of the user in terms of the transmission bitrate, packet loss rate, average RTT (Round-Trip Time), and jitter of the uplink network. @p txQuality is a quality rating helping you understand how well the current uplink network conditions can support the selected VideoEncoderConfiguration. For example, a 1000 Kbps uplink network may be adequate for video frames with a resolution of 640 * 480 and a frame rate of 15 fps in the `LIVE_BROADCASTING` profile, but may be inadequate for resolutions higher than 1280 * 720. See #QUALITY_TYPE. - @param rxQuality Downlink network quality rating of the user in terms of the packet loss rate, average RTT, and jitter of the downlink network. See #QUALITY_TYPE. - */ - virtual void onNetworkQuality(IChannel *rtcChannel, uid_t uid, int txQuality, int rxQuality) { - (void)rtcChannel; - (void)uid; - (void)txQuality; - (void)rxQuality; - } - /** Reports the statistics of the video stream from each remote user/host. - * - * The SDK triggers this callback once every two seconds for each remote - * user/host. If a channel includes multiple remote users, the SDK - * triggers this callback as many times. - * - * @param rtcChannel IChannel - * @param stats Statistics of the remote video stream. See - * RemoteVideoStats. - */ - virtual void onRemoteVideoStats(IChannel *rtcChannel, const RemoteVideoStats& stats) { - (void)rtcChannel; - (void)stats; - } - /** Reports the statistics of the audio stream from each remote user/host. - - This callback replaces the \ref agora::rtc::IRtcEngineEventHandler::onAudioQuality "onAudioQuality" callback. - - The SDK triggers this callback once every two seconds for each remote user/host. If a channel includes multiple remote users, the SDK triggers this callback as many times. - - @param rtcChannel IChannel - @param stats The statistics of the received remote audio streams. See RemoteAudioStats. - */ - virtual void onRemoteAudioStats(IChannel *rtcChannel, const RemoteAudioStats& stats) { - (void)rtcChannel; - (void)stats; - } - /** Occurs when the remote audio state changes. - - This callback indicates the state change of the remote audio stream. - @note This callback does not work properly when the number of users (in the `COMMUNICATION` profile) or hosts (in the `LIVE_BROADCASTING` profile) in the channel exceeds 17. - - @param rtcChannel IChannel - @param uid ID of the remote user whose audio state changes. - @param state State of the remote audio. See #REMOTE_AUDIO_STATE. - @param reason The reason of the remote audio state change. - See #REMOTE_AUDIO_STATE_REASON. - @param elapsed Time elapsed (ms) from the local user calling the - \ref IChannel::joinChannel "joinChannel" method until the SDK - triggers this callback. - */ - virtual void onRemoteAudioStateChanged(IChannel *rtcChannel, uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) { - (void)rtcChannel; - (void)uid; - (void)state; - (void)reason; - (void)elapsed; - } - - /** Occurs when the audio publishing state changes. - * - * @since v3.1.0 - * - * This callback indicates the publishing state change of the local audio stream. - * - * @param rtcChannel IChannel - * @param oldState The previous publishing state. For details, see #STREAM_PUBLISH_STATE. - * @param newState The current publishing state. For details, see #STREAM_PUBLISH_STATE. - * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state. - */ - virtual void onAudioPublishStateChanged(IChannel *rtcChannel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) { - (void)rtcChannel; - (void)oldState; - (void)newState; - (void)elapseSinceLastState; - } - - /** Occurs when the video publishing state changes. - * - * @since v3.1.0 - * - * This callback indicates the publishing state change of the local video stream. - * - * @param rtcChannel IChannel - * @param oldState The previous publishing state. For details, see #STREAM_PUBLISH_STATE. - * @param newState The current publishing state. For details, see #STREAM_PUBLISH_STATE. - * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state. - */ - virtual void onVideoPublishStateChanged(IChannel *rtcChannel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) { - (void)rtcChannel; - (void)oldState; - (void)newState; - (void)elapseSinceLastState; - } - - /** Occurs when the audio subscribing state changes. - * - * @since v3.1.0 - * - * This callback indicates the subscribing state change of a remote audio stream. - * - * @param rtcChannel IChannel - * @param uid The ID of the remote user. - * @param oldState The previous subscribing state. For details, see #STREAM_SUBSCRIBE_STATE. - * @param newState The current subscribing state. For details, see #STREAM_SUBSCRIBE_STATE. - * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state. - */ - virtual void onAudioSubscribeStateChanged(IChannel *rtcChannel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) { - (void)rtcChannel; - (void)uid; - (void)oldState; - (void)newState; - (void)elapseSinceLastState; - } - - /** Occurs when the audio subscribing state changes. - * - * @since v3.1.0 - * - * This callback indicates the subscribing state change of a remote video stream. - * - * @param rtcChannel IChannel - * @param uid The ID of the remote user. - * @param oldState The previous subscribing state. For details, see #STREAM_SUBSCRIBE_STATE. - * @param newState The current subscribing state. For details, see #STREAM_SUBSCRIBE_STATE. - * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state. - */ - virtual void onVideoSubscribeStateChanged(IChannel *rtcChannel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) { - (void)rtcChannel; - (void)uid; - (void)oldState; - (void)newState; - (void)elapseSinceLastState; - } - /// @cond - /** Reports whether the super-resolution algorithm is enabled. - * - * @since v3.2.0 - * - * After calling \ref IRtcChannel::enableRemoteSuperResolution "enableRemoteSuperResolution", the SDK triggers this - * callback to report whether the super-resolution algorithm is successfully enabled. If not successfully enabled, - * you can use reason for troubleshooting. - * - * @param rtcChannel IChannel - * @param uid The ID of the remote user. - * @param enabled Whether the super-resolution algorithm is successfully enabled: - * - true: The super-resolution algorithm is successfully enabled. - * - false: The super-resolution algorithm is not successfully enabled. - * @param reason The reason why the super-resolution algorithm is not successfully enabled. See #SUPER_RESOLUTION_STATE_REASON. - */ - virtual void onUserSuperResolutionEnabled(IChannel *rtcChannel, uid_t uid, bool enabled, SUPER_RESOLUTION_STATE_REASON reason) { - (void)rtcChannel; - (void)uid; - (void)enabled; - (void)reason; - } - /// @endcond - - /** Occurs when the most active speaker is detected. - - After a successful call of \ref IRtcEngine::enableAudioVolumeIndication(int, int, bool) "enableAudioVolumeIndication", - the SDK continuously detects which remote user has the loudest volume. During the current period, the remote user, - who is detected as the loudest for the most times, is the most active user. - - When the number of user is no less than two and an active speaker exists, the SDK triggers this callback and reports the `uid` of the most active speaker. - - If the most active speaker is always the same user, the SDK triggers this callback only once. - - If the most active speaker changes to another user, the SDK triggers this callback again and reports the `uid` of the new active speaker. - - @param rtcChannel IChannel - @param uid The user ID of the most active speaker. - */ - virtual void onActiveSpeaker(IChannel *rtcChannel, uid_t uid) { - (void)rtcChannel; - (void)uid; - } - /** Occurs when the video size or rotation of a specified user changes. - - @param rtcChannel IChannel - @param uid User ID of the remote user or local user (0) whose video size or rotation changes. - @param width New width (pixels) of the video. - @param height New height (pixels) of the video. - @param rotation New rotation of the video [0 to 360). - */ - virtual void onVideoSizeChanged(IChannel *rtcChannel, uid_t uid, int width, int height, int rotation) { - (void)rtcChannel; - (void)uid; - (void)width; - (void)height; - (void)rotation; - } - /** Occurs when the remote video state changes. - - @note This callback does not work properly when the number of users (in the `COMMUNICATION` profile) or hosts (in the `LIVE_BROADCASTING` profile) in the channel exceeds 17. - - @param rtcChannel IChannel - @param uid ID of the remote user whose video state changes. - @param state State of the remote video. See #REMOTE_VIDEO_STATE. - @param reason The reason of the remote video state change. See - #REMOTE_VIDEO_STATE_REASON. - @param elapsed Time elapsed (ms) from the local user calling the - \ref agora::rtc::IChannel::joinChannel "joinChannel" method until the - SDK triggers this callback. - */ - virtual void onRemoteVideoStateChanged(IChannel *rtcChannel, uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) { - (void)rtcChannel; - (void)uid; - (void)state; - (void)reason; - (void)elapsed; - } - /** Occurs when the local user receives the data stream from the remote user within five seconds. - - The SDK triggers this callback when the local user receives the stream message that the remote user sends by calling the \ref agora::rtc::IChannel::sendStreamMessage "sendStreamMessage" method. - - @param rtcChannel IChannel - @param uid User ID of the remote user sending the message. - @param streamId Stream ID. - @param data The data received by the local user. - @param length Length of the data in bytes. - */ - virtual void onStreamMessage(IChannel *rtcChannel, uid_t uid, int streamId, const char* data, size_t length) { - (void)rtcChannel; - (void)uid; - (void)streamId; - (void)data; - (void)length; - } - /** Occurs when the local user does not receive the data stream from the remote user within five seconds. - - The SDK triggers this callback when the local user fails to receive the stream message that the remote user sends by calling the \ref agora::rtc::IChannel::sendStreamMessage "sendStreamMessage" method. - - @param rtcChannel IChannel - @param uid User ID of the remote user sending the message. - @param streamId Stream ID. - @param code Error code: #ERROR_CODE_TYPE. - @param missed Number of lost messages. - @param cached Number of incoming cached messages when the data stream is interrupted. - */ - virtual void onStreamMessageError(IChannel *rtcChannel, uid_t uid, int streamId, int code, int missed, int cached) { - (void)rtcChannel; - (void)uid; - (void)streamId; - (void)code; - (void)missed; - (void)cached; - } - /** Occurs when the state of the media stream relay changes. - * - * The SDK returns the state of the current media relay with any error - * message. - * @param rtcChannel IChannel - * @param state The state code in #CHANNEL_MEDIA_RELAY_STATE. - * @param code The error code in #CHANNEL_MEDIA_RELAY_ERROR. - */ - virtual void onChannelMediaRelayStateChanged(IChannel *rtcChannel, CHANNEL_MEDIA_RELAY_STATE state,CHANNEL_MEDIA_RELAY_ERROR code) { - (void)rtcChannel; - (void)state; - (void)code; - } - /** Reports events during the media stream relay. - * @param rtcChannel IChannel - * @param code The event code in #CHANNEL_MEDIA_RELAY_EVENT. - */ - virtual void onChannelMediaRelayEvent(IChannel *rtcChannel, CHANNEL_MEDIA_RELAY_EVENT code) { - (void)rtcChannel; - (void)code; - } - /** - Occurs when the state of the RTMP streaming changes. - - The SDK triggers this callback to report the result of the local user calling the \ref agora::rtc::IChannel::addPublishStreamUrl "addPublishStreamUrl" or \ref agora::rtc::IChannel::removePublishStreamUrl "removePublishStreamUrl" method. - - This callback indicates the state of the RTMP streaming. When exceptions occur, you can troubleshoot issues by referring to the detailed error descriptions in the *errCode* parameter. - - @param rtcChannel IChannel - @param url The RTMP URL address. - @param state The RTMP streaming state. See: #RTMP_STREAM_PUBLISH_STATE. - @param errCode The detailed error information for streaming. See: #RTMP_STREAM_PUBLISH_ERROR. - */ - virtual void onRtmpStreamingStateChanged(IChannel *rtcChannel, const char *url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_ERROR errCode) { - (void)rtcChannel; - (void) url; - (RTMP_STREAM_PUBLISH_STATE) state; - (RTMP_STREAM_PUBLISH_ERROR) errCode; - } - - /** Reports events during the RTMP streaming. - * - * @since v3.1.0 - * - * @param rtcChannel IChannel - * @param url The RTMP streaming URL. - * @param eventCode The event code. See #RTMP_STREAMING_EVENT - */ - virtual void onRtmpStreamingEvent(IChannel *rtcChannel, const char* url, RTMP_STREAMING_EVENT eventCode) { - (void) rtcChannel; - (void) url; - (RTMP_STREAMING_EVENT) eventCode; - } - - /** Occurs when the publisher's transcoding is updated. - - When the `LiveTranscoding` class in the \ref agora::rtc::IChannel::setLiveTranscoding "setLiveTranscoding" method updates, the SDK triggers the `onTranscodingUpdated` callback to report the update information to the local host. - - @note If you call the `setLiveTranscoding` method to set the LiveTranscoding class for the first time, the SDK does not trigger the `onTranscodingUpdated` callback. - - @param rtcChannel IChannel - */ - virtual void onTranscodingUpdated(IChannel *rtcChannel) { - (void)rtcChannel; - } - /** Occurs when a voice or video stream URL address is added to the live interactive streaming. - - @param rtcChannel IChannel - @param url The URL address of the externally injected stream. - @param uid User ID. - @param status State of the externally injected stream: #INJECT_STREAM_STATUS. - */ - virtual void onStreamInjectedStatus(IChannel *rtcChannel, const char* url, uid_t uid, int status) { - (void)rtcChannel; - (void)url; - (void)uid; - (void)status; - } - /** Occurs when the published media stream falls back to an audio-only stream due to poor network conditions or switches back to the video after the network conditions improve. - - If you call \ref IRtcEngine::setLocalPublishFallbackOption "setLocalPublishFallbackOption" and set *option* as #STREAM_FALLBACK_OPTION_AUDIO_ONLY, the SDK triggers this callback when the published stream falls back to audio-only mode due to poor uplink conditions, or when the audio stream switches back to the video after the uplink network condition improves. +class IChannelEventHandler { + public: + virtual ~IChannelEventHandler() {} + /** Reports the warning code of `IChannel`. + + @param rtcChannel IChannel + @param warn The warning code: #WARN_CODE_TYPE + @param msg The warning message. + + */ + virtual void onChannelWarning(IChannel* rtcChannel, int warn, const char* msg) { + (void)rtcChannel; + (void)warn; + (void)msg; + } + /** Reports the error code of `IChannel`. + + @param rtcChannel IChannel + @param err The error code: #ERROR_CODE_TYPE + @param msg The error message. + */ + virtual void onChannelError(IChannel* rtcChannel, int err, const char* msg) { + (void)rtcChannel; + (void)err; + (void)msg; + } + /** Occurs when a user joins a channel. + + This callback notifies the application that a user joins a specified channel. + + @param rtcChannel IChannel + @param uid The user ID. If the `uid` is not specified in the \ref IChannel::joinChannel "joinChannel" method, the server automatically assigns a `uid`. + + @param elapsed Time elapsed (ms) from the local user calling \ref IChannel::joinChannel "joinChannel" until this callback is triggered. + */ + virtual void onJoinChannelSuccess(IChannel* rtcChannel, uid_t uid, int elapsed) { + (void)rtcChannel; + (void)uid; + (void)elapsed; + } + /** Occurs when a user rejoins the channel after being disconnected due to network problems. + + @param rtcChannel IChannel + @param uid The user ID. + @param elapsed Time elapsed (ms) from the local user starting to reconnect until this callback is triggered. + + */ + virtual void onRejoinChannelSuccess(IChannel* rtcChannel, uid_t uid, int elapsed) { + (void)rtcChannel; + (void)uid; + (void)elapsed; + } + /** Occurs when a user leaves the channel. + + This callback notifies the application that a user leaves the channel when the application calls the \ref agora::rtc::IChannel::leaveChannel "leaveChannel" method. + + The application gets information, such as the call duration and statistics. + + @param rtcChannel IChannel + @param stats The call statistics: RtcStats. + */ + virtual void onLeaveChannel(IChannel* rtcChannel, const RtcStats& stats) { + (void)rtcChannel; + (void)stats; + } + /** Occurs when the user role switches in the interactive live streaming. For example, from a host to an audience or vice versa. + + This callback notifies the application of a user role switch when the application calls the \ref IChannel::setClientRole "setClientRole" method. + + The SDK triggers this callback when the local user switches the user role by calling the \ref IChannel::setClientRole "setClientRole" method after joining the channel. + + @param rtcChannel IChannel + @param oldRole Role that the user switches from: #CLIENT_ROLE_TYPE. + @param newRole Role that the user switches to: #CLIENT_ROLE_TYPE. + */ + virtual void onClientRoleChanged(IChannel* rtcChannel, CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole) { + (void)rtcChannel; + (void)oldRole; + (void)newRole; + } + /** Occurs when a remote user (`COMMUNICATION`)/ host (`LIVE_BROADCASTING`) joins the channel. + + - `COMMUNICATION` profile: This callback notifies the application that another user joins the channel. If other users are already in the channel, the SDK also reports to the application on the existing users. + - `LIVE_BROADCASTING` profile: This callback notifies the application that the host joins the channel. If other hosts are already in the channel, the SDK also reports to the application on the existing hosts. We recommend limiting the number of hosts to 17. + + The SDK triggers this callback under one of the following circumstances: + - A remote user/host joins the channel by calling the \ref agora::rtc::IChannel::joinChannel "joinChannel" method. + - A remote user switches the user role to the host by calling the \ref agora::rtc::IChannel::setClientRole "setClientRole" method after joining the channel. + - A remote user/host rejoins the channel after a network interruption. + - The host injects an online media stream into the channel by calling the \ref agora::rtc::IChannel::addInjectStreamUrl "addInjectStreamUrl" method. + + @note In the `LIVE_BROADCASTING` profile: + - The host receives this callback when another host joins the channel. + - The audience in the channel receives this callback when a new host joins the channel. + - When a web application joins the channel, the SDK triggers this callback as long as the web application publishes streams. + + @param rtcChannel IChannel + @param uid User ID of the user or host joining the channel. + @param elapsed Time delay (ms) from the local user calling the \ref IChannel::joinChannel "joinChannel" method until the SDK triggers this callback. + */ + virtual void onUserJoined(IChannel* rtcChannel, uid_t uid, int elapsed) { + (void)rtcChannel; + (void)uid; + (void)elapsed; + } + /** Occurs when a remote user ( `COMMUNICATION`)/host (`LIVE_BROADCASTING`) leaves the channel. + + Reasons why the user is offline: + + - Leave the channel: When the user/host leaves the channel, the user/host sends a goodbye message. When the message is received, the SDK assumes that the user/host leaves the channel. + - Drop offline: When no data packet of the user or host is received for a certain period of time, the SDK assumes that the user/host drops offline. Unreliable network connections may lead to false detections, so we recommend using the Agora RTM SDK for more reliable offline detection. + + @param rtcChannel IChannel + @param uid User ID of the user leaving the channel or going offline. + @param reason Reason why the user is offline: #USER_OFFLINE_REASON_TYPE. + */ + virtual void onUserOffline(IChannel* rtcChannel, uid_t uid, USER_OFFLINE_REASON_TYPE reason) { + (void)rtcChannel; + (void)uid; + (void)reason; + } + /** Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the server is interrupted. + + The SDK triggers this callback when it cannot connect to the server 10 seconds after calling the \ref IChannel::joinChannel "joinChannel" method, whether or not it is in the channel. + + This callback is different from \ref agora::rtc::IRtcEngineEventHandler::onConnectionInterrupted "onConnectionInterrupted": + + - The SDK triggers the `onConnectionInterrupted` callback when it loses connection with the server for more than four seconds after it successfully joins the channel. + - The SDK triggers the `onConnectionLost` callback when it loses connection with the server for more than 10 seconds, whether or not it joins the channel. + + If the SDK fails to rejoin the channel 20 minutes after being disconnected from Agora's edge server, the SDK stops rejoining the channel. + + @param rtcChannel IChannel + */ + virtual void onConnectionLost(IChannel* rtcChannel) { (void)rtcChannel; } + /** Occurs when the token expires. + + After a token is specified by calling the \ref IChannel::joinChannel "joinChannel" method, if the SDK losses connection with the Agora server due to network issues, the token may expire after a certain period of time and a new token may be required to reconnect to the server. + + Once you receive this callback, generate a new token on your app server, and call + \ref agora::rtc::IChannel::renewToken "renewToken" to pass the new token to the SDK. + + @param rtcChannel IChannel + */ + virtual void onRequestToken(IChannel* rtcChannel) { (void)rtcChannel; } + /** Occurs when the token expires in 30 seconds. + + The user becomes offline if the token used in the \ref IChannel::joinChannel "joinChannel" method expires. The SDK triggers this callback 30 seconds before the token expires to remind the application to get a new token. Upon receiving this callback, generate a new token on the server and call the \ref IChannel::renewToken "renewToken" method to pass the new token to the SDK. + + @param rtcChannel IChannel + @param token Token that expires in 30 seconds. + */ + virtual void onTokenPrivilegeWillExpire(IChannel* rtcChannel, const char* token) { + (void)rtcChannel; + (void)token; + } + /** Reports the statistics of the current call. + + The SDK triggers this callback once every two seconds after the user joins the channel. + + @param rtcChannel IChannel + @param stats Statistics of the RtcEngine: RtcStats. + */ + virtual void onRtcStats(IChannel* rtcChannel, const RtcStats& stats) { + (void)rtcChannel; + (void)stats; + } + /** Reports the last mile network quality of each user in the channel once every two seconds. + + Last mile refers to the connection between the local device and Agora's edge server. This callback reports once every two seconds the last mile network conditions of each user in the channel. If a channel includes multiple users, the SDK triggers this callback as many times. + + @param rtcChannel IChannel + @param uid User ID. The network quality of the user with this @p uid is reported. If @p uid is 0, the local network quality is reported. + @param txQuality Uplink transmission quality rating of the user in terms of the transmission bitrate, packet loss rate, average RTT (Round-Trip Time), and jitter of the uplink network. @p txQuality is a quality rating helping you understand how well the current uplink network conditions can support the selected VideoEncoderConfiguration. For example, a 1000 Kbps uplink network may be adequate for video frames with a resolution of 640 * 480 and a frame rate of 15 fps in the `LIVE_BROADCASTING` profile, but may be inadequate for resolutions higher than 1280 * 720. See #QUALITY_TYPE. + @param rxQuality Downlink network quality rating of the user in terms of the packet loss rate, average RTT, and jitter of the downlink network. See #QUALITY_TYPE. + */ + virtual void onNetworkQuality(IChannel* rtcChannel, uid_t uid, int txQuality, int rxQuality) { + (void)rtcChannel; + (void)uid; + (void)txQuality; + (void)rxQuality; + } + /** Reports the statistics of the video stream from each remote user/host. + * + * The SDK triggers this callback once every two seconds for each remote + * user/host. If a channel includes multiple remote users, the SDK + * triggers this callback as many times. + * + * @param rtcChannel IChannel + * @param stats Statistics of the remote video stream. See + * RemoteVideoStats. + */ + virtual void onRemoteVideoStats(IChannel* rtcChannel, const RemoteVideoStats& stats) { + (void)rtcChannel; + (void)stats; + } + /** Reports the statistics of the audio stream from each remote user/host. + + This callback replaces the \ref agora::rtc::IRtcEngineEventHandler::onAudioQuality "onAudioQuality" callback. + + The SDK triggers this callback once every two seconds for each remote user/host. If a channel includes multiple remote users, the SDK triggers this callback as many times. + + @param rtcChannel IChannel + @param stats The statistics of the received remote audio streams. See RemoteAudioStats. + */ + virtual void onRemoteAudioStats(IChannel* rtcChannel, const RemoteAudioStats& stats) { + (void)rtcChannel; + (void)stats; + } + /** Occurs when the remote audio state changes. + + This callback indicates the state change of the remote audio stream. + @note This callback does not work properly when the number of users (in the `COMMUNICATION` profile) or hosts (in the `LIVE_BROADCASTING` profile) in the channel exceeds 17. @param rtcChannel IChannel - @param isFallbackOrRecover Whether the published stream falls back to audio-only or switches back to the video: - - true: The published stream falls back to audio-only due to poor network conditions. - - false: The published stream switches back to the video after the network conditions improve. - */ - virtual void onLocalPublishFallbackToAudioOnly(IChannel *rtcChannel, bool isFallbackOrRecover) { - (void)rtcChannel; - (void)isFallbackOrRecover; - } - /** Occurs when the remote media stream falls back to audio-only stream - * due to poor network conditions or switches back to the video stream - * after the network conditions improve. - * - * If you call - * \ref IRtcEngine::setRemoteSubscribeFallbackOption - * "setRemoteSubscribeFallbackOption" and set - * @p option as #STREAM_FALLBACK_OPTION_AUDIO_ONLY, the SDK triggers this - * callback when the remote media stream falls back to audio-only mode due - * to poor uplink conditions, or when the remote media stream switches - * back to the video after the uplink network condition improves. - * - * @note Once the remote media stream switches to the low stream due to - * poor network conditions, you can monitor the stream switch between a - * high and low stream in the RemoteVideoStats callback. - * @param rtcChannel IChannel - * @param uid ID of the remote user sending the stream. - * @param isFallbackOrRecover Whether the remotely subscribed media stream - * falls back to audio-only or switches back to the video: - * - true: The remotely subscribed media stream falls back to audio-only - * due to poor network conditions. - * - false: The remotely subscribed media stream switches back to the - * video stream after the network conditions improved. - */ - virtual void onRemoteSubscribeFallbackToAudioOnly(IChannel *rtcChannel, uid_t uid, bool isFallbackOrRecover) { - (void)rtcChannel; - (void)uid; - (void)isFallbackOrRecover; - } - /** Occurs when the connection state between the SDK and the server changes. - - @param rtcChannel IChannel - @param state See #CONNECTION_STATE_TYPE. - @param reason See #CONNECTION_CHANGED_REASON_TYPE. - */ - virtual void onConnectionStateChanged(IChannel *rtcChannel, - CONNECTION_STATE_TYPE state, - CONNECTION_CHANGED_REASON_TYPE reason) { - (void)rtcChannel; - (void)state; - (void)reason; - } + @param uid ID of the remote user whose audio state changes. + @param state State of the remote audio. See #REMOTE_AUDIO_STATE. + @param reason The reason of the remote audio state change. + See #REMOTE_AUDIO_STATE_REASON. + @param elapsed Time elapsed (ms) from the local user calling the + \ref IChannel::joinChannel "joinChannel" method until the SDK + triggers this callback. + */ + virtual void onRemoteAudioStateChanged(IChannel* rtcChannel, uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) { + (void)rtcChannel; + (void)uid; + (void)state; + (void)reason; + (void)elapsed; + } + + /** Occurs when the audio publishing state changes. + * + * @since v3.1.0 + * + * This callback indicates the publishing state change of the local audio stream. + * + * @param rtcChannel IChannel + * @param oldState The previous publishing state. For details, see #STREAM_PUBLISH_STATE. + * @param newState The current publishing state. For details, see #STREAM_PUBLISH_STATE. + * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state. + */ + virtual void onAudioPublishStateChanged(IChannel* rtcChannel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) { + (void)rtcChannel; + (void)oldState; + (void)newState; + (void)elapseSinceLastState; + } + + /** Occurs when the video publishing state changes. + * + * @since v3.1.0 + * + * This callback indicates the publishing state change of the local video stream. + * + * @param rtcChannel IChannel + * @param oldState The previous publishing state. For details, see #STREAM_PUBLISH_STATE. + * @param newState The current publishing state. For details, see #STREAM_PUBLISH_STATE. + * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state. + */ + virtual void onVideoPublishStateChanged(IChannel* rtcChannel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) { + (void)rtcChannel; + (void)oldState; + (void)newState; + (void)elapseSinceLastState; + } + + /** Occurs when the audio subscribing state changes. + * + * @since v3.1.0 + * + * This callback indicates the subscribing state change of a remote audio stream. + * + * @param rtcChannel IChannel + * @param uid The ID of the remote user. + * @param oldState The previous subscribing state. For details, see #STREAM_SUBSCRIBE_STATE. + * @param newState The current subscribing state. For details, see #STREAM_SUBSCRIBE_STATE. + * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state. + */ + virtual void onAudioSubscribeStateChanged(IChannel* rtcChannel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) { + (void)rtcChannel; + (void)uid; + (void)oldState; + (void)newState; + (void)elapseSinceLastState; + } + + /** Occurs when the audio subscribing state changes. + * + * @since v3.1.0 + * + * This callback indicates the subscribing state change of a remote video stream. + * + * @param rtcChannel IChannel + * @param uid The ID of the remote user. + * @param oldState The previous subscribing state. For details, see #STREAM_SUBSCRIBE_STATE. + * @param newState The current subscribing state. For details, see #STREAM_SUBSCRIBE_STATE. + * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state. + */ + virtual void onVideoSubscribeStateChanged(IChannel* rtcChannel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) { + (void)rtcChannel; + (void)uid; + (void)oldState; + (void)newState; + (void)elapseSinceLastState; + } + /// @cond + /** Reports whether the super-resolution algorithm is enabled. + * + * @since v3.2.0 + * + * After calling \ref IRtcChannel::enableRemoteSuperResolution "enableRemoteSuperResolution", the SDK triggers this + * callback to report whether the super-resolution algorithm is successfully enabled. If not successfully enabled, + * you can use reason for troubleshooting. + * + * @param rtcChannel IChannel + * @param uid The ID of the remote user. + * @param enabled Whether the super-resolution algorithm is successfully enabled: + * - true: The super-resolution algorithm is successfully enabled. + * - false: The super-resolution algorithm is not successfully enabled. + * @param reason The reason why the super-resolution algorithm is not successfully enabled. See #SUPER_RESOLUTION_STATE_REASON. + */ + virtual void onUserSuperResolutionEnabled(IChannel* rtcChannel, uid_t uid, bool enabled, SUPER_RESOLUTION_STATE_REASON reason) { + (void)rtcChannel; + (void)uid; + (void)enabled; + (void)reason; + } + /// @endcond + + /** Occurs when the most active speaker is detected. + + After a successful call of \ref IRtcEngine::enableAudioVolumeIndication(int, int, bool) "enableAudioVolumeIndication", + the SDK continuously detects which remote user has the loudest volume. During the current period, the remote user, + who is detected as the loudest for the most times, is the most active user. + + When the number of user is no less than two and an active speaker exists, the SDK triggers this callback and reports the `uid` of the most active speaker. + - If the most active speaker is always the same user, the SDK triggers this callback only once. + - If the most active speaker changes to another user, the SDK triggers this callback again and reports the `uid` of the new active speaker. + + @param rtcChannel IChannel + @param uid The user ID of the most active speaker. + */ + virtual void onActiveSpeaker(IChannel* rtcChannel, uid_t uid) { + (void)rtcChannel; + (void)uid; + } + /** Occurs when the video size or rotation of a specified user changes. + + @param rtcChannel IChannel + @param uid User ID of the remote user or local user (0) whose video size or rotation changes. + @param width New width (pixels) of the video. + @param height New height (pixels) of the video. + @param rotation New rotation of the video [0 to 360). + */ + virtual void onVideoSizeChanged(IChannel* rtcChannel, uid_t uid, int width, int height, int rotation) { + (void)rtcChannel; + (void)uid; + (void)width; + (void)height; + (void)rotation; + } + /** Occurs when the remote video state changes. + + @note This callback does not work properly when the number of users (in the `COMMUNICATION` profile) or hosts (in the `LIVE_BROADCASTING` profile) in the channel exceeds 17. + + @param rtcChannel IChannel + @param uid ID of the remote user whose video state changes. + @param state State of the remote video. See #REMOTE_VIDEO_STATE. + @param reason The reason of the remote video state change. See + #REMOTE_VIDEO_STATE_REASON. + @param elapsed Time elapsed (ms) from the local user calling the + \ref agora::rtc::IChannel::joinChannel "joinChannel" method until the + SDK triggers this callback. + */ + virtual void onRemoteVideoStateChanged(IChannel* rtcChannel, uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) { + (void)rtcChannel; + (void)uid; + (void)state; + (void)reason; + (void)elapsed; + } + /** Occurs when the local user receives the data stream from the remote user within five seconds. + + The SDK triggers this callback when the local user receives the stream message that the remote user sends by calling the \ref agora::rtc::IChannel::sendStreamMessage "sendStreamMessage" method. + + @param rtcChannel IChannel + @param uid User ID of the remote user sending the message. + @param streamId Stream ID. + @param data The data received by the local user. + @param length Length of the data in bytes. + */ + virtual void onStreamMessage(IChannel* rtcChannel, uid_t uid, int streamId, const char* data, size_t length) { + (void)rtcChannel; + (void)uid; + (void)streamId; + (void)data; + (void)length; + } + /** Occurs when the local user does not receive the data stream from the remote user within five seconds. + + The SDK triggers this callback when the local user fails to receive the stream message that the remote user sends by calling the \ref agora::rtc::IChannel::sendStreamMessage "sendStreamMessage" method. + + @param rtcChannel IChannel + @param uid User ID of the remote user sending the message. + @param streamId Stream ID. + @param code Error code: #ERROR_CODE_TYPE. + @param missed Number of lost messages. + @param cached Number of incoming cached messages when the data stream is interrupted. + */ + virtual void onStreamMessageError(IChannel* rtcChannel, uid_t uid, int streamId, int code, int missed, int cached) { + (void)rtcChannel; + (void)uid; + (void)streamId; + (void)code; + (void)missed; + (void)cached; + } + /** Occurs when the state of the media stream relay changes. + * + * The SDK returns the state of the current media relay with any error + * message. + * @param rtcChannel IChannel + * @param state The state code in #CHANNEL_MEDIA_RELAY_STATE. + * @param code The error code in #CHANNEL_MEDIA_RELAY_ERROR. + */ + virtual void onChannelMediaRelayStateChanged(IChannel* rtcChannel, CHANNEL_MEDIA_RELAY_STATE state, CHANNEL_MEDIA_RELAY_ERROR code) { + (void)rtcChannel; + (void)state; + (void)code; + } + /** Reports events during the media stream relay. + * @param rtcChannel IChannel + * @param code The event code in #CHANNEL_MEDIA_RELAY_EVENT. + */ + virtual void onChannelMediaRelayEvent(IChannel* rtcChannel, CHANNEL_MEDIA_RELAY_EVENT code) { + (void)rtcChannel; + (void)code; + } + /** + Occurs when the state of the RTMP or RTMPS streaming changes. + + The SDK triggers this callback to report the result of the local user calling the \ref agora::rtc::IChannel::addPublishStreamUrl "addPublishStreamUrl" or \ref agora::rtc::IChannel::removePublishStreamUrl "removePublishStreamUrl" method. + + This callback indicates the state of the RTMP or RTMPS streaming. When exceptions occur, you can troubleshoot issues by referring to the detailed error descriptions in the *errCode* parameter. + + @param rtcChannel IChannel + @param url The CDN streaming URL. + @param state The RTMP or RTMPS streaming state. See: #RTMP_STREAM_PUBLISH_STATE. + @param errCode The detailed error information for streaming. See: #RTMP_STREAM_PUBLISH_ERROR. + */ + virtual void onRtmpStreamingStateChanged(IChannel* rtcChannel, const char* url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_ERROR errCode) { + (void)rtcChannel; + (void)url; + (RTMP_STREAM_PUBLISH_STATE) state; + (RTMP_STREAM_PUBLISH_ERROR) errCode; + } + + /** Reports events during the RTMP or RTMPS streaming. + * + * @since v3.1.0 + * + * @param rtcChannel IChannel + * @param url The RTMP or RTMPS streaming URL. + * @param eventCode The event code. See #RTMP_STREAMING_EVENT + */ + virtual void onRtmpStreamingEvent(IChannel* rtcChannel, const char* url, RTMP_STREAMING_EVENT eventCode) { + (void)rtcChannel; + (void)url; + (RTMP_STREAMING_EVENT) eventCode; + } + + /** Occurs when the publisher's transcoding is updated. + + When the `LiveTranscoding` class in the \ref agora::rtc::IChannel::setLiveTranscoding "setLiveTranscoding" method updates, the SDK triggers the `onTranscodingUpdated` callback to report the update information to the local host. + + @note If you call the `setLiveTranscoding` method to set the LiveTranscoding class for the first time, the SDK does not trigger the `onTranscodingUpdated` callback. + + @param rtcChannel IChannel + */ + virtual void onTranscodingUpdated(IChannel* rtcChannel) { (void)rtcChannel; } + /** Occurs when a voice or video stream URL address is added to the interactive live streaming. + + @warning Agora will soon stop the service for injecting online media streams on the client. If you have not implemented this service, Agora recommends that you do not use it. + + @param rtcChannel IChannel + @param url The URL address of the externally injected stream. + @param uid User ID. + @param status State of the externally injected stream: #INJECT_STREAM_STATUS. + */ + virtual void onStreamInjectedStatus(IChannel* rtcChannel, const char* url, uid_t uid, int status) { + (void)rtcChannel; + (void)url; + (void)uid; + (void)status; + } + /** Occurs when the published media stream falls back to an audio-only stream due to poor network conditions or switches back to the video after the network conditions improve. + + If you call \ref IRtcEngine::setLocalPublishFallbackOption "setLocalPublishFallbackOption" and set *option* as #STREAM_FALLBACK_OPTION_AUDIO_ONLY, the SDK triggers this callback when the published stream falls back to audio-only mode due to poor uplink conditions, or when the audio stream switches back to the video after the uplink network condition improves. + + @param rtcChannel IChannel + @param isFallbackOrRecover Whether the published stream falls back to audio-only or switches back to the video: + - true: The published stream falls back to audio-only due to poor network conditions. + - false: The published stream switches back to the video after the network conditions improve. + */ + virtual void onLocalPublishFallbackToAudioOnly(IChannel* rtcChannel, bool isFallbackOrRecover) { + (void)rtcChannel; + (void)isFallbackOrRecover; + } + /** Occurs when the remote media stream falls back to audio-only stream + * due to poor network conditions or switches back to the video stream + * after the network conditions improve. + * + * If you call + * \ref IRtcEngine::setRemoteSubscribeFallbackOption + * "setRemoteSubscribeFallbackOption" and set + * @p option as #STREAM_FALLBACK_OPTION_AUDIO_ONLY, the SDK triggers this + * callback when the remote media stream falls back to audio-only mode due + * to poor uplink conditions, or when the remote media stream switches + * back to the video after the uplink network condition improves. + * + * @note Once the remote media stream switches to the low stream due to + * poor network conditions, you can monitor the stream switch between a + * high and low stream in the RemoteVideoStats callback. + * @param rtcChannel IChannel + * @param uid ID of the remote user sending the stream. + * @param isFallbackOrRecover Whether the remotely subscribed media stream + * falls back to audio-only or switches back to the video: + * - true: The remotely subscribed media stream falls back to audio-only + * due to poor network conditions. + * - false: The remotely subscribed media stream switches back to the + * video stream after the network conditions improved. + */ + virtual void onRemoteSubscribeFallbackToAudioOnly(IChannel* rtcChannel, uid_t uid, bool isFallbackOrRecover) { + (void)rtcChannel; + (void)uid; + (void)isFallbackOrRecover; + } + /** Occurs when the connection state between the SDK and the server changes. + + @param rtcChannel IChannel + @param state See #CONNECTION_STATE_TYPE. + @param reason See #CONNECTION_CHANGED_REASON_TYPE. + */ + virtual void onConnectionStateChanged(IChannel* rtcChannel, CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason) { + (void)rtcChannel; + (void)state; + (void)reason; + } }; /** The IChannel class. */ -class IChannel -{ -public: - virtual ~IChannel() {} - /** Releases all IChannel resources. - - @return - - 0: Success. - - < 0: Failure. - - `ERR_NOT_INITIALIZED (7)`: The SDK is not initialized before calling this method. - */ - virtual int release() = 0; - /** Sets the channel event handler. - - After setting the channel event handler, you can listen for channel events and receive the statistics of the corresponding `IChannel` object. - - @param channelEh The event handler of the `IChannel` object. For details, see IChannelEventHandler. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setChannelEventHandler(IChannelEventHandler *channelEh) = 0; - /** Joins the channel with a user ID. - - This method differs from the `joinChannel` method in the `IRtcEngine` class in the following aspects: - - | IChannel::joinChannel | IRtcEngine::joinChannel | - |------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| - | Does not contain the `channelId` parameter, because `channelId` is specified when creating the `IChannel` object. | Contains the `channelId` parameter, which specifies the channel to join. | - | Contains the `options` parameter, which decides whether to subscribe to all streams before joining the channel. | Does not contain the `options` parameter. By default, users subscribe to all streams when joining the channel. | - | Users can join multiple channels simultaneously by creating multiple `IChannel` objects and calling the `joinChannel` method of each object. | Users can join only one channel. | - | By default, the SDK does not publish any stream after the user joins the channel. You need to call the publish method to do that. | By default, the SDK publishes streams once the user joins the channel. | - - @note - - If you are already in a channel, you cannot rejoin it with the same `uid`. - - We recommend using different UIDs for different channels. - - If you want to join the same channel from different devices, ensure that the UIDs in all devices are different. - - Ensure that the app ID you use to generate the token is the same with the app ID used when creating the `IRtcEngine` object. - - @param token The token for authentication: - - In situations not requiring high security: You can use the temporary token generated at Console. For details, see [Get a temporary token](https://docs.agora.io/en/Agora%20Platform/token?platform=All%20Platforms#generate-a-token). - - In situations requiring high security: Set it as the token generated at your server. For details, see [Generate a token](https://docs.agora.io/en/Interactive%20Broadcast/token_server?platform=All%20Platforms). - @param info (Optional) Additional information about the channel. This parameter can be set as null. Other users in the channel do not receive this information. - @param uid The user ID. A 32-bit unsigned integer with a value ranging from 1 to (232-1). This parameter must be unique. If `uid` is not assigned (or set as `0`), the SDK assigns a `uid` and reports it in the \ref agora::rtc::IChannelEventHandler::onJoinChannelSuccess "onJoinChannelSuccess" callback. The app must maintain this user ID. - @param options The channel media options: \ref agora::rtc::ChannelMediaOptions::ChannelMediaOptions "ChannelMediaOptions" - - @return - - 0(ERR_OK): Success. - - < 0: Failure. - - -2(ERR_INALID_ARGUMENT): The parameter is invalid. - - -3(ERR_NOT_READY): The SDK fails to be initialized. You can try re-initializing the SDK. - - -5(ERR_REFUSED): The request is rejected. This may be caused by the following: - - You have created an IChannel object with the same channel name. - - You have joined and published a stream in a channel created by the IChannel object. - */ - virtual int joinChannel(const char* token, - const char* info, - uid_t uid, - const ChannelMediaOptions& options) = 0; - /** Joins the channel with a user account. - - After the user successfully joins the channel, the SDK triggers the following callbacks: - - - The local client: \ref agora::rtc::IRtcEngineEventHandler::onLocalUserRegistered "onLocalUserRegistered" and \ref agora::rtc::IChannelEventHandler::onJoinChannelSuccess "onJoinChannelSuccess" . - - The remote client: \ref agora::rtc::IChannelEventHandler::onUserJoined "onUserJoined" and \ref agora::rtc::IRtcEngineEventHandler::onUserInfoUpdated "onUserInfoUpdated" , if the user joining the channel is in the `COMMUNICATION` profile, or is a host in the `LIVE_BROADCASTING` profile. - - @note To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. - If a user joins the channel with the Agora Web SDK, ensure that the uid of the user is set to the same parameter type. - - @param token The token generated at your server: - - For low-security requirements: You can use the temporary token generated at Console. For details, see [Get a temporary toke](https://docs.agora.io/en/Voice/token?platform=All%20Platforms#get-a-temporary-token). - - For high-security requirements: Set it as the token generated at your server. For details, see [Get a token](https://docs.agora.io/en/Voice/token?platform=All%20Platforms#get-a-token). - @param userAccount The user account. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as null. Supported character scopes are: - - All lowercase English letters: a to z. - - All uppercase English letters: A to Z. - - All numeric characters: 0 to 9. - - The space character. - - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". - @param options The channel media options: \ref agora::rtc::ChannelMediaOptions::ChannelMediaOptions “ChannelMediaOptions”. - - @return - - 0: Success. - - < 0: Failure. - - #ERR_INVALID_ARGUMENT (-2) - - #ERR_NOT_READY (-3) - - #ERR_REFUSED (-5) - */ - virtual int joinChannelWithUserAccount(const char* token, - const char* userAccount, - const ChannelMediaOptions& options) = 0; - /** Allows a user to leave a channel, such as hanging up or exiting a call. - - After joining a channel, the user must call the *leaveChannel* method to end the call before joining another channel. - - This method returns 0 if the user leaves the channel and releases all resources related to the call. - - This method call is asynchronous, and the user has not left the channel when the method call returns. Once the user leaves the channel, the SDK triggers the \ref IChannelEventHandler::onLeaveChannel "onLeaveChannel" callback. - - A successful \ref agora::rtc::IChannel::leaveChannel "leaveChannel" method call triggers the following callbacks: - - The local client: \ref agora::rtc::IChannelEventHandler::onLeaveChannel "onLeaveChannel" - - The remote client: \ref agora::rtc::IChannelEventHandler::onUserOffline "onUserOffline" , if the user leaving the channel is in the Communication channel, or is a host in the `LIVE_BROADCASTING` profile. - - @note - - If you call the \ref IChannel::release "release" method immediately after the *leaveChannel* method, the *leaveChannel* process interrupts, and the \ref IChannelEventHandler::onLeaveChannel "onLeaveChannel" callback is not triggered. - - If you call the *leaveChannel* method during a CDN live streaming, the SDK triggers the \ref IChannel::removePublishStreamUrl "removePublishStreamUrl" method. - - @return - - 0(ERR_OK): Success. - - < 0: Failure. - - -1(ERR_FAILED): A general error occurs (no specified reason). - - -2(ERR_INALID_ARGUMENT): The parameter is invalid. - - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. - */ - virtual int leaveChannel() = 0; - - /** Publishes the local stream to the channel. - - You must keep the following restrictions in mind when calling this method. Otherwise, the SDK returns the #ERR_REFUSED (5): - - This method publishes one stream only to the channel corresponding to the current `IChannel` object. - - In the live interactive streaming channel, only a host can call this method. To switch the client role, call \ref agora::rtc::IChannel::setClientRole "setClientRole" of the current `IChannel` object. - - You can publish a stream to only one channel at a time. For details on joining multiple channels, see the advanced guide *Join Multiple Channels*. - - @return - - 0: Success. - - < 0: Failure. - - #ERR_REFUSED (5): The method call is refused. - */ - virtual int publish() = 0; - - /** Stops publishing a stream to the channel. - - If you call this method in a channel where you are not publishing streams, the SDK returns #ERR_REFUSED (5). - - @return - - 0: Success. - - < 0: Failure. - - #ERR_REFUSED (5): The method call is refused. - */ - virtual int unpublish() = 0; - - /** Gets the channel ID of the current `IChannel` object. - - @return - - The channel ID of the current `IChannel` object, if the method call succeeds. - - The empty string "", if the method call fails. - */ - virtual const char *channelId() = 0; - /** Retrieves the current call ID. - - When a user joins a channel on a client, a `callId` is generated to identify the call from the client. - Feedback methods, such as \ref IRtcEngine::rate "rate" and \ref IRtcEngine::complain "complain", must be called after the call ends to submit feedback to the SDK. - - The `rate` and `complain` methods require the `callId` parameter retrieved from the `getCallId` method during a call. `callId` is passed as an argument into the `rate` and `complain` methods after the call ends. - - @note Ensure that you call this method after joining a channel. - - @param callId The current call ID. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getCallId(agora::util::AString& callId) = 0; - /** Gets a new token when the current token expires after a period of time. - - The `token` expires after a period of time once the token schema is enabled when: - - - The SDK triggers the \ref IChannelEventHandler::onTokenPrivilegeWillExpire "onTokenPrivilegeWillExpire" callback, or - - The \ref IChannelEventHandler::onConnectionStateChanged "onConnectionStateChanged" reports CONNECTION_CHANGED_TOKEN_EXPIRED(9). - - The application should call this method to get the new `token`. Failure to do so will result in the SDK disconnecting from the server. - - @param token Pointer to the new token. - - @return - - 0(ERR_OK): Success. - - < 0: Failure. - - -1(ERR_FAILED): A general error occurs (no specified reason). - - -2(ERR_INALID_ARGUMENT): The parameter is invalid. - - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. - */ - virtual int renewToken(const char* token) = 0; - /** Enables built-in encryption with an encryption password before users join a channel. - - @deprecated Deprecated as of v3.1.0. Use the \ref agora::rtc::IChannel::enableEncryption "enableEncryption" instead. - - All users in a channel must use the same encryption password. The encryption password is automatically cleared once a user leaves the channel. - - If an encryption password is not specified, the encryption functionality will be disabled. - - @note - - Do not use this method for CDN live streaming. - - For optimal transmission, ensure that the encrypted data size does not exceed the original data size + 16 bytes. 16 bytes is the maximum padding size for AES encryption. - - @param secret Pointer to the encryption password. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setEncryptionSecret(const char* secret) = 0; - /** Sets the built-in encryption mode. - - @deprecated Deprecated as of v3.1.0. Use the \ref agora::rtc::IChannel::enableEncryption "enableEncryption" instead. - - The Agora SDK supports built-in encryption, which is set to the `aes-128-xts` mode by default. Call this method to use other encryption modes. - - All users in the same channel must use the same encryption mode and password. - - Refer to the information related to the AES encryption algorithm on the differences between the encryption modes. - - @note Call the \ref IChannel::setEncryptionSecret "setEncryptionSecret" method to enable the built-in encryption function before calling this method. - - @param encryptionMode The set encryption mode: - - "aes-128-xts": (Default) 128-bit AES encryption, XTS mode. - - "aes-128-ecb": 128-bit AES encryption, ECB mode. - - "aes-256-xts": 256-bit AES encryption, XTS mode. - - "": When encryptionMode is set as NULL, the encryption mode is set as "aes-128-xts" by default. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setEncryptionMode(const char* encryptionMode) = 0; - /** Enables/Disables the built-in encryption. - * - * @since v3.1.0 - * - * In scenarios requiring high security, Agora recommends calling this method to enable the built-in encryption before joining a channel. - * - * All users in the same channel must use the same encryption mode and encryption key. Once all users leave the channel, the encryption key of this channel is automatically cleared. - * - * @note - * - If you enable the built-in encryption, you cannot use the RTMP streaming function. - * - Agora supports four encryption modes. If you choose an encryption mode (excepting `SM4_128_ECB` mode), you need to add an external encryption library when integrating the Android and iOS SDK. See the advanced guide *Channel Encryption*. - * - * @param enabled Whether to enable the built-in encryption: - * - true: Enable the built-in encryption. - * - false: Disable the built-in encryption. - * @param config Configurations of built-in encryption schemas. See EncryptionConfig. - * - * @return - * - 0: Success. - * - < 0: Failure. - * - -2(ERR_INVALID_ARGUMENT): An invalid parameter is used. Set the parameter with a valid value. - * - -4(ERR_NOT_SUPPORTED): The encryption mode is incorrect or the SDK fails to load the external encryption library. Check the enumeration or reload the external encryption library. - * - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. Initialize the `IRtcEngine` instance before calling this method. - */ - virtual int enableEncryption(bool enabled, const EncryptionConfig& config) = 0; - /** Registers a packet observer. - - The Agora SDK allows your application to register a packet observer to receive callbacks for voice or video packet transmission. - - @note - - The size of the packet sent to the network after processing should not exceed 1200 bytes, otherwise, the packet may fail to be sent. - - Ensure that both receivers and senders call this method, otherwise, you may meet undefined behaviors such as no voice and black screen. - - When you use CDN live streaming, recording or storage functions, Agora doesn't recommend calling this method. - - Call this method before joining a channel. - @param observer The registered packet observer. See IPacketObserver. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int registerPacketObserver(IPacketObserver* observer) = 0; - /** Registers the metadata observer. - - Registers the metadata observer. You need to implement the IMetadataObserver class and specify the metadata type in this method. A successful call of this method triggers the \ref agora::rtc::IMetadataObserver::getMaxMetadataSize "getMaxMetadataSize" callback. - This method enables you to add synchronized metadata in the video stream for more diversified interactive live streaming, such as sending shopping links, digital coupons, and online quizzes. - - @note - - Call this method before the joinChannel method. - - This method applies to the `LIVE_BROADCASTING` channel profile. - - @param observer The IMetadataObserver class. See the definition of IMetadataObserver for details. - @param type See \ref IMetadataObserver::METADATA_TYPE "METADATA_TYPE". The SDK supports VIDEO_METADATA (0) only for now. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int registerMediaMetadataObserver(IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type) = 0; - /** Sets the role of the user, such as a host or an audience (default), before joining a channel in the interactive live streaming. - - This method can be used to switch the user role in the interactive live streaming after the user joins a channel. - - In the `LIVE_BROADCASTING` profile, when a user switches user roles after joining a channel, a successful \ref agora::rtc::IChannel::setClientRole "setClientRole" method call triggers the following callbacks: - - The local client: \ref agora::rtc::IChannelEventHandler::onClientRoleChanged "onClientRoleChanged" - - The remote client: \ref agora::rtc::IChannelEventHandler::onUserJoined "onUserJoined" or \ref agora::rtc::IChannelEventHandler::onUserOffline "onUserOffline" (BECOME_AUDIENCE) - - @note - This method applies only to the `LIVE_BROADCASTING` profile. - - @param role Sets the role of the user. See #CLIENT_ROLE_TYPE. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setClientRole(CLIENT_ROLE_TYPE role) = 0; - /// @cond - /** Sets the role of a user in a live interactive streaming. - * - * @since v3.2.0 - * - * You can call this method either before or after joining the channel to set the user role as audience or host. If - * you call this method to switch the user role after joining the channel, the SDK triggers the following callbacks: - * - The local client: \ref IRtcChannelEventHandler::onClientRoleChanged "onClientRoleChanged". - * - The remote client: \ref IRtcChannelEventHandler::onUserJoined "onUserJoined" - * or \ref IRtcChannelEventHandler::onUserOffline "onUserOffline". - * - * @note - * - This method applies to the `LIVE_BROADCASTING` profile only (when the `profile` parameter in - * \ref IRtcChannel::setChannelProfile "setChannelProfile" is set as `CHANNEL_PROFILE_LIVE_BROADCASTING`). - * - The difference between this method and \ref IRtcChannel::setClientRole(CLIENT_ROLE_TYPE) "setClientRole1" is that - * this method can set the user level in addition to the user role. - * - The user role determines the permissions that the SDK grants to a user, such as permission to send local - * streams, receive remote streams, and push streams to a CDN address. - * - The user level determines the level of services that a user can enjoy within the permissions of the user's - * role. For example, an audience can choose to receive remote streams with low latency or ultra low latency. Levels - * affect prices. - * - * **Example** - * ```cpp - * ClientRoleOptions options; - * options.audienceLatencyLevel = AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY; - * options.audienceLatencyLevel = AUDIENCE_LATENCY_LEVEL_LOW_LATENCY; - * agoraChannel->setClientRole(role, options); - * ``` - * - * @param role The role of a user in a live interactive streaming. See #CLIENT_ROLE_TYPE. - * @param options The detailed options of a user, including user level. See ClientRoleOptions. - * - * @return - * - 0(ERR_OK): Success. - * - < 0: Failure. - * - -1(ERR_FAILED): A general error occurs (no specified reason). - * - -2(ERR_INALID_ARGUMENT): The parameter is invalid. - * - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. - */ - virtual int setClientRole(CLIENT_ROLE_TYPE role, const ClientRoleOptions& options) = 0; - /// @endcond - /** Prioritizes a remote user's stream. - * - * The SDK ensures the high-priority user gets the best possible stream quality. - * - * @note - * - The Agora SDK supports setting `serPriority` as high for one user only. - * - Ensure that you call this method before joining a channel. - * - * @param uid The ID of the remote user. - * @param userPriority Sets the priority of the remote user. See #PRIORITY_TYPE. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int setRemoteUserPriority(uid_t uid, PRIORITY_TYPE userPriority) = 0; - /** Sets the sound position and gain of a remote user. - - When the local user calls this method to set the sound position of a remote user, the sound difference between the left and right channels allows the - local user to track the real-time position of the remote user, creating a real sense of space. This method applies to massively multiplayer online games, - such as Battle Royale games. - - @note - - For this method to work, enable stereo panning for remote users by calling the \ref agora::rtc::IRtcEngine::enableSoundPositionIndication "enableSoundPositionIndication" method before joining a channel. - - This method requires hardware support. For the best sound positioning, we recommend using a stereo speaker. - - Ensure that you call this method after joining a channel. - - @param uid The ID of the remote user. - @param pan The sound position of the remote user. The value ranges from -1.0 to 1.0: - - 0.0: the remote sound comes from the front. - - -1.0: the remote sound comes from the left. - - 1.0: the remote sound comes from the right. - @param gain Gain of the remote user. The value ranges from 0.0 to 100.0. The default value is 100.0 (the original gain of the remote user). - The smaller the value, the less the gain. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setRemoteVoicePosition(uid_t uid, double pan, double gain) = 0; - /** Updates the display mode of the video view of a remote user. - - After initializing the video view of a remote user, you can call this method to update its rendering and mirror modes. - This method affects only the video view that the local user sees. - - @note - - Call this method after calling the \ref agora::rtc::IRtcEngine::setupRemoteVideo "setupRemoteVideo" method to initialize the remote video view. - - During a call, you can call this method as many times as necessary to update the display mode of the video view of a remote user. - - @param userId The ID of the remote user. - @param renderMode The rendering mode of the remote video view. See #RENDER_MODE_TYPE. - @param mirrorMode - - The mirror mode of the remote video view. See #VIDEO_MIRROR_MODE_TYPE. - - **Note**: The SDK disables the mirror mode by default. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setRemoteRenderMode(uid_t userId, RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0; - /** Sets whether to receive all remote audio streams by default. - - You can call this method either before or after joining a channel. If you call `setDefaultMuteAllRemoteAudioStreams (true)` after joining a channel, the remote audio streams of all subsequent users are not received. - - @note If you want to resume receiving the audio stream, call \ref agora::rtc::IChannel::muteRemoteAudioStream "muteRemoteAudioStream (false)", - and specify the ID of the remote user whose audio stream you want to receive. - To receive the audio streams of multiple remote users, call `muteRemoteAudioStream (false)` as many times. - Calling `setDefaultMuteAllRemoteAudioStreams (false)` resumes receiving the audio streams of subsequent users only. - - @param mute Sets whether to receive/stop receiving all remote users' audio streams by default: - - true: Stops receiving all remote users' audio streams by default. - - false: (Default) Receives all remote users' audio streams by default. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setDefaultMuteAllRemoteAudioStreams(bool mute) = 0; - /** Sets whether to receive all remote video streams by default. - - You can call this method either before or after joining a channel. If you - call `setDefaultMuteAllRemoteVideoStreams (true)` after joining a channel, - the remote video streams of all subsequent users are not received. - - @note If you want to resume receiving the video stream, call - \ref agora::rtc::IChannel::muteRemoteVideoStream "muteRemoteVideoStream (false)", - and specify the ID of the remote user whose video stream you want to receive. - To receive the video streams of multiple remote users, call `muteRemoteVideoStream (false)` - as many times. Calling `setDefaultMuteAllRemoteVideoStreams (false)` resumes - receiving the video streams of subsequent users only. - - @param mute Sets whether to receive/stop receiving all remote users' video streams by default: - - true: Stop receiving all remote users' video streams by default. - - false: (Default) Receive all remote users' video streams by default. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setDefaultMuteAllRemoteVideoStreams(bool mute) = 0; - /** Stops/Resumes receiving all remote users' audio streams. - - @param mute Sets whether to receive/stop receiving all remote users' audio streams. - - true: Stops receiving all remote users' audio streams. - - false: (Default) Receives all remote users' audio streams. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int muteAllRemoteAudioStreams(bool mute) = 0; - /** Adjust the playback volume of the specified remote user. - - After joining a channel, call \ref agora::rtc::IRtcEngine::adjustPlaybackSignalVolume "adjustPlaybackSignalVolume" to adjust the playback volume of different remote users, - or adjust multiple times for one remote user. - - @note - - Call this method after joining a channel. - - This method adjusts the playback volume, which is the mixed volume for the specified remote user. - - This method can only adjust the playback volume of one specified remote user at a time. If you want to adjust the playback volume of several remote users, - call the method multiple times, once for each remote user. - - @param userId The user ID, which should be the same as the `uid` of \ref agora::rtc::IChannel::joinChannel "joinChannel" - @param volume The playback volume of the voice. The value ranges from 0 to 100: - - 0: Mute. - - 100: Original volume. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int adjustUserPlaybackSignalVolume(uid_t userId, int volume) = 0; - /** Stops/Resumes receiving a specified remote user's audio stream. - - @note - - You can call this method either before or after joining a channel. If you call it before joining a channel, - you need to maintain the `uid` of the remote user on your app level. - - If you called the \ref agora::rtc::IChannel::muteAllRemoteAudioStreams "muteAllRemoteAudioStreams" method and set `mute` as `true` to stop - receiving all remote users' audio streams, call the `muteAllRemoteAudioStreams` method and set `mute` as `false` before calling this method. - The `muteAllRemoteAudioStreams` method sets all remote audio streams, while the `muteRemoteAudioStream` method sets a specified remote audio stream. - - @param userId The user ID of the specified remote user sending the audio. - @param mute Sets whether to receive/stop receiving a specified remote user's audio stream: - - true: Stops receiving the specified remote user's audio stream. - - false: (Default) Receives the specified remote user's audio stream. - - @return - - 0: Success. - - < 0: Failure. - - */ - virtual int muteRemoteAudioStream(uid_t userId, bool mute) = 0; - /** Stops/Resumes receiving all video stream from a specified remote user. - - @note You can call this method either before or after joining a channel. - - @param mute Sets whether to receive/stop receiving all remote users' video streams: - - true: Stop receiving all remote users' video streams. - - false: (Default) Receive all remote users' video streams. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int muteAllRemoteVideoStreams(bool mute) = 0; - /** Stops/Resumes receiving the video stream from a specified remote user. - - @note - - You can call this method either before or after joining a channel. If you call it before joining a channel, you - need to maintain the `uid` of the remote user on your app level. - - If you called the \ref agora::rtc::IChannel::muteAllRemoteVideoStreams "muteAllRemoteVideoStreams" method and - set `mute` as `true` to stop receiving all remote video streams, call the `muteAllRemoteVideoStreams` method and - set `mute` as `false` before calling this method. - - @param userId The user ID of the specified remote user. - @param mute Sets whether to stop/resume receiving the video stream from a specified remote user: - - true: Stop receiving the specified remote user's video stream. - - false: (Default) Receive the specified remote user's video stream. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int muteRemoteVideoStream(uid_t userId, bool mute) = 0; - /** Sets the stream type of the remote video. - - Under limited network conditions, if the publisher has not disabled the dual-stream mode using - \ref agora::rtc::IRtcEngine::enableDualStreamMode "enableDualStreamMode" (false), - the receiver can choose to receive either the high-quality video stream (the high resolution, and high bitrate video stream) or - the low-video stream (the low resolution, and low bitrate video stream). - - By default, users receive the high-quality video stream. Call this method if you want to switch to the low-video stream. - This method allows the app to adjust the corresponding video stream type based on the size of the video window to - reduce the bandwidth and resources. - - The aspect ratio of the low-video stream is the same as the high-quality video stream. Once the resolution of the high-quality video - stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-video stream. - - The method result returns in the \ref agora::rtc::IRtcEngineEventHandler::onApiCallExecuted "onApiCallExecuted" callback. - - @param userId The ID of the remote user sending the video stream. - @param streamType Sets the video-stream type. See #REMOTE_VIDEO_STREAM_TYPE. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setRemoteVideoStreamType(uid_t userId, REMOTE_VIDEO_STREAM_TYPE streamType) = 0; - /** Sets the default stream type of remote videos. - - Under limited network conditions, if the publisher has not disabled the dual-stream mode using - \ref agora::rtc::IRtcEngine::enableDualStreamMode "enableDualStreamMode" (false), - the receiver can choose to receive either the high-quality video stream (the high resolution, and high bitrate video stream) or - the low-video stream (the low resolution, and low bitrate video stream). - - By default, users receive the high-quality video stream. Call this method if you want to switch to the low-video stream. - This method allows the app to adjust the corresponding video stream type based on the size of the video window to - reduce the bandwidth and resources. The aspect ratio of the low-video stream is the same as the high-quality video stream. - Once the resolution of the high-quality video - stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-video stream. - - The method result returns in the \ref agora::rtc::IRtcEngineEventHandler::onApiCallExecuted "onApiCallExecuted" callback. - - @param streamType Sets the default video-stream type. See #REMOTE_VIDEO_STREAM_TYPE. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setRemoteDefaultVideoStreamType(REMOTE_VIDEO_STREAM_TYPE streamType) = 0; - /** Creates a data stream. - - Each user can create up to five data streams during the lifecycle of the IChannel. - - @note - - Set both the `reliable` and `ordered` parameters to `true` or `false`. Do not set one as `true` and the other as `false`. - - Ensure that you call this method after joining a channel. - - @param[out] streamId The ID of the created data stream. - @param reliable Sets whether or not the recipients are guaranteed to receive the data stream from the sender within five seconds: - - true: The recipients receive the data stream from the sender within five seconds. If the recipient does not receive the data stream within five seconds, - an error is reported to the application. - - false: There is no guarantee that the recipients receive the data stream within five seconds and no error message is reported for - any delay or missing data stream. - @param ordered Sets whether or not the recipients receive the data stream in the sent order: - - true: The recipients receive the data stream in the sent order. - - false: The recipients do not receive the data stream in the sent order. - - @return - - Returns 0: Success. - - < 0: Failure. - */ - virtual int createDataStream(int* streamId, bool reliable, bool ordered) = 0; - /** Sends data stream messages to all users in a channel. - - The SDK has the following restrictions on this method: - - Up to 30 packets can be sent per second in a channel with each packet having a maximum size of 1 kB. - - Each client can send up to 6 kB of data per second. - - Each user can have up to five data streams simultaneously. - - A successful \ref agora::rtc::IChannel::sendStreamMessage "sendStreamMessage" method call triggers - the \ref agora::rtc::IChannelEventHandler::onStreamMessage "onStreamMessage" callback on the remote client, from which the remote user gets the stream message. - - A failed \ref agora::rtc::IChannel::sendStreamMessage "sendStreamMessage" method call triggers - the \ref agora::rtc::IChannelEventHandler::onStreamMessageError "onStreamMessage" callback on the remote client. - - @note - - This method applies only to the `COMMUNICATION` profile or to the hosts in the `LIVE_BROADCASTING` profile. If an audience in the `LIVE_BROADCASTING` profile calls this method, the audience may be switched to a host. - - Ensure that you have created the data stream using \ref agora::rtc::IChannel::createDataStream "createDataStream" before calling this method. - - @param streamId The ID of the sent data stream, returned in the \ref IChannel::createDataStream "createDataStream" method. - @param data The sent data. - @param length The length of the sent data. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int sendStreamMessage(int streamId, const char* data, size_t length) = 0; - /** Publishes the local stream to a specified CDN live RTMP address. (CDN live only.) - - The SDK returns the result of this method call in the \ref IRtcEngineEventHandler::onStreamPublished "onStreamPublished" callback. - - The \ref agora::rtc::IChannel::addPublishStreamUrl "addPublishStreamUrl" method call triggers - the \ref agora::rtc::IChannelEventHandler::onRtmpStreamingStateChanged "onRtmpStreamingStateChanged" callback on the local client - to report the state of adding a local stream to the CDN. - - @note - - Ensure that the user joins the channel before calling this method. - - Ensure that you enable the RTMP Converter service before using this function. See Prerequisites in the advanced guide *Push Streams to CDN*. - - This method adds only one stream RTMP URL address each time it is called. - - @param url The CDN streaming URL in the RTMP format. The maximum length of this parameter is 1024 bytes. The RTMP URL address must not contain special characters, such as Chinese language characters. - @param transcodingEnabled Sets whether transcoding is enabled/disabled: - - true: Enable transcoding. To [transcode](https://docs.agora.io/en/Agora%20Platform/terms?platform=All%20Platforms#transcoding) the audio or video streams when publishing them to CDN live, often used for combining the audio and video streams of multiple hosts in CDN live. If you set this parameter as `true`, ensure that you call the \ref IChannel::setLiveTranscoding "setLiveTranscoding" method before this method. - - false: Disable transcoding. - - @return - - 0: Success. - - < 0: Failure. - - #ERR_INVALID_ARGUMENT (2): The RTMP URL address is NULL or has a string length of 0. - - #ERR_NOT_INITIALIZED (7): You have not initialized `IChannel` when publishing the stream. - */ - virtual int addPublishStreamUrl(const char *url, bool transcodingEnabled) = 0; - /** Removes an RTMP stream from the CDN. - - This method removes the RTMP URL address (added by the \ref IChannel::addPublishStreamUrl "addPublishStreamUrl" method) from a CDN live stream. - The SDK returns the result of this method call in the \ref IRtcEngineEventHandler::onStreamUnpublished "onStreamUnpublished" callback. - - The \ref agora::rtc::IChannel::removePublishStreamUrl "removePublishStreamUrl" method call triggers - the \ref agora::rtc::IChannelEventHandler::onRtmpStreamingStateChanged "onRtmpStreamingStateChanged" callback on the local client to report the state of removing an RTMP stream from the CDN. - - @note - - This method removes only one RTMP URL address each time it is called. - - The RTMP URL address must not contain special characters, such as Chinese language characters. - - @param url The RTMP URL address to be removed. The maximum length of this parameter is 1024 bytes. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int removePublishStreamUrl(const char *url) = 0; - /** Sets the video layout and audio settings for CDN live. (CDN live only.) - - The SDK triggers the \ref agora::rtc::IChannelEventHandler::onTranscodingUpdated "onTranscodingUpdated" callback when you - call the `setLiveTranscoding` method to update the transcoding setting. - - @note - - Ensure that you enable the RTMP Converter service before using this function. See Prerequisites in the advanced guide *Push Streams to CDN*.. - - If you call the `setLiveTranscoding` method to set the transcoding setting for the first time, the SDK does not trigger the `onTranscodingUpdated` callback. - - Ensure that you call this method after joining a channel. - - @param transcoding Sets the CDN live audio/video transcoding settings. See LiveTranscoding. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setLiveTranscoding(const LiveTranscoding &transcoding) = 0; - /** Adds a voice or video stream URL address to the interactive live streaming. - - The \ref IRtcEngineEventHandler::onStreamPublished "onStreamPublished" callback returns the inject status. - If this method call is successful, the server pulls the voice or video stream and injects it into a live channel. - This is applicable to scenarios where all audience members in the channel can watch a live show and interact with each other. - - The \ref agora::rtc::IChannel::addInjectStreamUrl "addInjectStreamUrl" method call triggers the following callbacks: - - The local client: - - \ref agora::rtc::IChannelEventHandler::onStreamInjectedStatus "onStreamInjectedStatus" , with the state of the injecting the online stream. - - \ref agora::rtc::IChannelEventHandler::onUserJoined "onUserJoined" (uid: 666), if the method call is successful and the online media stream is injected into the channel. - - The remote client: - - \ref agora::rtc::IChannelEventHandler::onUserJoined "onUserJoined" (uid: 666), if the method call is successful and the online media stream is injected into the channel. - - @note - - Ensure that you enable the RTMP Converter service before using this function. See Prerequisites in the advanced guide *Push Streams to CDN*. - - This method applies to the Native SDK v2.4.1 and later. - - This method applies to the `LIVE_BROADCASTING` profile only. - - You can inject only one media stream into the channel at the same time. - - Ensure that you call this method after joining a channel. - - @param url The URL address to be added to the ongoing live streaming. Valid protocols are RTMP, HLS, and HTTP-FLV. - - Supported audio codec type: AAC. - - Supported video codec type: H264 (AVC). - @param config The InjectStreamConfig object that contains the configuration of the added voice or video stream. - - @return - - 0: Success. - - < 0: Failure. - - #ERR_INVALID_ARGUMENT (2): The injected URL does not exist. Call this method again to inject the stream and ensure that the URL is valid. - - #ERR_NOT_READY (3): The user is not in the channel. - - #ERR_NOT_SUPPORTED (4): The channel profile is not `LIVE_BROADCASTING`. Call the \ref IRtcEngine::setChannelProfile "setChannelProfile" method and set the channel profile to `LIVE_BROADCASTING` before calling this method. - - #ERR_NOT_INITIALIZED (7): The SDK is not initialized. Ensure that the IChannel object is initialized before calling this method. - */ - virtual int addInjectStreamUrl(const char* url, const InjectStreamConfig& config) = 0; - /** Removes the voice or video stream URL address from a live streaming. - - This method removes the URL address (added by the \ref IChannel::addInjectStreamUrl "addInjectStreamUrl" method) from the live streaming. - - @note If this method is called successfully, the SDK triggers the \ref IChannelEventHandler::onUserOffline "onUserOffline" callback and returns a stream uid of 666. - - @param url Pointer to the URL address of the added stream to be removed. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int removeInjectStreamUrl(const char* url) = 0; - /** Starts to relay media streams across channels. - * - * After a successful method call, the SDK triggers the - * \ref agora::rtc::IChannelEventHandler::onChannelMediaRelayStateChanged - * "onChannelMediaRelayStateChanged" and - * \ref agora::rtc::IChannelEventHandler::onChannelMediaRelayEvent - * "onChannelMediaRelayEvent" callbacks, and these callbacks return the - * state and events of the media stream relay. - * - If the - * \ref agora::rtc::IChannelEventHandler::onChannelMediaRelayStateChanged - * "onChannelMediaRelayStateChanged" callback returns - * #RELAY_STATE_RUNNING (2) and #RELAY_OK (0), and the - * \ref agora::rtc::IChannelEventHandler::onChannelMediaRelayEvent - * "onChannelMediaRelayEvent" callback returns - * #RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL (4), the host starts - * sending data to the destination channel. - * - If the - * \ref agora::rtc::IChannelEventHandler::onChannelMediaRelayStateChanged - * "onChannelMediaRelayStateChanged" callback returns - * #RELAY_STATE_FAILURE (3), an exception occurs during the media stream - * relay. - * - * @note - * - Call this method after the \ref joinChannel() "joinChannel" method. - * - This method takes effect only when you are a host in a - * `LIVE_BROADCASTING` channel. - * - After a successful method call, if you want to call this method - * again, ensure that you call the - * \ref stopChannelMediaRelay() "stopChannelMediaRelay" method to quit the - * current relay. - * - Contact sales-us@agora.io before implementing this function. - * - We do not support string user accounts in this API. - * - * @param configuration The configuration of the media stream relay: - * ChannelMediaRelayConfiguration. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int startChannelMediaRelay(const ChannelMediaRelayConfiguration &configuration) = 0; - /** Updates the channels for media stream relay. - * - * After a successful - * \ref startChannelMediaRelay() "startChannelMediaRelay" method call, if - * you want to relay the media stream to more channels, or leave the - * current relay channel, you can call the - * \ref updateChannelMediaRelay() "updateChannelMediaRelay" method. - * - * After a successful method call, the SDK triggers the - * \ref agora::rtc::IChannelEventHandler::onChannelMediaRelayEvent - * "onChannelMediaRelayEvent" callback with the - * #RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL (7) state code. - * - * @note - * Call this method after the - * \ref startChannelMediaRelay() "startChannelMediaRelay" method to update - * the destination channel. - * - * @param configuration The media stream relay configuration: - * ChannelMediaRelayConfiguration. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int updateChannelMediaRelay(const ChannelMediaRelayConfiguration &configuration) = 0; - /** Stops the media stream relay. - * - * Once the relay stops, the host quits all the destination - * channels. - * - * After a successful method call, the SDK triggers the - * \ref agora::rtc::IChannelEventHandler::onChannelMediaRelayStateChanged - * "onChannelMediaRelayStateChanged" callback. If the callback returns - * #RELAY_STATE_IDLE (0) and #RELAY_OK (0), the host successfully - * stops the relay. - * - * @note - * If the method call fails, the SDK triggers the - * \ref agora::rtc::IChannelEventHandler::onChannelMediaRelayStateChanged - * "onChannelMediaRelayStateChanged" callback with the - * #RELAY_ERROR_SERVER_NO_RESPONSE (2) or - * #RELAY_ERROR_SERVER_CONNECTION_LOST (8) state code. You can leave the - * channel by calling the \ref leaveChannel() "leaveChannel" method, and - * the media stream relay automatically stops. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int stopChannelMediaRelay() = 0; - /** Gets the current connection state of the SDK. - - @note You can call this method either before or after joining a channel. - - @return #CONNECTION_STATE_TYPE. - */ - virtual CONNECTION_STATE_TYPE getConnectionState() = 0; - /// @cond - /** Enables/Disables the super-resolution algorithm for a remote user's video stream. - * - * @since v3.2.0 - * - * The algorithm effectively improves the resolution of the specified remote user's video stream. When the original - * resolution of the remote video stream is a × b pixels, you can receive and render the stream at a higher - * resolution (2a × 2b pixels) by enabling the algorithm. - * - * After calling this method, the SDK triggers the - * \ref IRtcChannelEventHandler::onUserSuperResolutionEnabled "onUserSuperResolutionEnabled" callback to report - * whether you have successfully enabled the super-resolution algorithm. - * - * @warning The super-resolution algorithm requires extra system resources. - * To balance the visual experience and system usage, the SDK poses the following restrictions: - * - The algorithm can only be used for a single user at a time. - * - On the Android platform, the original resolution of the remote video must not exceed 640 × 360 pixels. - * - On the iOS platform, the original resolution of the remote video must not exceed 640 × 480 pixels. - * If you exceed these limitations, the SDK triggers the \ref IRtcChannelEventHandler::onWarning "onWarning" - * callback with the corresponding warning codes: - * - #WARN_SUPER_RESOLUTION_STREAM_OVER_LIMITATION (1610): The origin resolution of the remote video is beyond the range where the super-resolution algorithm can be applied. - * - #WARN_SUPER_RESOLUTION_USER_COUNT_OVER_LIMITATION (1611): Another user is already using the super-resolution algorithm. - * - #WARN_SUPER_RESOLUTION_DEVICE_NOT_SUPPORTED (1612): The device does not support the super-resolution algorithm. - * - * @note - * - This method applies to Android and iOS only. - * - Requirements for the user's device: - * - Android: The following devices are known to support the method: - * - VIVO: V1821A, NEX S, 1914A, 1916A, and 1824BA - * - OPPO: PCCM00 - * - OnePlus: A6000 - * - Xiaomi: Mi 8, Mi 9, MIX3, and Redmi K20 Pro - * - SAMSUNG: SM-G9600, SM-G9650, SM-N9600, SM-G9708, SM-G960U, and SM-G9750 - * - HUAWEI: SEA-AL00, ELE-AL00, VOG-AL00, YAL-AL10, HMA-AL00, and EVR-AN00 - * - iOS: This method is supported on devices running iOS 12.0 or later. The following - * device models are known to support the method: - * - iPhone XR - * - iPhone XS - * - iPhone XS Max - * - iPhone 11 - * - iPhone 11 Pro - * - iPhone 11 Pro Max - * - iPad Pro 11-inch (3rd Generation) - * - iPad Pro 12.9-inch (3rd Generation) - * - iPad Air 3 (3rd Generation) - * - * @param userId The ID of the remote user. - * @param enable Whether to enable the super-resolution algorithm: - * - true: Enable the super-resolution algorithm. - * - false: Disable the super-resolution algorithm. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int enableRemoteSuperResolution(uid_t userId, bool enable) = 0; - /// @endcond +class IChannel { + public: + virtual ~IChannel() {} + /** Releases all IChannel resources. + + @return + - 0: Success. + - < 0: Failure. + - `ERR_NOT_INITIALIZED (7)`: The SDK is not initialized before calling this method. + */ + virtual int release() = 0; + /** Sets the channel event handler. + + After setting the channel event handler, you can listen for channel events and receive the statistics of the corresponding `IChannel` object. + + @param channelEh The event handler of the `IChannel` object. For details, see IChannelEventHandler. + + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setChannelEventHandler(IChannelEventHandler* channelEh) = 0; + /** Joins the channel with a user ID. + + This method differs from the `joinChannel` method in the `IRtcEngine` class in the following aspects: + + | IChannel::joinChannel | IRtcEngine::joinChannel | + |------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| + | Does not contain the `channelId` parameter, because `channelId` is specified when creating the `IChannel` object. | Contains the `channelId` parameter, which specifies the channel to join. | + | Contains the `options` parameter, which decides whether to subscribe to all streams before joining the channel. | Does not contain the `options` parameter. By default, users subscribe to all streams when joining the channel. | + | Users can join multiple channels simultaneously by creating multiple `IChannel` objects and calling the `joinChannel` method of each object. | Users can join only one channel. | + | By default, the SDK does not publish any stream after the user joins the channel. You need to call the publish method to do that. | By default, the SDK publishes streams once the user joins the channel. | + + Once the user joins the channel (switches to another channel), the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. If you do not want to subscribe to a specified stream or all remote streams, call the `mute` methods accordingly. + + @note + - If you are already in a channel, you cannot rejoin it with the same `uid`. + - We recommend using different UIDs for different channels. + - If you want to join the same channel from different devices, ensure that the UIDs in all devices are different. + - Ensure that the app ID you use to generate the token is the same with the app ID used when creating the `IRtcEngine` object. + + @param token The token generated at your server. For details, see [Generate a token](https://docs.agora.io/en/Interactive%20Broadcast/token_server?platform=Windows). + @param info (Optional) Additional information about the channel. This parameter can be set as null. Other users in the channel do not receive this information. + @param uid The user ID. A 32-bit unsigned integer with a value ranging from 1 to (232-1). This parameter must be unique. If `uid` is not assigned (or set as `0`), the SDK assigns a `uid` and reports it in the \ref agora::rtc::IChannelEventHandler::onJoinChannelSuccess "onJoinChannelSuccess" callback. The app must maintain this user ID. + @param options The channel media options: \ref agora::rtc::ChannelMediaOptions::ChannelMediaOptions "ChannelMediaOptions" + + @return + - 0(ERR_OK): Success. + - < 0: Failure. + - -2(ERR_INALID_ARGUMENT): The parameter is invalid. + - -3(ERR_NOT_READY): The SDK fails to be initialized. You can try re-initializing the SDK. + - -5(ERR_REFUSED): The request is rejected. This may be caused by the following: + - You have created an IChannel object with the same channel name. + - You have joined and published a stream in a channel created by the IChannel object. When you join a channel created by the IRtcEngine object, the SDK publishes the local audio and video streams to that channel by default. Because the SDK does not support publishing a local stream to more than one channel simultaneously, an error occurs in this occasion. + - -7(ERR_NOT_INITIALIZED): The SDK is not initialized before calling this method. + */ + virtual int joinChannel(const char* token, const char* info, uid_t uid, const ChannelMediaOptions& options) = 0; + /** Joins the channel with a user account. + + After the user successfully joins the channel, the SDK triggers the following callbacks: + + - The local client: \ref agora::rtc::IRtcEngineEventHandler::onLocalUserRegistered "onLocalUserRegistered" and \ref agora::rtc::IChannelEventHandler::onJoinChannelSuccess "onJoinChannelSuccess" . + - The remote client: \ref agora::rtc::IChannelEventHandler::onUserJoined "onUserJoined" and \ref agora::rtc::IRtcEngineEventHandler::onUserInfoUpdated "onUserInfoUpdated" , if the user joining the channel is in the `COMMUNICATION` profile, or is a host in the `LIVE_BROADCASTING` profile. + + Once the user joins the channel (switches to another channel), the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. If you do not want to subscribe to a specified stream or all remote streams, call the `mute` methods accordingly. + + @note To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. + If a user joins the channel with the Agora Web SDK, ensure that the uid of the user is set to the same parameter type. + + @param token The token generated at your server. For details, see [Generate a token](https://docs.agora.io/en/Interactive%20Broadcast/token_server?platform=Windows). + @param userAccount The user account. The maximum length of this parameter is 255 bytes. Ensure that the user account is unique and do not set it as null. Supported character scopes are: + - All lowercase English letters: a to z. + - All uppercase English letters: A to Z. + - All numeric characters: 0 to 9. + - The space character. + - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". + @param options The channel media options: \ref agora::rtc::ChannelMediaOptions::ChannelMediaOptions “ChannelMediaOptions”. + + @return + - 0: Success. + - < 0: Failure. + - #ERR_INVALID_ARGUMENT (-2) + - #ERR_NOT_READY (-3) + - #ERR_REFUSED (-5) + - #ERR_NOT_INITIALIZED (-7) + */ + virtual int joinChannelWithUserAccount(const char* token, const char* userAccount, const ChannelMediaOptions& options) = 0; + /** Allows a user to leave a channel, such as hanging up or exiting a call. + + After joining a channel, the user must call the *leaveChannel* method to end the call before joining another channel. + + This method returns 0 if the user leaves the channel and releases all resources related to the call. + + This method call is asynchronous, and the user has not left the channel when the method call returns. Once the user leaves the channel, the SDK triggers the \ref IChannelEventHandler::onLeaveChannel "onLeaveChannel" callback. + + A successful \ref agora::rtc::IChannel::leaveChannel "leaveChannel" method call triggers the following callbacks: + - The local client: \ref agora::rtc::IChannelEventHandler::onLeaveChannel "onLeaveChannel" + - The remote client: \ref agora::rtc::IChannelEventHandler::onUserOffline "onUserOffline" , if the user leaving the channel is in the Communication channel, or is a host in the `LIVE_BROADCASTING` profile. + + @note + - If you call the \ref IChannel::release "release" method immediately after the *leaveChannel* method, the *leaveChannel* process interrupts, and the \ref IChannelEventHandler::onLeaveChannel "onLeaveChannel" callback is not triggered. + - If you call the *leaveChannel* method during a CDN live streaming, the SDK triggers the \ref IChannel::removePublishStreamUrl "removePublishStreamUrl" method. + + @return + - 0(ERR_OK): Success. + - < 0: Failure. + - -1(ERR_FAILED): A general error occurs (no specified reason). + - -2(ERR_INALID_ARGUMENT): The parameter is invalid. + - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. + */ + virtual int leaveChannel() = 0; + + /** Publishes the local stream to the channel. + + You must keep the following restrictions in mind when calling this method. Otherwise, the SDK returns the #ERR_REFUSED (5): + - This method publishes one stream only to the channel corresponding to the current `IChannel` object. + - You can publish a stream to only one channel at a time. For details on joining multiple channels, see the advanced guide *Join Multiple Channels*. + - This method is equal to muteLocalAudioStream(false) and muteLocalVideoStream(false). + + @return + - 0: Success. + - < 0: Failure. + - #ERR_REFUSED (5): The method call is refused. + */ + virtual int publish() = 0; + + /** Stops publishing a stream to the channel. + + If you call this method in a channel where you are not publishing streams, the SDK returns #ERR_REFUSED (5). + - This method is equal to muteLocalAudioStream(true) and muteLocalVideoStream(true). + + @return + - 0: Success. + - < 0: Failure. + - #ERR_REFUSED (5): The method call is refused. + */ + virtual int unpublish() = 0; + + /** Gets the channel ID of the current `IChannel` object. + + @return + - The channel ID of the current `IChannel` object, if the method call succeeds. + - The empty string "", if the method call fails. + */ + virtual const char* channelId() = 0; + /** Gets the current call ID. + + When a user joins a channel on a client, a `callId` is generated to identify the call from the client. + Feedback methods, such as \ref IRtcEngine::rate "rate" and \ref IRtcEngine::complain "complain", must be called after the call ends to submit feedback to the SDK. + + The `rate` and `complain` methods require the `callId` parameter retrieved from the `getCallId` method during a call. `callId` is passed as an argument into the `rate` and `complain` methods after the call ends. + + @note Ensure that you call this method after joining a channel. + + @param callId The current call ID. + + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getCallId(agora::util::AString& callId) = 0; + /** Gets a new token when the current token expires after a period of time. + + The `token` expires after a period of time once the token schema is enabled when: + + - The SDK triggers the \ref IChannelEventHandler::onTokenPrivilegeWillExpire "onTokenPrivilegeWillExpire" callback, or + - The \ref IChannelEventHandler::onConnectionStateChanged "onConnectionStateChanged" reports CONNECTION_CHANGED_TOKEN_EXPIRED(9). + + The application should call this method to get the new `token`. Failure to do so will result in the SDK disconnecting from the server. + + @param token Pointer to the new token. + + @return + - 0(ERR_OK): Success. + - < 0: Failure. + - -1(ERR_FAILED): A general error occurs (no specified reason). + - -2(ERR_INALID_ARGUMENT): The parameter is invalid. + - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. + */ + virtual int renewToken(const char* token) = 0; + /** Enables built-in encryption with an encryption password before users join a channel. + + @deprecated Deprecated as of v3.1.0. Use the \ref agora::rtc::IChannel::enableEncryption "enableEncryption" instead. + + All users in a channel must use the same encryption password. The encryption password is automatically cleared once a user leaves the channel. + + If an encryption password is not specified, the encryption functionality will be disabled. + + @note + - Do not use this method for CDN live streaming. + - For optimal transmission, ensure that the encrypted data size does not exceed the original data size + 16 bytes. 16 bytes is the maximum padding size for AES encryption. + + @param secret Pointer to the encryption password. + + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setEncryptionSecret(const char* secret) = 0; + /** Sets the built-in encryption mode. + + @deprecated Deprecated as of v3.1.0. Use the \ref agora::rtc::IChannel::enableEncryption "enableEncryption" instead. + + The Agora SDK supports built-in encryption, which is set to the `aes-128-xts` mode by default. Call this method to use other encryption modes. + + All users in the same channel must use the same encryption mode and password. + + Refer to the information related to the AES encryption algorithm on the differences between the encryption modes. + + @note Call the \ref IChannel::setEncryptionSecret "setEncryptionSecret" method to enable the built-in encryption function before calling this method. + + @param encryptionMode The set encryption mode: + - "aes-128-xts": (Default) 128-bit AES encryption, XTS mode. + - "aes-128-ecb": 128-bit AES encryption, ECB mode. + - "aes-256-xts": 256-bit AES encryption, XTS mode. + - "": When encryptionMode is set as NULL, the encryption mode is set as "aes-128-xts" by default. + + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setEncryptionMode(const char* encryptionMode) = 0; + /** Enables/Disables the built-in encryption. + * + * @since v3.1.0 + * + * In scenarios requiring high security, Agora recommends calling this method to enable the built-in encryption before joining a channel. + * + * All users in the same channel must use the same encryption mode and encryption key. After a user leaves the channel, the SDK automatically disables the built-in encryption. To enable the built-in encryption, call this method before the user joins the channel again. + * + * @note If you enable the built-in encryption, you cannot use the RTMP or RTMPS streaming function. + * + * @param enabled Whether to enable the built-in encryption: + * - true: Enable the built-in encryption. + * - false: Disable the built-in encryption. + * @param config Configurations of built-in encryption schemas. See EncryptionConfig. + * + * @return + * - 0: Success. + * - < 0: Failure. + * - -2(ERR_INVALID_ARGUMENT): An invalid parameter is used. Set the parameter with a valid value. + * - -4(ERR_NOT_SUPPORTED): The encryption mode is incorrect or the SDK fails to load the external encryption library. Check the enumeration or reload the external encryption library. + * - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. Initialize the `IRtcEngine` instance before calling this method. + */ + virtual int enableEncryption(bool enabled, const EncryptionConfig& config) = 0; + /** Registers a packet observer. + + The Agora SDK allows your application to register a packet observer to receive callbacks for voice or video packet transmission. + + @note + - The size of the packet sent to the network after processing should not exceed 1200 bytes, otherwise, the packet may fail to be sent. + - Ensure that both receivers and senders call this method, otherwise, you may meet undefined behaviors such as no voice and black screen. + - When you use CDN live streaming and recording functions, Agora doesn't recommend calling this method. + - Call this method before joining a channel. + @param observer The registered packet observer. See IPacketObserver. + + @return + - 0: Success. + - < 0: Failure. + */ + virtual int registerPacketObserver(IPacketObserver* observer) = 0; + /** Registers the metadata observer. + + Registers the metadata observer. You need to implement the IMetadataObserver class and specify the metadata type in this method. A successful call of this method triggers the \ref agora::rtc::IMetadataObserver::getMaxMetadataSize "getMaxMetadataSize" callback. + This method enables you to add synchronized metadata in the video stream for more diversified interactive live streaming, such as sending shopping links, digital coupons, and online quizzes. + + @note + - Call this method before the joinChannel method. + - This method applies to the `LIVE_BROADCASTING` channel profile. + + @param observer The IMetadataObserver class. See the definition of IMetadataObserver for details. + @param type See \ref IMetadataObserver::METADATA_TYPE "METADATA_TYPE". The SDK supports VIDEO_METADATA (0) only for now. + + @return + - 0: Success. + - < 0: Failure. + */ + virtual int registerMediaMetadataObserver(IMetadataObserver* observer, IMetadataObserver::METADATA_TYPE type) = 0; + /** Sets the role of the user, such as a host or an audience (default), before joining a channel in the interactive live streaming. + + This method can be used to switch the user role in the interactive live streaming after the user joins a channel. + + In the `LIVE_BROADCASTING` profile, when a user switches user roles after joining a channel, a successful \ref agora::rtc::IChannel::setClientRole "setClientRole" method call triggers the following callbacks: + - The local client: \ref agora::rtc::IChannelEventHandler::onClientRoleChanged "onClientRoleChanged" + - The remote client: \ref agora::rtc::IChannelEventHandler::onUserJoined "onUserJoined" or \ref agora::rtc::IChannelEventHandler::onUserOffline "onUserOffline" (BECOME_AUDIENCE) + + @note + This method applies only to the `LIVE_BROADCASTING` profile. + + @param role Sets the role of the user. See #CLIENT_ROLE_TYPE. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setClientRole(CLIENT_ROLE_TYPE role) = 0; + + /** Sets the role of a user in interactive live streaming. + * + * @since v3.2.0 + * + * You can call this method either before or after joining the channel to set the user role as audience or host. If + * you call this method to switch the user role after joining the channel, the SDK triggers the following callbacks: + * - The local client: \ref IChannelEventHandler::onClientRoleChanged "onClientRoleChanged". + * - The remote client: \ref IChannelEventHandler::onUserJoined "onUserJoined" + * or \ref IChannelEventHandler::onUserOffline "onUserOffline". + * + * @note + * - This method applies to the `LIVE_BROADCASTING` profile only. + * - The difference between this method and \ref IChannel::setClientRole(CLIENT_ROLE_TYPE) "setClientRole" [1/2] is that + * this method can set the user level in addition to the user role. + * - The user role determines the permissions that the SDK grants to a user, such as permission to send local + * streams, receive remote streams, and push streams to a CDN address. + * - The user level determines the level of services that a user can enjoy within the permissions of the user's + * role. For example, an audience can choose to receive remote streams with low latency or ultra low latency. Levels + * affect prices. + * + * @param role The role of a user in interactive live streaming. See #CLIENT_ROLE_TYPE. + * @param options The detailed options of a user, including user level. See ClientRoleOptions. + * + * @return + * - 0(ERR_OK): Success. + * - < 0: Failure. + * - -1(ERR_FAILED): A general error occurs (no specified reason). + * - -2(ERR_INALID_ARGUMENT): The parameter is invalid. + * - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. + */ + virtual int setClientRole(CLIENT_ROLE_TYPE role, const ClientRoleOptions& options) = 0; + + /** Prioritizes a remote user's stream. + * + * The SDK ensures the high-priority user gets the best possible stream quality. + * + * @note + * - The Agora SDK supports setting `serPriority` as high for one user only. + * - Ensure that you call this method before joining a channel. + * + * @param uid The ID of the remote user. + * @param userPriority Sets the priority of the remote user. See #PRIORITY_TYPE. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setRemoteUserPriority(uid_t uid, PRIORITY_TYPE userPriority) = 0; + /** Sets the sound position and gain of a remote user. + + When the local user calls this method to set the sound position of a remote user, the sound difference between the left and right channels allows the + local user to track the real-time position of the remote user, creating a real sense of space. This method applies to massively multiplayer online games, + such as Battle Royale games. + + @note + - For this method to work, enable stereo panning for remote users by calling the \ref agora::rtc::IRtcEngine::enableSoundPositionIndication "enableSoundPositionIndication" method before joining a channel. + - This method requires hardware support. For the best sound positioning, we recommend using a wired headset. + - Ensure that you call this method after joining a channel. + + @param uid The ID of the remote user. + @param pan The sound position of the remote user. The value ranges from -1.0 to 1.0: + - 0.0: the remote sound comes from the front. + - -1.0: the remote sound comes from the left. + - 1.0: the remote sound comes from the right. + @param gain Gain of the remote user. The value ranges from 0.0 to 100.0. The default value is 100.0 (the original gain of the remote user). + The smaller the value, the less the gain. + + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setRemoteVoicePosition(uid_t uid, double pan, double gain) = 0; + /** Updates the display mode of the video view of a remote user. + + After initializing the video view of a remote user, you can call this method to update its rendering and mirror modes. + This method affects only the video view that the local user sees. + + @note + - Call this method after calling the \ref agora::rtc::IRtcEngine::setupRemoteVideo "setupRemoteVideo" method to initialize the remote video view. + - During a call, you can call this method as many times as necessary to update the display mode of the video view of a remote user. + + @param userId The ID of the remote user. + @param renderMode The rendering mode of the remote video view. See #RENDER_MODE_TYPE. + @param mirrorMode + - The mirror mode of the remote video view. See #VIDEO_MIRROR_MODE_TYPE. + - **Note**: The SDK disables the mirror mode by default. + + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setRemoteRenderMode(uid_t userId, RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0; + /** Stops or resumes subscribing to the audio streams of all remote users by default. + * + * @deprecated This method is deprecated from v3.3.0. + * + * + * Call this method after joining a channel. After successfully calling this method, the + * local user stops or resumes subscribing to the audio streams of all subsequent users. + * + * @note If you need to resume subscribing to the audio streams of remote users in the + * channel after calling \ref IRtcEngine::setDefaultMuteAllRemoteAudioStreams "setDefaultMuteAllRemoteAudioStreams" (true), do the following: + * - If you need to resume subscribing to the audio stream of a specified user, call \ref IRtcEngine::muteRemoteAudioStream "muteRemoteAudioStream" (false), and specify the user ID. + * - If you need to resume subscribing to the audio streams of multiple remote users, call \ref IRtcEngine::muteRemoteAudioStream "muteRemoteAudioStream" (false) multiple times. + * + * @param mute Sets whether to stop subscribing to the audio streams of all remote users by default. + * - true: Stop subscribing to the audio streams of all remote users by default. + * - false: (Default) Resume subscribing to the audio streams of all remote users by default. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setDefaultMuteAllRemoteAudioStreams(bool mute) = 0; + /** Stops or resumes subscribing to the video streams of all remote users by default. + * + * @deprecated This method is deprecated from v3.3.0. + * + * Call this method after joining a channel. After successfully calling this method, the + * local user stops or resumes subscribing to the video streams of all subsequent users. + * + * @note If you need to resume subscribing to the video streams of remote users in the + * channel after calling \ref IChannel::setDefaultMuteAllRemoteVideoStreams "setDefaultMuteAllRemoteVideoStreams" (true), do the following: + * - If you need to resume subscribing to the video stream of a specified user, call \ref IChannel::muteRemoteVideoStream "muteRemoteVideoStream" (false), and specify the user ID. + * - If you need to resume subscribing to the video streams of multiple remote users, call \ref IChannel::muteRemoteVideoStream "muteRemoteVideoStream" (false) multiple times. + * + * @param mute Sets whether to stop subscribing to the video streams of all remote users by default. + * - true: Stop subscribing to the video streams of all remote users by default. + * - false: (Default) Resume subscribing to the video streams of all remote users by default. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setDefaultMuteAllRemoteVideoStreams(bool mute) = 0; + /** + * Stops or resumes publishing the local audio stream. + * + * @note + * - When @p mute is set as @p true, this method does not affect any ongoing audio recording, because it does not disable the microphone. + * - You can call this method either before or after joining a channel. If you call \ref agora::rtc::IRtcEngine::setChannelProfile "setChannelProfile" + * after this method, the SDK resets whether or not to stop publishing the local audio according to the channel profile and user role. + * Therefore, we recommend calling this method after the `setChannelProfile` method. + * - At most one channel can be in unmute state at the same time. We don't support audio and video unmuted in different channels now. + * + * @param mute Sets whether to stop publishing the local audio stream. + * - true: Stop publishing the local audio stream. + * - false: (Default) Resumes publishing the local audio stream. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int muteLocalAudioStream(bool mute) = 0; + /** Stops or resumes publishing the local video stream. + * + * @note + * - This method executes faster than the \ref IRtcEngine::enableLocalVideo "enableLocalVideo" method, + * which controls the sending of the local video stream. + * - When `mute` is set as `true`, this method does not affect any ongoing video recording, because it does not disable the camera. + * - You can call this method either before or after joining a channel. If you call \ref IRtcEngine::setChannelProfile "setChannelProfile" + * after this method, the SDK resets whether or not to stop publishing the local video according to the channel profile and user role. + * Therefore, Agora recommends calling this method after the `setChannelProfile` method. + * - At most one channel can be in unmute state at the same time. We don't support audio and video unmuted in different channels now. + * + * @param mute Sets whether to stop publishing the local video stream. + * - true: Stop publishing the local video stream. + * - false: (Default) Resumes publishing the local video stream. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int muteLocalVideoStream(bool mute) = 0; + /** + * Stops or resumes subscribing to the audio streams of all remote users. + * + * As of v3.3.0, after successfully calling this method, the local user stops or resumes + * subscribing to the audio streams of all remote users, including all subsequent users. + * + * @note + * - Call this method after joining a channel. + * - See recommended settings in *Set the Subscribing State*. + * + * @param mute Sets whether to stop subscribing to the audio streams of all remote users. + * - true: Stop subscribing to the audio streams of all remote users. + * - false: (Default) Resume subscribing to the audio streams of all remote users. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int muteAllRemoteAudioStreams(bool mute) = 0; + /** Adjust the playback signal volume of the specified remote user. + + After joining a channel, call \ref agora::rtc::IRtcEngine::adjustPlaybackSignalVolume "adjustPlaybackSignalVolume" to adjust the playback volume of different remote users, + or adjust multiple times for one remote user. + + @note + - Call this method after joining a channel. + - This method adjusts the playback volume, which is the mixed volume for the specified remote user. + - This method can only adjust the playback volume of one specified remote user at a time. If you want to adjust the playback volume of several remote users, + call the method multiple times, once for each remote user. + + @param userId The user ID, which should be the same as the `uid` of \ref agora::rtc::IChannel::joinChannel "joinChannel" + @param volume The playback volume of the voice. The value ranges from 0 to 100: + - 0: Mute. + - 100: Original volume. + + @return + - 0: Success. + - < 0: Failure. + */ + virtual int adjustUserPlaybackSignalVolume(uid_t userId, int volume) = 0; + /** + * Stops or resumes subscribing to the audio stream of a specified user. + * + * @note + * - Call this method after joining a channel. + * - See recommended settings in *Set the Subscribing State*. + * + * @param userId The user ID of the specified remote user. + * @param mute Sets whether to stop subscribing to the audio stream of a specified user. + * - true: Stop subscribing to the audio stream of a specified user. + * - false: (Default) Resume subscribing to the audio stream of a specified user. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int muteRemoteAudioStream(uid_t userId, bool mute) = 0; + /** + * Stops or resumes subscribing to the video streams of all remote users. + * + * As of v3.3.0, after successfully calling this method, the local user stops or resumes + * subscribing to the video streams of all remote users, including all subsequent users. + * + * @note + * - Call this method after joining a channel. + * - See recommended settings in *Set the Subscribing State*. + * + * @param mute Sets whether to stop subscribing to the video streams of all remote users. + * - true: Stop subscribing to the video streams of all remote users. + * - false: (Default) Resume subscribing to the video streams of all remote users. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int muteAllRemoteVideoStreams(bool mute) = 0; + /** + * Stops or resumes subscribing to the video stream of a specified user. + * + * @note + * - Call this method after joining a channel. + * - See recommended settings in *Set the Subscribing State*. + * + * @param userId The user ID of the specified remote user. + * @param mute Sets whether to stop subscribing to the video stream of a specified user. + * - true: Stop subscribing to the video stream of a specified user. + * - false: (Default) Resume subscribing to the video stream of a specified user. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int muteRemoteVideoStream(uid_t userId, bool mute) = 0; + /** Sets the stream type of the remote video. + + Under limited network conditions, if the publisher has not disabled the dual-stream mode using + \ref agora::rtc::IRtcEngine::enableDualStreamMode "enableDualStreamMode" (false), + the receiver can choose to receive either the high-quality video stream (the high resolution, and high bitrate video stream) or + the low-video stream (the low resolution, and low bitrate video stream). + + By default, users receive the high-quality video stream. Call this method if you want to switch to the low-video stream. + This method allows the app to adjust the corresponding video stream type based on the size of the video window to + reduce the bandwidth and resources. + + The aspect ratio of the low-video stream is the same as the high-quality video stream. Once the resolution of the high-quality video + stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-video stream. + + The method result returns in the \ref agora::rtc::IRtcEngineEventHandler::onApiCallExecuted "onApiCallExecuted" callback. + + @note You can call this method either before or after joining a channel. If you call both + \ref IChannel::setRemoteVideoStreamType "setRemoteVideoStreamType" and + \ref IChannel::setRemoteDefaultVideoStreamType "setRemoteDefaultVideoStreamType", the SDK applies the settings in + the \ref IChannel::setRemoteVideoStreamType "setRemoteVideoStreamType" method. + + @param userId The ID of the remote user sending the video stream. + @param streamType Sets the video-stream type. See #REMOTE_VIDEO_STREAM_TYPE. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setRemoteVideoStreamType(uid_t userId, REMOTE_VIDEO_STREAM_TYPE streamType) = 0; + /** Sets the default stream type of remote videos. + + Under limited network conditions, if the publisher has not disabled the dual-stream mode using + \ref agora::rtc::IRtcEngine::enableDualStreamMode "enableDualStreamMode" (false), + the receiver can choose to receive either the high-quality video stream (the high resolution, and high bitrate video stream) or + the low-video stream (the low resolution, and low bitrate video stream). + + By default, users receive the high-quality video stream. Call this method if you want to switch to the low-video stream. + This method allows the app to adjust the corresponding video stream type based on the size of the video window to + reduce the bandwidth and resources. The aspect ratio of the low-video stream is the same as the high-quality video stream. + Once the resolution of the high-quality video + stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-video stream. + + The method result returns in the \ref agora::rtc::IRtcEngineEventHandler::onApiCallExecuted "onApiCallExecuted" callback. + + @note You can call this method either before or after joining a channel. If you call both + \ref IChannel::setRemoteVideoStreamType "setRemoteVideoStreamType" and + \ref IChannel::setRemoteDefaultVideoStreamType "setRemoteDefaultVideoStreamType", the SDK applies the settings in + the \ref IChannel::setRemoteVideoStreamType "setRemoteVideoStreamType" method. + + @param streamType Sets the default video-stream type. See #REMOTE_VIDEO_STREAM_TYPE. + + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setRemoteDefaultVideoStreamType(REMOTE_VIDEO_STREAM_TYPE streamType) = 0; + /** Creates a data stream. + + @deprecated This method is deprecated from v3.3.0. Use the \ref IChannel::createDataStream(int* streamId, DataStreamConfig& config) "createDataStream" [2/2] method instead. + + Each user can create up to five data streams during the lifecycle of the IChannel. + + @note + - Do not set `reliable` as `true` while setting `ordered` as `false`. + - Ensure that you call this method after joining a channel. + + @param[out] streamId The ID of the created data stream. + @param reliable Sets whether or not the recipients are guaranteed to receive the data stream from the sender within five seconds: + - true: The recipients receive the data stream from the sender within five seconds. If the recipient does not receive the data stream within five seconds, + an error is reported to the application. + - false: There is no guarantee that the recipients receive the data stream within five seconds and no error message is reported for + any delay or missing data stream. + @param ordered Sets whether or not the recipients receive the data stream in the sent order: + - true: The recipients receive the data stream in the sent order. + - false: The recipients do not receive the data stream in the sent order. + + @return + - Returns 0: Success. + - < 0: Failure. + */ + virtual int createDataStream(int* streamId, bool reliable, bool ordered) = 0; + /** Creates a data stream. + * + * @since v3.3.0 + * + * Each user can create up to five data streams in a single channel. + * + * This method does not support data reliability. If the receiver receives a data packet five + * seconds or more after it was sent, the SDK directly discards the data. + * + * @param[out] streamId The ID of the created data stream. + * @param config The configurations for the data stream: DataStreamConfig. + * + * @return + * - 0: Creates the data stream successfully. + * - < 0: Fails to create the data stream. + */ + virtual int createDataStream(int* streamId, DataStreamConfig& config) = 0; + /** Sends data stream messages to all users in a channel. + + The SDK has the following restrictions on this method: + - Up to 30 packets can be sent per second in a channel with each packet having a maximum size of 1 kB. + - Each client can send up to 6 kB of data per second. + - Each user can have up to five data streams simultaneously. + + A successful \ref agora::rtc::IChannel::sendStreamMessage "sendStreamMessage" method call triggers + the \ref agora::rtc::IChannelEventHandler::onStreamMessage "onStreamMessage" callback on the remote client, from which the remote user gets the stream message. + + A failed \ref agora::rtc::IChannel::sendStreamMessage "sendStreamMessage" method call triggers + the \ref agora::rtc::IChannelEventHandler::onStreamMessageError "onStreamMessage" callback on the remote client. + + @note + - This method applies only to the `COMMUNICATION` profile or to the hosts in the `LIVE_BROADCASTING` profile. If an audience in the `LIVE_BROADCASTING` profile calls this method, the audience may be switched to a host. + - Ensure that you have created the data stream using \ref agora::rtc::IChannel::createDataStream "createDataStream" before calling this method. + + @param streamId The ID of the sent data stream, returned in the \ref IChannel::createDataStream "createDataStream" method. + @param data The sent data. + @param length The length of the sent data. + + @return + - 0: Success. + - < 0: Failure. + */ + virtual int sendStreamMessage(int streamId, const char* data, size_t length) = 0; + /** Publishes the local stream to a specified CDN streaming URL. (CDN live only.) + + The SDK returns the result of this method call in the \ref IRtcEngineEventHandler::onStreamPublished "onStreamPublished" callback. + + After calling this method, you can push media streams in RTMP or RTMPS protocol to the CDN. The SDK triggers + the \ref agora::rtc::IChannelEventHandler::onRtmpStreamingStateChanged "onRtmpStreamingStateChanged" callback on the local client + to report the state of adding a local stream to the CDN. + + @note + - Ensure that the user joins the channel before calling this method. + - Ensure that you enable the RTMP Converter service before using this function. See Prerequisites in the advanced guide *Push Streams to CDN*. + - This method adds only one stream CDN streaming URL each time it is called. + - Agora supports pushing media streams in RTMPS protocol to the CDN only when you enable transcoding. + + @param url The CDN streaming URL in the RTMP or RTMPS format. The maximum length of this parameter is 1024 bytes. The CDN streaming URL must not contain special characters, such as Chinese language characters. + @param transcodingEnabled Sets whether transcoding is enabled/disabled: + - true: Enable transcoding. To [transcode](https://docs.agora.io/en/Agora%20Platform/terms?platform=All%20Platforms#transcoding) the audio or video streams when publishing them to CDN live, often used for combining the audio and video streams of multiple hosts in CDN live. If you set this parameter as `true`, ensure that you call the \ref IChannel::setLiveTranscoding "setLiveTranscoding" method before this method. + - false: Disable transcoding. + + @return + - 0: Success. + - < 0: Failure. + - #ERR_INVALID_ARGUMENT (-2): The CDN streaming URL is NULL or has a string length of 0. + - #ERR_NOT_INITIALIZED (-7): You have not initialized `IChannel` when publishing the stream. + */ + virtual int addPublishStreamUrl(const char* url, bool transcodingEnabled) = 0; + /** Removes an RTMP or RTMPS stream from the CDN. + + This method removes the CDN streaming URL (added by the \ref IChannel::addPublishStreamUrl "addPublishStreamUrl" method) from a CDN live stream. + The SDK returns the result of this method call in the \ref IRtcEngineEventHandler::onStreamUnpublished "onStreamUnpublished" callback. + + The \ref agora::rtc::IChannel::removePublishStreamUrl "removePublishStreamUrl" method call triggers + the \ref agora::rtc::IChannelEventHandler::onRtmpStreamingStateChanged "onRtmpStreamingStateChanged" callback on the local client to report the state of removing an RTMP or RTMPS stream from the CDN. + + @note + - This method removes only one CDN streaming URL each time it is called. + - The CDN streaming URL must not contain special characters, such as Chinese language characters. + + @param url The CDN streaming URL to be removed. The maximum length of this parameter is 1024 bytes. + + @return + - 0: Success. + - < 0: Failure. + */ + virtual int removePublishStreamUrl(const char* url) = 0; + /** Sets the video layout and audio settings for CDN live. (CDN live only.) + + The SDK triggers the \ref agora::rtc::IChannelEventHandler::onTranscodingUpdated "onTranscodingUpdated" callback when you + call the `setLiveTranscoding` method to update the transcoding setting. + + @note + - Ensure that you enable the RTMP Converter service before using this function. See Prerequisites in the advanced guide *Push Streams to CDN*.. + - If you call the `setLiveTranscoding` method to set the transcoding setting for the first time, the SDK does not trigger the `onTranscodingUpdated` callback. + - Ensure that you call this method after joining a channel. + - Agora supports pushing media streams in RTMPS protocol to the CDN only when you enable transcoding. + + @param transcoding Sets the CDN live audio/video transcoding settings. See LiveTranscoding. + + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setLiveTranscoding(const LiveTranscoding& transcoding) = 0; + /** Adds a voice or video stream URL address to the interactive live streaming. + + The \ref IRtcEngineEventHandler::onStreamPublished "onStreamPublished" callback returns the inject status. + If this method call is successful, the server pulls the voice or video stream and injects it into a live channel. + This is applicable to scenarios where all audience members in the channel can watch a live show and interact with each other. + + The \ref agora::rtc::IChannel::addInjectStreamUrl "addInjectStreamUrl" method call triggers the following callbacks: + - The local client: + - \ref agora::rtc::IChannelEventHandler::onStreamInjectedStatus "onStreamInjectedStatus" , with the state of the injecting the online stream. + - \ref agora::rtc::IChannelEventHandler::onUserJoined "onUserJoined" (uid: 666), if the method call is successful and the online media stream is injected into the channel. + - The remote client: + - \ref agora::rtc::IChannelEventHandler::onUserJoined "onUserJoined" (uid: 666), if the method call is successful and the online media stream is injected into the channel. + + @warning Agora will soon stop the service for injecting online media streams on the client. If you have not implemented this service, Agora recommends that you do not use it. + + @note + - Ensure that you enable the RTMP Converter service before using this function. See Prerequisites in the advanced guide *Push Streams to CDN*. + - This method applies to the Native SDK v2.4.1 and later. + - This method applies to the `LIVE_BROADCASTING` profile only. + - You can inject only one media stream into the channel at the same time. + - Ensure that you call this method after joining a channel. + + @param url The URL address to be added to the ongoing live streaming. Valid protocols are RTMP, HLS, and HTTP-FLV. + - Supported audio codec type: AAC. + - Supported video codec type: H264 (AVC). + @param config The InjectStreamConfig object that contains the configuration of the added voice or video stream. + + @return + - 0: Success. + - < 0: Failure. + - #ERR_INVALID_ARGUMENT (-2): The injected URL does not exist. Call this method again to inject the stream and ensure that the URL is valid. + - #ERR_NOT_READY (-3): The user is not in the channel. + - #ERR_NOT_SUPPORTED (-4): The channel profile is not `LIVE_BROADCASTING`. Call the \ref IRtcEngine::setChannelProfile "setChannelProfile" method and set the channel profile to `LIVE_BROADCASTING` before calling this method. + - #ERR_NOT_INITIALIZED (-7): The SDK is not initialized. Ensure that the IChannel object is initialized before calling this method. + */ + virtual int addInjectStreamUrl(const char* url, const InjectStreamConfig& config) = 0; + /** Removes the voice or video stream URL address from a live streaming. + + This method removes the URL address (added by the \ref IChannel::addInjectStreamUrl "addInjectStreamUrl" method) from the live streaming. + + @warning Agora will soon stop the service for injecting online media streams on the client. If you have not implemented this service, Agora recommends that you do not use it. + + @note If this method is called successfully, the SDK triggers the \ref IChannelEventHandler::onUserOffline "onUserOffline" callback and returns a stream uid of 666. + + @param url Pointer to the URL address of the added stream to be removed. + + @return + - 0: Success. + - < 0: Failure. + */ + virtual int removeInjectStreamUrl(const char* url) = 0; + /** Starts to relay media streams across channels. + * + * After a successful method call, the SDK triggers the + * \ref agora::rtc::IChannelEventHandler::onChannelMediaRelayStateChanged + * "onChannelMediaRelayStateChanged" and + * \ref agora::rtc::IChannelEventHandler::onChannelMediaRelayEvent + * "onChannelMediaRelayEvent" callbacks, and these callbacks return the + * state and events of the media stream relay. + * - If the + * \ref agora::rtc::IChannelEventHandler::onChannelMediaRelayStateChanged + * "onChannelMediaRelayStateChanged" callback returns + * #RELAY_STATE_RUNNING (2) and #RELAY_OK (0), and the + * \ref agora::rtc::IChannelEventHandler::onChannelMediaRelayEvent + * "onChannelMediaRelayEvent" callback returns + * #RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL (4), the host starts + * sending data to the destination channel. + * - If the + * \ref agora::rtc::IChannelEventHandler::onChannelMediaRelayStateChanged + * "onChannelMediaRelayStateChanged" callback returns + * #RELAY_STATE_FAILURE (3), an exception occurs during the media stream + * relay. + * + * @note + * - Call this method after the \ref joinChannel() "joinChannel" method. + * - This method takes effect only when you are a host in a + * `LIVE_BROADCASTING` channel. + * - After a successful method call, if you want to call this method + * again, ensure that you call the + * \ref stopChannelMediaRelay() "stopChannelMediaRelay" method to quit the + * current relay. + * - Contact sales-us@agora.io before implementing this function. + * - We do not support string user accounts in this API. + * + * @param configuration The configuration of the media stream relay: + * ChannelMediaRelayConfiguration. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int startChannelMediaRelay(const ChannelMediaRelayConfiguration& configuration) = 0; + /** Updates the channels for media stream relay. + * + * After a successful + * \ref startChannelMediaRelay() "startChannelMediaRelay" method call, if + * you want to relay the media stream to more channels, or leave the + * current relay channel, you can call the + * \ref updateChannelMediaRelay() "updateChannelMediaRelay" method. + * + * After a successful method call, the SDK triggers the + * \ref agora::rtc::IChannelEventHandler::onChannelMediaRelayEvent + * "onChannelMediaRelayEvent" callback with the + * #RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL (7) state code. + * + * @note + * Call this method after the + * \ref startChannelMediaRelay() "startChannelMediaRelay" method to update + * the destination channel. + * + * @param configuration The media stream relay configuration: + * ChannelMediaRelayConfiguration. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int updateChannelMediaRelay(const ChannelMediaRelayConfiguration& configuration) = 0; + /** Stops the media stream relay. + * + * Once the relay stops, the host quits all the destination + * channels. + * + * After a successful method call, the SDK triggers the + * \ref agora::rtc::IChannelEventHandler::onChannelMediaRelayStateChanged + * "onChannelMediaRelayStateChanged" callback. If the callback returns + * #RELAY_STATE_IDLE (0) and #RELAY_OK (0), the host successfully + * stops the relay. + * + * @note + * If the method call fails, the SDK triggers the + * \ref agora::rtc::IChannelEventHandler::onChannelMediaRelayStateChanged + * "onChannelMediaRelayStateChanged" callback with the + * #RELAY_ERROR_SERVER_NO_RESPONSE (2) or + * #RELAY_ERROR_SERVER_CONNECTION_LOST (8) error code. You can leave the + * channel by calling the \ref leaveChannel() "leaveChannel" method, and + * the media stream relay automatically stops. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int stopChannelMediaRelay() = 0; + /** Gets the current connection state of the SDK. + + @note You can call this method either before or after joining a channel. + + @return #CONNECTION_STATE_TYPE. + */ + virtual CONNECTION_STATE_TYPE getConnectionState() = 0; + /// @cond + /** Enables/Disables the super-resolution algorithm for a remote user's video stream. + * + * @since v3.2.0 + * + * The algorithm effectively improves the resolution of the specified remote user's video stream. When the original + * resolution of the remote video stream is a × b pixels, you can receive and render the stream at a higher + * resolution (2a × 2b pixels) by enabling the algorithm. + * + * After calling this method, the SDK triggers the + * \ref IRtcChannelEventHandler::onUserSuperResolutionEnabled "onUserSuperResolutionEnabled" callback to report + * whether you have successfully enabled the super-resolution algorithm. + * + * @warning The super-resolution algorithm requires extra system resources. + * To balance the visual experience and system usage, the SDK poses the following restrictions: + * - The algorithm can only be used for a single user at a time. + * - On the Android platform, the original resolution of the remote video must not exceed 640 × 360 pixels. + * - On the iOS platform, the original resolution of the remote video must not exceed 640 × 480 pixels. + * If you exceed these limitations, the SDK triggers the \ref IRtcChannelEventHandler::onWarning "onWarning" + * callback with the corresponding warning codes: + * - #WARN_SUPER_RESOLUTION_STREAM_OVER_LIMITATION (1610): The origin resolution of the remote video is beyond the range where the super-resolution algorithm can be applied. + * - #WARN_SUPER_RESOLUTION_USER_COUNT_OVER_LIMITATION (1611): Another user is already using the super-resolution algorithm. + * - #WARN_SUPER_RESOLUTION_DEVICE_NOT_SUPPORTED (1612): The device does not support the super-resolution algorithm. + * + * @note + * - This method applies to Android and iOS only. + * - Requirements for the user's device: + * - Android: The following devices are known to support the method: + * - VIVO: V1821A, NEX S, 1914A, 1916A, and 1824BA + * - OPPO: PCCM00 + * - OnePlus: A6000 + * - Xiaomi: Mi 8, Mi 9, MIX3, and Redmi K20 Pro + * - SAMSUNG: SM-G9600, SM-G9650, SM-N9600, SM-G9708, SM-G960U, and SM-G9750 + * - HUAWEI: SEA-AL00, ELE-AL00, VOG-AL00, YAL-AL10, HMA-AL00, and EVR-AN00 + * - iOS: This method is supported on devices running iOS 12.0 or later. The following + * device models are known to support the method: + * - iPhone XR + * - iPhone XS + * - iPhone XS Max + * - iPhone 11 + * - iPhone 11 Pro + * - iPhone 11 Pro Max + * - iPad Pro 11-inch (3rd Generation) + * - iPad Pro 12.9-inch (3rd Generation) + * - iPad Air 3 (3rd Generation) + * + * @param userId The ID of the remote user. + * @param enable Whether to enable the super-resolution algorithm: + * - true: Enable the super-resolution algorithm. + * - false: Disable the super-resolution algorithm. + * + * @return + * - 0: Success. + * - < 0: Failure. + * - -158 (ERR_MODULE_SUPER_RESOLUTION_NOT_FOUND): You have not integrated the dynamic library for the super-resolution algorithm. + */ + virtual int enableRemoteSuperResolution(uid_t userId, bool enable) = 0; + /// @endcond }; /** @since v3.0.0 The IRtcEngine2 class. */ -class IRtcEngine2 : public IRtcEngine -{ -public: - - /** Creates and gets an `IChannel` object. - - To join more than one channel, call this method multiple times to create as many `IChannel` objects as needed, and - call the \ref agora::rtc::IChannel::joinChannel "joinChannel" method of each created `IChannel` object. - - After joining multiple channels, you can simultaneously subscribe to streams of all the channels, but publish a stream in only one channel at one time. - @param channelId The unique channel name for an Agora RTC session. It must be in the string format and not exceed 64 bytes in length. Supported character scopes are: - - All lowercase English letters: a to z. - - All uppercase English letters: A to Z. - - All numeric characters: 0 to 9. - - The space character. - - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". - - @note - - This parameter does not have a default value. You must set it. - - Do not set it as the empty string "". Otherwise, the SDK returns #ERR_REFUSED (5). - - @return - - The `IChannel` object, if the method call succeeds. - - An empty pointer NULL, if the method call fails. - - `ERR_REFUSED(5)`, if you set channelId as the empty string "". - */ - virtual IChannel* createChannel(const char *channelId) = 0; - +class IRtcEngine2 : public IRtcEngine { + public: + /** Creates and gets an `IChannel` object. + + To join more than one channel, call this method multiple times to create as many `IChannel` objects as needed, and + call the \ref agora::rtc::IChannel::joinChannel "joinChannel" method of each created `IChannel` object. + + After joining multiple channels, you can simultaneously subscribe to streams of all the channels, but publish a stream in only one channel at one time. + @param channelId The unique channel name for an Agora RTC session. It must be in the string format and not exceed 64 bytes in length. Supported character scopes are: + - All lowercase English letters: a to z. + - All uppercase English letters: A to Z. + - All numeric characters: 0 to 9. + - The space character. + - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". + + @note + - This parameter does not have a default value. You must set it. + - Do not set it as the empty string "". Otherwise, the SDK returns #ERR_REFUSED (5). + + @return + - The `IChannel` object, if the method call succeeds. + - An empty pointer NULL, if the method call fails. + - `ERR_REFUSED(5)`, if you set channelId as the empty string "". + */ + virtual IChannel* createChannel(const char* channelId) = 0; }; - -} -} - +} // namespace rtc +} // namespace agora #endif diff --git a/cpp/android/include/IAgoraRtcEngine.h b/cpp/android/include/IAgoraRtcEngine.h index ab6b753..bd55995 100644 --- a/cpp/android/include/IAgoraRtcEngine.h +++ b/cpp/android/include/IAgoraRtcEngine.h @@ -12,6 +12,7 @@ #define AGORA_RTC_ENGINE_H #include "AgoraBase.h" #include "IAgoraService.h" +#include "IAgoraLog.h" #if defined(_WIN32) #include "IAgoraMediaEngine.h" @@ -19,945 +20,1075 @@ namespace agora { namespace rtc { - typedef unsigned int uid_t; - typedef void* view_t; +typedef unsigned int uid_t; +typedef void* view_t; /** Maximum length of the device ID. -*/ -enum MAX_DEVICE_ID_LENGTH_TYPE -{ + */ +enum MAX_DEVICE_ID_LENGTH_TYPE { /** The maximum length of the device ID is 512 bytes. - */ - MAX_DEVICE_ID_LENGTH = 512 + */ + MAX_DEVICE_ID_LENGTH = 512 }; /** Maximum length of user account. */ -enum MAX_USER_ACCOUNT_LENGTH_TYPE -{ +enum MAX_USER_ACCOUNT_LENGTH_TYPE { /** The maximum length of user account is 255 bytes. */ MAX_USER_ACCOUNT_LENGTH = 256 }; /** Maximum length of channel ID. */ -enum MAX_CHANNEL_ID_LENGTH_TYPE -{ - /** The maximum length of channel id is 64 bytes. - */ - MAX_CHANNEL_ID_LENGTH = 65 +enum MAX_CHANNEL_ID_LENGTH_TYPE { + /** The maximum length of channel id is 64 bytes. + */ + MAX_CHANNEL_ID_LENGTH = 65 }; /** Formats of the quality report. -*/ -enum QUALITY_REPORT_FORMAT_TYPE -{ + */ +enum QUALITY_REPORT_FORMAT_TYPE { /** 0: The quality report in JSON format, - */ - QUALITY_REPORT_JSON = 0, - /** 1: The quality report in HTML format. - */ - QUALITY_REPORT_HTML = 1, + */ + QUALITY_REPORT_JSON = 0, + /** 1: The quality report in HTML format. + */ + QUALITY_REPORT_HTML = 1, }; -enum MEDIA_ENGINE_EVENT_CODE_TYPE -{ - /** 0: For internal use only. - */ - MEDIA_ENGINE_RECORDING_ERROR = 0, - /** 1: For internal use only. - */ - MEDIA_ENGINE_PLAYOUT_ERROR = 1, - /** 2: For internal use only. - */ - MEDIA_ENGINE_RECORDING_WARNING = 2, - /** 3: For internal use only. - */ - MEDIA_ENGINE_PLAYOUT_WARNING = 3, - /** 10: For internal use only. - */ - MEDIA_ENGINE_AUDIO_FILE_MIX_FINISH = 10, - /** 12: For internal use only. - */ - MEDIA_ENGINE_AUDIO_FAREND_MUSIC_BEGINS = 12, - /** 13: For internal use only. - */ - MEDIA_ENGINE_AUDIO_FAREND_MUSIC_ENDS = 13, - /** 14: For internal use only. - */ - MEDIA_ENGINE_LOCAL_AUDIO_RECORD_ENABLED = 14, - /** 15: For internal use only. - */ - MEDIA_ENGINE_LOCAL_AUDIO_RECORD_DISABLED = 15, - // media engine role changed - /** 20: For internal use only. - */ - MEDIA_ENGINE_ROLE_BROADCASTER_SOLO = 20, - /** 21: For internal use only. - */ - MEDIA_ENGINE_ROLE_BROADCASTER_INTERACTIVE = 21, - /** 22: For internal use only. - */ - MEDIA_ENGINE_ROLE_AUDIENCE = 22, - /** 23: For internal use only. - */ - MEDIA_ENGINE_ROLE_COMM_PEER = 23, - /** 24: For internal use only. - */ - MEDIA_ENGINE_ROLE_GAME_PEER = 24, - // iOS adm sample rate changed - /** 110: For internal use only. - */ - MEDIA_ENGINE_AUDIO_ADM_REQUIRE_RESTART = 110, - /** 111: For internal use only. - */ - MEDIA_ENGINE_AUDIO_ADM_SPECIAL_RESTART = 111, - /** 112: For internal use only. - */ - MEDIA_ENGINE_AUDIO_ADM_USING_COMM_PARAMS = 112, - /** 113: For internal use only. - */ - MEDIA_ENGINE_AUDIO_ADM_USING_NORM_PARAMS = 113, - // audio mix state - /** 710: For internal use only. - */ - MEDIA_ENGINE_AUDIO_EVENT_MIXING_PLAY = 710, - /** 711: For internal use only. - */ - MEDIA_ENGINE_AUDIO_EVENT_MIXING_PAUSED = 711, - /** 712: For internal use only. - */ - MEDIA_ENGINE_AUDIO_EVENT_MIXING_RESTART = 712, - /** 713: For internal use only. - */ - MEDIA_ENGINE_AUDIO_EVENT_MIXING_STOPPED = 713, - /** 714: For internal use only. - */ - MEDIA_ENGINE_AUDIO_EVENT_MIXING_ERROR = 714, - //Mixing error codes - /** 701: For internal use only. - */ - MEDIA_ENGINE_AUDIO_ERROR_MIXING_OPEN = 701, - /** 702: For internal use only. - */ - MEDIA_ENGINE_AUDIO_ERROR_MIXING_TOO_FREQUENT = 702, - /** 703: The audio mixing file playback is interrupted. For internal use only. - */ - MEDIA_ENGINE_AUDIO_ERROR_MIXING_INTERRUPTED_EOF = 703, - /** 0: For internal use only. - */ - MEDIA_ENGINE_AUDIO_ERROR_MIXING_NO_ERROR = 0, +enum MEDIA_ENGINE_EVENT_CODE_TYPE { + /** 0: For internal use only. + */ + MEDIA_ENGINE_RECORDING_ERROR = 0, + /** 1: For internal use only. + */ + MEDIA_ENGINE_PLAYOUT_ERROR = 1, + /** 2: For internal use only. + */ + MEDIA_ENGINE_RECORDING_WARNING = 2, + /** 3: For internal use only. + */ + MEDIA_ENGINE_PLAYOUT_WARNING = 3, + /** 10: For internal use only. + */ + MEDIA_ENGINE_AUDIO_FILE_MIX_FINISH = 10, + /** 12: For internal use only. + */ + MEDIA_ENGINE_AUDIO_FAREND_MUSIC_BEGINS = 12, + /** 13: For internal use only. + */ + MEDIA_ENGINE_AUDIO_FAREND_MUSIC_ENDS = 13, + /** 14: For internal use only. + */ + MEDIA_ENGINE_LOCAL_AUDIO_RECORD_ENABLED = 14, + /** 15: For internal use only. + */ + MEDIA_ENGINE_LOCAL_AUDIO_RECORD_DISABLED = 15, + // media engine role changed + /** 20: For internal use only. + */ + MEDIA_ENGINE_ROLE_BROADCASTER_SOLO = 20, + /** 21: For internal use only. + */ + MEDIA_ENGINE_ROLE_BROADCASTER_INTERACTIVE = 21, + /** 22: For internal use only. + */ + MEDIA_ENGINE_ROLE_AUDIENCE = 22, + /** 23: For internal use only. + */ + MEDIA_ENGINE_ROLE_COMM_PEER = 23, + /** 24: For internal use only. + */ + MEDIA_ENGINE_ROLE_GAME_PEER = 24, + /** 30: For internal use only. + */ + MEDIA_ENGINE_AUDIO_AIRPLAY_CONNECTED = 30, + + // iOS adm sample rate changed + /** 110: For internal use only. + */ + MEDIA_ENGINE_AUDIO_ADM_REQUIRE_RESTART = 110, + /** 111: For internal use only. + */ + MEDIA_ENGINE_AUDIO_ADM_SPECIAL_RESTART = 111, + /** 112: For internal use only. + */ + MEDIA_ENGINE_AUDIO_ADM_USING_COMM_PARAMS = 112, + /** 113: For internal use only. + */ + MEDIA_ENGINE_AUDIO_ADM_USING_NORM_PARAMS = 113, + // audio mix event + /** 720: For internal use only. + */ + MEDIA_ENGINE_AUDIO_EVENT_MIXING_STARTED_BY_USER = 720, + /** 721: For internal use only. + */ + MEDIA_ENGINE_AUDIO_EVENT_MIXING_ONE_LOOP_COMPLETED = 721, + /** 722: For internal use only. + */ + MEDIA_ENGINE_AUDIO_EVENT_MIXING_START_NEW_LOOP = 722, + /** 723: For internal use only. + */ + MEDIA_ENGINE_AUDIO_EVENT_MIXING_ALL_LOOPS_COMPLETED = 723, + /** 724: For internal use only. + */ + MEDIA_ENGINE_AUDIO_EVENT_MIXING_STOPPED_BY_USER = 724, + /** 725: For internal use only. + */ + MEDIA_ENGINE_AUDIO_EVENT_MIXING_PAUSED_BY_USER = 725, + /** 726: For internal use only. + */ + MEDIA_ENGINE_AUDIO_EVENT_MIXING_RESUMED_BY_USER = 726, + // Mixing error codes + /** 701: For internal use only. + */ + MEDIA_ENGINE_AUDIO_ERROR_MIXING_OPEN = 701, + /** 702: For internal use only. + */ + MEDIA_ENGINE_AUDIO_ERROR_MIXING_TOO_FREQUENT = 702, + /** 703: The audio mixing file playback is interrupted. For internal use only. + */ + MEDIA_ENGINE_AUDIO_ERROR_MIXING_INTERRUPTED_EOF = 703, + /** 0: For internal use only. + */ + MEDIA_ENGINE_AUDIO_ERROR_MIXING_NO_ERROR = 0, }; -/** The states of the local user's audio mixing file. -*/ -enum AUDIO_MIXING_STATE_TYPE{ - /** 710: The audio mixing file is playing after the method call of - * \ref IRtcEngine::startAudioMixing "startAudioMixing" or \ref IRtcEngine::resumeAudioMixing "resumeAudioMixing" succeeds. - */ - AUDIO_MIXING_STATE_PLAYING = 710, - /** 711: The audio mixing file pauses playing after the method call of \ref IRtcEngine::pauseAudioMixing "pauseAudioMixing" succeeds. - */ - AUDIO_MIXING_STATE_PAUSED = 711, - /** 713: The audio mixing file stops playing after the method call of \ref IRtcEngine::stopAudioMixing "stopAudioMixing" succeeds. - */ - AUDIO_MIXING_STATE_STOPPED = 713, - /** 714: An exception occurs during the playback of the audio mixing file. See the `errorCode` for details. - */ - AUDIO_MIXING_STATE_FAILED = 714, +/** The current music file playback state. + * + * Reports in the \ref IRtcEngineEventHandler::onAudioMixingStateChanged "onAudioMixingStateChanged" callback. + */ +enum AUDIO_MIXING_STATE_TYPE { + /** 710: The music file is playing. + * + * This state comes with one of the following associated reasons: + * - #AUDIO_MIXING_REASON_STARTED_BY_USER (720) + * - #AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED (721) + * - #AUDIO_MIXING_REASON_START_NEW_LOOP (722) + * - #AUDIO_MIXING_REASON_RESUMED_BY_USER (726) + */ + AUDIO_MIXING_STATE_PLAYING = 710, + /** 711: The music file pauses playing. + * + * This state comes with #AUDIO_MIXING_REASON_PAUSED_BY_USER (725). + */ + AUDIO_MIXING_STATE_PAUSED = 711, + /** 713: The music file stops playing. + * + * This state comes with one of the following associated reasons: + * - #AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED (723) + * - #AUDIO_MIXING_REASON_STOPPED_BY_USER (724) + */ + AUDIO_MIXING_STATE_STOPPED = 713, + /** 714: An exception occurs during the playback of the music file. + * + * This state comes with one of the following associated reasons: + * - #AUDIO_MIXING_REASON_CAN_NOT_OPEN (701) + * - #AUDIO_MIXING_REASON_TOO_FREQUENT_CALL (702) + * - #AUDIO_MIXING_REASON_INTERRUPTED_EOF (703) + */ + AUDIO_MIXING_STATE_FAILED = 714, }; -/** The error codes of the local user's audio mixing file. -*/ -enum AUDIO_MIXING_ERROR_TYPE{ - /** 701: The SDK cannot open the audio mixing file. - */ - AUDIO_MIXING_ERROR_CAN_NOT_OPEN = 701, - /** 702: The SDK opens the audio mixing file too frequently. - */ - AUDIO_MIXING_ERROR_TOO_FREQUENT_CALL = 702, - /** 703: The audio mixing file playback is interrupted. - */ - AUDIO_MIXING_ERROR_INTERRUPTED_EOF = 703, - /** 0: The SDK can open the audio mixing file. - */ - AUDIO_MIXING_ERROR_OK = 0, +/** + * @deprecated Deprecated from v3.4.0. Use #AUDIO_MIXING_REASON_TYPE instead. + * + * The error codes of the local user's audio mixing file. + */ +enum AUDIO_MIXING_ERROR_TYPE { + /** 701: The SDK cannot open the audio mixing file. + */ + AUDIO_MIXING_ERROR_CAN_NOT_OPEN = 701, + /** 702: The SDK opens the audio mixing file too frequently. + */ + AUDIO_MIXING_ERROR_TOO_FREQUENT_CALL = 702, + /** 703: The audio mixing file playback is interrupted. + */ + AUDIO_MIXING_ERROR_INTERRUPTED_EOF = 703, + /** 0: The SDK can open the audio mixing file. + */ + AUDIO_MIXING_ERROR_OK = 0, +}; + +/** The reason for the change of the music file playback state. + * + * @since v3.4.0 + * + * Reports in the \ref IRtcEngineEventHandler::onAudioMixingStateChanged "onAudioMixingStateChanged" callback. + */ +enum AUDIO_MIXING_REASON_TYPE { + /** 701: The SDK cannot open the music file. Possible causes include the local + * music file does not exist, the SDK does not support the file format, or the + * SDK cannot access the music file URL. + */ + AUDIO_MIXING_REASON_CAN_NOT_OPEN = 701, + /** 702: The SDK opens the music file too frequently. If you need to call + * \ref IRtcEngine::startAudioMixing(const char*,bool,bool,int,int) "startAudioMixing" multiple times, ensure + * that the call interval is longer than 500 ms. + */ + AUDIO_MIXING_REASON_TOO_FREQUENT_CALL = 702, + /** 703: The music file playback is interrupted. + */ + AUDIO_MIXING_REASON_INTERRUPTED_EOF = 703, + /** 720: Successfully calls \ref IRtcEngine::startAudioMixing(const char*,bool,bool,int,int) "startAudioMixing" + * to play a music file. + */ + AUDIO_MIXING_REASON_STARTED_BY_USER = 720, + /** 721: The music file completes a loop playback. + */ + AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED = 721, + /** 722: The music file starts a new loop playback. + */ + AUDIO_MIXING_REASON_START_NEW_LOOP = 722, + /** 723: The music file completes all loop playback. + */ + AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED = 723, + /** 724: Successfully calls \ref IRtcEngine::stopAudioMixing "stopAudioMixing" + * to stop playing the music file. + */ + AUDIO_MIXING_REASON_STOPPED_BY_USER = 724, + /** 725: Successfully calls \ref IRtcEngine::pauseAudioMixing "pauseAudioMixing" + * to pause playing the music file. + */ + AUDIO_MIXING_REASON_PAUSED_BY_USER = 725, + /** 726: Successfully calls \ref IRtcEngine::resumeAudioMixing "resumeAudioMixing" + * to resume playing the music file. + */ + AUDIO_MIXING_REASON_RESUMED_BY_USER = 726, }; /** Media device states. */ -enum MEDIA_DEVICE_STATE_TYPE -{ +enum MEDIA_DEVICE_STATE_TYPE { + /** 0: The device is idle. + */ + MEDIA_DEVICE_STATE_IDLE = 0, /** 1: The device is active. - */ - MEDIA_DEVICE_STATE_ACTIVE = 1, - /** 2: The device is disabled. - */ - MEDIA_DEVICE_STATE_DISABLED = 2, - /** 4: The device is not present. - */ - MEDIA_DEVICE_STATE_NOT_PRESENT = 4, - /** 8: The device is unplugged. - */ - MEDIA_DEVICE_STATE_UNPLUGGED = 8 + */ + MEDIA_DEVICE_STATE_ACTIVE = 1, + /** 2: The device is disabled. + */ + MEDIA_DEVICE_STATE_DISABLED = 2, + /** 4: The device is not present. + */ + MEDIA_DEVICE_STATE_NOT_PRESENT = 4, + /** 8: The device is unplugged. + */ + MEDIA_DEVICE_STATE_UNPLUGGED = 8, + /** 16: The device is not recommended. + */ + MEDIA_DEVICE_STATE_UNRECOMMENDED = 16, }; /** Media device types. */ -enum MEDIA_DEVICE_TYPE -{ +enum MEDIA_DEVICE_TYPE { /** -1: Unknown device type. - */ - UNKNOWN_AUDIO_DEVICE = -1, - /** 0: Audio playback device. - */ - AUDIO_PLAYOUT_DEVICE = 0, - /** 1: Audio recording device. - */ - AUDIO_RECORDING_DEVICE = 1, - /** 2: Video renderer. - */ - VIDEO_RENDER_DEVICE = 2, - /** 3: Video capturer. - */ - VIDEO_CAPTURE_DEVICE = 3, - /** 4: Application audio playback device. - */ - AUDIO_APPLICATION_PLAYOUT_DEVICE = 4, + */ + UNKNOWN_AUDIO_DEVICE = -1, + /** 0: Audio playback device. + */ + AUDIO_PLAYOUT_DEVICE = 0, + /** 1: Audio capturing device. + */ + AUDIO_RECORDING_DEVICE = 1, + /** 2: Video renderer. + */ + VIDEO_RENDER_DEVICE = 2, + /** 3: Video capturer. + */ + VIDEO_CAPTURE_DEVICE = 3, + /** 4: Application audio playback device. + */ + AUDIO_APPLICATION_PLAYOUT_DEVICE = 4, }; -/** Local video state types +/** Local video state types. */ -enum LOCAL_VIDEO_STREAM_STATE -{ - /** 0: Initial state */ - LOCAL_VIDEO_STREAM_STATE_STOPPED = 0, - /** 1: The local video capturing device starts successfully. - * - * The SDK also reports this state when you share a maximized window by calling \ref IRtcEngine::startScreenCaptureByWindowId "startScreenCaptureByWindowId". - */ - LOCAL_VIDEO_STREAM_STATE_CAPTURING = 1, - /** 2: The first video frame is successfully encoded. */ - LOCAL_VIDEO_STREAM_STATE_ENCODING = 2, - /** 3: The local video fails to start. */ - LOCAL_VIDEO_STREAM_STATE_FAILED = 3 +enum LOCAL_VIDEO_STREAM_STATE { + /** 0: Initial state. */ + LOCAL_VIDEO_STREAM_STATE_STOPPED = 0, + /** 1: The local video capturing device starts successfully. + * + * The SDK also reports this state when you share a maximized window by calling \ref IRtcEngine::startScreenCaptureByWindowId "startScreenCaptureByWindowId". + */ + LOCAL_VIDEO_STREAM_STATE_CAPTURING = 1, + /** 2: The first video frame is successfully encoded. */ + LOCAL_VIDEO_STREAM_STATE_ENCODING = 2, + /** 3: The local video fails to start. */ + LOCAL_VIDEO_STREAM_STATE_FAILED = 3 }; -/** Local video state error codes +/** Local video state error codes. */ enum LOCAL_VIDEO_STREAM_ERROR { - /** 0: The local video is normal. */ - LOCAL_VIDEO_STREAM_ERROR_OK = 0, - /** 1: No specified reason for the local video failure. */ - LOCAL_VIDEO_STREAM_ERROR_FAILURE = 1, - /** 2: No permission to use the local video capturing device. */ - LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION = 2, - /** 3: The local video capturing device is in use. */ - LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY = 3, - /** 4: The local video capture fails. Check whether the capturing device is working properly. */ - LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE = 4, - /** 5: The local video encoding fails. */ - LOCAL_VIDEO_STREAM_ERROR_ENCODE_FAILURE = 5, - /** 11: The shared window is minimized when you call \ref IRtcEngine::startScreenCaptureByWindowId "startScreenCaptureByWindowId" to share a window. - */ - LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_MINIMIZED = 11, - /** 12: The error code indicates that a window shared by the window ID has been closed, or a full-screen window - * shared by the window ID has exited full-screen mode. - * After exiting full-screen mode, remote users cannot see the shared window. To prevent remote users from seeing a - * black screen, Agora recommends that you immediately stop screen sharing. - * - * Common scenarios for reporting this error code: - * - When the local user closes the shared window, the SDK reports this error code. - * - The local user shows some slides in full-screen mode first, and then shares the windows of the slides. After - * the user exits full-screen mode, the SDK reports this error code. - * - The local user watches web video or reads web document in full-screen mode first, and then shares the window of - * the web video or document. After the user exits full-screen mode, the SDK reports this error code. - */ - LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_CLOSED = 12, + /** 0: The local video is normal. */ + LOCAL_VIDEO_STREAM_ERROR_OK = 0, + /** 1: No specified reason for the local video failure. */ + LOCAL_VIDEO_STREAM_ERROR_FAILURE = 1, + /** 2: No permission to use the local video capturing device. */ + LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION = 2, + /** 3: The local video capturing device is in use. */ + LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY = 3, + /** 4: The local video capture fails. Check whether the capturing device is working properly. */ + LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE = 4, + /** 5: The local video encoding fails. */ + LOCAL_VIDEO_STREAM_ERROR_ENCODE_FAILURE = 5, + /** 6: (iOS only) The application is in the background. + * + * @since v3.3.0 + */ + LOCAL_VIDEO_STREAM_ERROR_CAPTURE_INBACKGROUND = 6, + /** 7: (iOS only) The application is running in Slide Over, Split View, or Picture in Picture mode. + * + * @since v3.3.0 + */ + LOCAL_VIDEO_STREAM_ERROR_CAPTURE_MULTIPLE_FOREGROUND_APPS = 7, + /** + * 8: The SDK cannot find the local video capture device. + * + * @since v3.4.0 + */ + LOCAL_VIDEO_STREAM_ERROR_DEVICE_NOT_FOUND = 8, + /** + * 11: The shared window is minimized when you call + * \ref IRtcEngine::startScreenCaptureByWindowId "startScreenCaptureByWindowId" + * to share a window. + */ + LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_MINIMIZED = 11, + /** 12: The error code indicates that a window shared by the window ID has been closed, or a full-screen window + * shared by the window ID has exited full-screen mode. + * After exiting full-screen mode, remote users cannot see the shared window. To prevent remote users from seeing a + * black screen, Agora recommends that you immediately stop screen sharing. + * + * Common scenarios for reporting this error code: + * - When the local user closes the shared window, the SDK reports this error code. + * - The local user shows some slides in full-screen mode first, and then shares the windows of the slides. After + * the user exits full-screen mode, the SDK reports this error code. + * - The local user watches web video or reads web document in full-screen mode first, and then shares the window of + * the web video or document. After the user exits full-screen mode, the SDK reports this error code. + */ + LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_CLOSED = 12, + /// @cond + LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_NOT_SUPPORTED = 20, + /// @endcond }; /** Local audio state types. */ -enum LOCAL_AUDIO_STREAM_STATE -{ - /** 0: The local audio is in the initial state. - */ - LOCAL_AUDIO_STREAM_STATE_STOPPED = 0, - /** 1: The recording device starts successfully. - */ - LOCAL_AUDIO_STREAM_STATE_RECORDING = 1, - /** 2: The first audio frame encodes successfully. - */ - LOCAL_AUDIO_STREAM_STATE_ENCODING = 2, - /** 3: The local audio fails to start. - */ - LOCAL_AUDIO_STREAM_STATE_FAILED = 3 +enum LOCAL_AUDIO_STREAM_STATE { + /** 0: The local audio is in the initial state. + */ + LOCAL_AUDIO_STREAM_STATE_STOPPED = 0, + /** 1: The capturing device starts successfully. + */ + LOCAL_AUDIO_STREAM_STATE_RECORDING = 1, + /** 2: The first audio frame encodes successfully. + */ + LOCAL_AUDIO_STREAM_STATE_ENCODING = 2, + /** 3: The local audio fails to start. + */ + LOCAL_AUDIO_STREAM_STATE_FAILED = 3 }; /** Local audio state error codes. */ -enum LOCAL_AUDIO_STREAM_ERROR -{ - /** 0: The local audio is normal. - */ - LOCAL_AUDIO_STREAM_ERROR_OK = 0, - /** 1: No specified reason for the local audio failure. - */ - LOCAL_AUDIO_STREAM_ERROR_FAILURE = 1, - /** 2: No permission to use the local audio device. - */ - LOCAL_AUDIO_STREAM_ERROR_DEVICE_NO_PERMISSION = 2, - /** 3: The microphone is in use. - */ - LOCAL_AUDIO_STREAM_ERROR_DEVICE_BUSY = 3, - /** 4: The local audio recording fails. Check whether the recording device - * is working properly. - */ - LOCAL_AUDIO_STREAM_ERROR_RECORD_FAILURE = 4, - /** 5: The local audio encoding fails. - */ - LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE = 5 +enum LOCAL_AUDIO_STREAM_ERROR { + /** 0: The local audio is normal. + */ + LOCAL_AUDIO_STREAM_ERROR_OK = 0, + /** 1: No specified reason for the local audio failure. + */ + LOCAL_AUDIO_STREAM_ERROR_FAILURE = 1, + /** 2: No permission to use the local audio device. + */ + LOCAL_AUDIO_STREAM_ERROR_DEVICE_NO_PERMISSION = 2, + /** 3: The microphone is in use. + */ + LOCAL_AUDIO_STREAM_ERROR_DEVICE_BUSY = 3, + /** 4: The local audio capturing fails. Check whether the capturing device + * is working properly. + */ + LOCAL_AUDIO_STREAM_ERROR_RECORD_FAILURE = 4, + /** 5: The local audio encoding fails. + */ + LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE = 5, + /** 6: The SDK cannot find the local audio recording device. + * + * @since v3.4.0 + */ + LOCAL_AUDIO_STREAM_ERROR_NO_RECORDING_DEVICE = 6, + /** 7: The SDK cannot find the local audio playback device. + * + * @since v3.4.0 + */ + LOCAL_AUDIO_STREAM_ERROR_NO_PLAYOUT_DEVICE = 7 }; -/** Audio recording qualities. -*/ -enum AUDIO_RECORDING_QUALITY_TYPE -{ - /** 0: Low quality. The sample rate is 32 kHz, and the file size is around - * 1.2 MB after 10 minutes of recording. - */ - AUDIO_RECORDING_QUALITY_LOW = 0, - /** 1: Medium quality. The sample rate is 32 kHz, and the file size is - * around 2 MB after 10 minutes of recording. - */ - AUDIO_RECORDING_QUALITY_MEDIUM = 1, - /** 2: High quality. The sample rate is 32 kHz, and the file size is - * around 3.75 MB after 10 minutes of recording. - */ - AUDIO_RECORDING_QUALITY_HIGH = 2, +/** Audio recording quality, which is set in + * \ref IRtcEngine::startAudioRecording(const AudioRecordingConfiguration&) "startAudioRecording". + */ +enum AUDIO_RECORDING_QUALITY_TYPE { + /** 0: Low quality. For example, the size of an AAC file with a sample rate + * of 32,000 Hz and a 10-minute recording is approximately 1.2 MB. + */ + AUDIO_RECORDING_QUALITY_LOW = 0, + /** 1: (Default) Medium quality. For example, the size of an AAC file with + * a sample rate of 32,000 Hz and a 10-minute recording is approximately + * 2 MB. + */ + AUDIO_RECORDING_QUALITY_MEDIUM = 1, + /** 2: High quality. For example, the size of an AAC file with a sample rate + * of 32,000 Hz and a 10-minute recording is approximately 3.75 MB. + */ + AUDIO_RECORDING_QUALITY_HIGH = 2, }; /** Network quality types. */ -enum QUALITY_TYPE -{ - /** 0: The network quality is unknown. */ - QUALITY_UNKNOWN = 0, - /** 1: The network quality is excellent. */ - QUALITY_EXCELLENT = 1, - /** 2: The network quality is quite good, but the bitrate may be slightly lower than excellent. */ - QUALITY_GOOD = 2, - /** 3: Users can feel the communication slightly impaired. */ - QUALITY_POOR = 3, - /** 4: Users cannot communicate smoothly. */ - QUALITY_BAD = 4, - /** 5: The network is so bad that users can barely communicate. */ - QUALITY_VBAD = 5, - /** 6: The network is down and users cannot communicate at all. */ - QUALITY_DOWN = 6, - /** 7: Users cannot detect the network quality. (Not in use.) */ - QUALITY_UNSUPPORTED = 7, - /** 8: Detecting the network quality. */ - QUALITY_DETECTING = 8, +enum QUALITY_TYPE { + /** 0: The network quality is unknown. */ + QUALITY_UNKNOWN = 0, + /** 1: The network quality is excellent. */ + QUALITY_EXCELLENT = 1, + /** 2: The network quality is quite good, but the bitrate may be slightly lower than excellent. */ + QUALITY_GOOD = 2, + /** 3: Users can feel the communication slightly impaired. */ + QUALITY_POOR = 3, + /** 4: Users cannot communicate smoothly. */ + QUALITY_BAD = 4, + /** 5: The network is so bad that users can barely communicate. */ + QUALITY_VBAD = 5, + /** 6: The network is down and users cannot communicate at all. */ + QUALITY_DOWN = 6, + /** 7: Users cannot detect the network quality. (Not in use.) */ + QUALITY_UNSUPPORTED = 7, + /** 8: Detecting the network quality. */ + QUALITY_DETECTING = 8, }; /** Video display modes. */ -enum RENDER_MODE_TYPE -{ +enum RENDER_MODE_TYPE { /** 1: Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents. */ - RENDER_MODE_HIDDEN = 1, - /** + RENDER_MODE_HIDDEN = 1, + /** 2: Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to disparity in the aspect ratio are filled with black. - */ - RENDER_MODE_FIT = 2, - /** **DEPRECATED** 3: This mode is deprecated. - */ - RENDER_MODE_ADAPTIVE = 3, - /** - 4: The fill mode. In this mode, the SDK stretches or zooms the video to fill the display window. - */ - RENDER_MODE_FILL = 4, +*/ + RENDER_MODE_FIT = 2, + /** **DEPRECATED** 3: This mode is deprecated. + */ + RENDER_MODE_ADAPTIVE = 3, + /** + 4: The fill mode. In this mode, the SDK stretches or zooms the video to fill the display window. + */ + RENDER_MODE_FILL = 4, }; /** Video mirror modes. */ -enum VIDEO_MIRROR_MODE_TYPE -{ - /** 0: (Default) The SDK enables the mirror mode. - */ - VIDEO_MIRROR_MODE_AUTO = 0,//determined by SDK - /** 1: Enable mirror mode. */ - VIDEO_MIRROR_MODE_ENABLED = 1,//enabled mirror - /** 2: Disable mirror mode. */ - VIDEO_MIRROR_MODE_DISABLED = 2,//disable mirror +enum VIDEO_MIRROR_MODE_TYPE { + /** 0: (Default) The SDK enables the mirror mode. + */ + VIDEO_MIRROR_MODE_AUTO = 0, // determined by SDK + /** 1: Enable mirror mode. */ + VIDEO_MIRROR_MODE_ENABLED = 1, // enabled mirror + /** 2: Disable mirror mode. */ + VIDEO_MIRROR_MODE_DISABLED = 2, // disable mirror }; -/** **DEPRECATED** Video profiles. */ -enum VIDEO_PROFILE_TYPE -{ - /** 0: 160 * 120, frame rate 15 fps, bitrate 65 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_120P = 0, - /** 2: 120 * 120, frame rate 15 fps, bitrate 50 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_120P_3 = 2, - /** 10: 320*180, frame rate 15 fps, bitrate 140 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_180P = 10, - /** 12: 180 * 180, frame rate 15 fps, bitrate 100 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_180P_3 = 12, - /** 13: 240 * 180, frame rate 15 fps, bitrate 120 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_180P_4 = 13, - /** 20: 320 * 240, frame rate 15 fps, bitrate 200 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_240P = 20, - /** 22: 240 * 240, frame rate 15 fps, bitrate 140 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_240P_3 = 22, - /** 23: 424 * 240, frame rate 15 fps, bitrate 220 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_240P_4 = 23, - /** 30: 640 * 360, frame rate 15 fps, bitrate 400 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_360P = 30, - /** 32: 360 * 360, frame rate 15 fps, bitrate 260 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_360P_3 = 32, - /** 33: 640 * 360, frame rate 30 fps, bitrate 600 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_360P_4 = 33, - /** 35: 360 * 360, frame rate 30 fps, bitrate 400 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_360P_6 = 35, - /** 36: 480 * 360, frame rate 15 fps, bitrate 320 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_360P_7 = 36, - /** 37: 480 * 360, frame rate 30 fps, bitrate 490 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_360P_8 = 37, - /** 38: 640 * 360, frame rate 15 fps, bitrate 800 Kbps. - @note `LIVE_BROADCASTING` profile only. - */ - VIDEO_PROFILE_LANDSCAPE_360P_9 = 38, - /** 39: 640 * 360, frame rate 24 fps, bitrate 800 Kbps. - @note `LIVE_BROADCASTING` profile only. - */ - VIDEO_PROFILE_LANDSCAPE_360P_10 = 39, - /** 100: 640 * 360, frame rate 24 fps, bitrate 1000 Kbps. - @note `LIVE_BROADCASTING` profile only. - */ - VIDEO_PROFILE_LANDSCAPE_360P_11 = 100, - /** 40: 640 * 480, frame rate 15 fps, bitrate 500 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_480P = 40, - /** 42: 480 * 480, frame rate 15 fps, bitrate 400 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_480P_3 = 42, - /** 43: 640 * 480, frame rate 30 fps, bitrate 750 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_480P_4 = 43, - /** 45: 480 * 480, frame rate 30 fps, bitrate 600 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_480P_6 = 45, - /** 47: 848 * 480, frame rate 15 fps, bitrate 610 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_480P_8 = 47, - /** 48: 848 * 480, frame rate 30 fps, bitrate 930 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_480P_9 = 48, - /** 49: 640 * 480, frame rate 10 fps, bitrate 400 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_480P_10 = 49, - /** 50: 1280 * 720, frame rate 15 fps, bitrate 1130 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_720P = 50, - /** 52: 1280 * 720, frame rate 30 fps, bitrate 1710 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_720P_3 = 52, - /** 54: 960 * 720, frame rate 15 fps, bitrate 910 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_720P_5 = 54, - /** 55: 960 * 720, frame rate 30 fps, bitrate 1380 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_720P_6 = 55, - /** 60: 1920 * 1080, frame rate 15 fps, bitrate 2080 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_1080P = 60, - /** 62: 1920 * 1080, frame rate 30 fps, bitrate 3150 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_1080P_3 = 62, - /** 64: 1920 * 1080, frame rate 60 fps, bitrate 4780 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_1080P_5 = 64, - /** 66: 2560 * 1440, frame rate 30 fps, bitrate 4850 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_1440P = 66, - /** 67: 2560 * 1440, frame rate 60 fps, bitrate 6500 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_1440P_2 = 67, - /** 70: 3840 * 2160, frame rate 30 fps, bitrate 6500 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_4K = 70, - /** 72: 3840 * 2160, frame rate 60 fps, bitrate 6500 Kbps. */ - VIDEO_PROFILE_LANDSCAPE_4K_3 = 72, - /** 1000: 120 * 160, frame rate 15 fps, bitrate 65 Kbps. */ - VIDEO_PROFILE_PORTRAIT_120P = 1000, - /** 1002: 120 * 120, frame rate 15 fps, bitrate 50 Kbps. */ - VIDEO_PROFILE_PORTRAIT_120P_3 = 1002, - /** 1010: 180 * 320, frame rate 15 fps, bitrate 140 Kbps. */ - VIDEO_PROFILE_PORTRAIT_180P = 1010, - /** 1012: 180 * 180, frame rate 15 fps, bitrate 100 Kbps. */ - VIDEO_PROFILE_PORTRAIT_180P_3 = 1012, - /** 1013: 180 * 240, frame rate 15 fps, bitrate 120 Kbps. */ - VIDEO_PROFILE_PORTRAIT_180P_4 = 1013, - /** 1020: 240 * 320, frame rate 15 fps, bitrate 200 Kbps. */ - VIDEO_PROFILE_PORTRAIT_240P = 1020, - /** 1022: 240 * 240, frame rate 15 fps, bitrate 140 Kbps. */ - VIDEO_PROFILE_PORTRAIT_240P_3 = 1022, - /** 1023: 240 * 424, frame rate 15 fps, bitrate 220 Kbps. */ - VIDEO_PROFILE_PORTRAIT_240P_4 = 1023, - /** 1030: 360 * 640, frame rate 15 fps, bitrate 400 Kbps. */ - VIDEO_PROFILE_PORTRAIT_360P = 1030, - /** 1032: 360 * 360, frame rate 15 fps, bitrate 260 Kbps. */ - VIDEO_PROFILE_PORTRAIT_360P_3 = 1032, - /** 1033: 360 * 640, frame rate 30 fps, bitrate 600 Kbps. */ - VIDEO_PROFILE_PORTRAIT_360P_4 = 1033, - /** 1035: 360 * 360, frame rate 30 fps, bitrate 400 Kbps. */ - VIDEO_PROFILE_PORTRAIT_360P_6 = 1035, - /** 1036: 360 * 480, frame rate 15 fps, bitrate 320 Kbps. */ - VIDEO_PROFILE_PORTRAIT_360P_7 = 1036, - /** 1037: 360 * 480, frame rate 30 fps, bitrate 490 Kbps. */ - VIDEO_PROFILE_PORTRAIT_360P_8 = 1037, - /** 1038: 360 * 640, frame rate 15 fps, bitrate 800 Kbps. - @note `LIVE_BROADCASTING` profile only. - */ - VIDEO_PROFILE_PORTRAIT_360P_9 = 1038, - /** 1039: 360 * 640, frame rate 24 fps, bitrate 800 Kbps. - @note `LIVE_BROADCASTING` profile only. - */ - VIDEO_PROFILE_PORTRAIT_360P_10 = 1039, - /** 1100: 360 * 640, frame rate 24 fps, bitrate 1000 Kbps. - @note `LIVE_BROADCASTING` profile only. - */ - VIDEO_PROFILE_PORTRAIT_360P_11 = 1100, - /** 1040: 480 * 640, frame rate 15 fps, bitrate 500 Kbps. */ - VIDEO_PROFILE_PORTRAIT_480P = 1040, - /** 1042: 480 * 480, frame rate 15 fps, bitrate 400 Kbps. */ - VIDEO_PROFILE_PORTRAIT_480P_3 = 1042, - /** 1043: 480 * 640, frame rate 30 fps, bitrate 750 Kbps. */ - VIDEO_PROFILE_PORTRAIT_480P_4 = 1043, - /** 1045: 480 * 480, frame rate 30 fps, bitrate 600 Kbps. */ - VIDEO_PROFILE_PORTRAIT_480P_6 = 1045, - /** 1047: 480 * 848, frame rate 15 fps, bitrate 610 Kbps. */ - VIDEO_PROFILE_PORTRAIT_480P_8 = 1047, - /** 1048: 480 * 848, frame rate 30 fps, bitrate 930 Kbps. */ - VIDEO_PROFILE_PORTRAIT_480P_9 = 1048, - /** 1049: 480 * 640, frame rate 10 fps, bitrate 400 Kbps. */ - VIDEO_PROFILE_PORTRAIT_480P_10 = 1049, - /** 1050: 720 * 1280, frame rate 15 fps, bitrate 1130 Kbps. */ - VIDEO_PROFILE_PORTRAIT_720P = 1050, - /** 1052: 720 * 1280, frame rate 30 fps, bitrate 1710 Kbps. */ - VIDEO_PROFILE_PORTRAIT_720P_3 = 1052, - /** 1054: 720 * 960, frame rate 15 fps, bitrate 910 Kbps. */ - VIDEO_PROFILE_PORTRAIT_720P_5 = 1054, - /** 1055: 720 * 960, frame rate 30 fps, bitrate 1380 Kbps. */ - VIDEO_PROFILE_PORTRAIT_720P_6 = 1055, - /** 1060: 1080 * 1920, frame rate 15 fps, bitrate 2080 Kbps. */ - VIDEO_PROFILE_PORTRAIT_1080P = 1060, - /** 1062: 1080 * 1920, frame rate 30 fps, bitrate 3150 Kbps. */ - VIDEO_PROFILE_PORTRAIT_1080P_3 = 1062, - /** 1064: 1080 * 1920, frame rate 60 fps, bitrate 4780 Kbps. */ - VIDEO_PROFILE_PORTRAIT_1080P_5 = 1064, - /** 1066: 1440 * 2560, frame rate 30 fps, bitrate 4850 Kbps. */ - VIDEO_PROFILE_PORTRAIT_1440P = 1066, - /** 1067: 1440 * 2560, frame rate 60 fps, bitrate 6500 Kbps. */ - VIDEO_PROFILE_PORTRAIT_1440P_2 = 1067, - /** 1070: 2160 * 3840, frame rate 30 fps, bitrate 6500 Kbps. */ - VIDEO_PROFILE_PORTRAIT_4K = 1070, - /** 1072: 2160 * 3840, frame rate 60 fps, bitrate 6500 Kbps. */ - VIDEO_PROFILE_PORTRAIT_4K_3 = 1072, - /** Default 640 * 360, frame rate 15 fps, bitrate 400 Kbps. */ - VIDEO_PROFILE_DEFAULT = VIDEO_PROFILE_LANDSCAPE_360P, +/** @deprecated Video profiles. */ +enum VIDEO_PROFILE_TYPE { + /** 0: 160 * 120, frame rate 15 fps, bitrate 65 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_120P = 0, + /** 2: 120 * 120, frame rate 15 fps, bitrate 50 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_120P_3 = 2, + /** 10: 320*180, frame rate 15 fps, bitrate 140 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_180P = 10, + /** 12: 180 * 180, frame rate 15 fps, bitrate 100 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_180P_3 = 12, + /** 13: 240 * 180, frame rate 15 fps, bitrate 120 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_180P_4 = 13, + /** 20: 320 * 240, frame rate 15 fps, bitrate 200 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_240P = 20, + /** 22: 240 * 240, frame rate 15 fps, bitrate 140 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_240P_3 = 22, + /** 23: 424 * 240, frame rate 15 fps, bitrate 220 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_240P_4 = 23, + /** 30: 640 * 360, frame rate 15 fps, bitrate 400 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_360P = 30, + /** 32: 360 * 360, frame rate 15 fps, bitrate 260 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_360P_3 = 32, + /** 33: 640 * 360, frame rate 30 fps, bitrate 600 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_360P_4 = 33, + /** 35: 360 * 360, frame rate 30 fps, bitrate 400 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_360P_6 = 35, + /** 36: 480 * 360, frame rate 15 fps, bitrate 320 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_360P_7 = 36, + /** 37: 480 * 360, frame rate 30 fps, bitrate 490 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_360P_8 = 37, + /** 38: 640 * 360, frame rate 15 fps, bitrate 800 Kbps. + @note `LIVE_BROADCASTING` profile only. + */ + VIDEO_PROFILE_LANDSCAPE_360P_9 = 38, + /** 39: 640 * 360, frame rate 24 fps, bitrate 800 Kbps. + @note `LIVE_BROADCASTING` profile only. + */ + VIDEO_PROFILE_LANDSCAPE_360P_10 = 39, + /** 100: 640 * 360, frame rate 24 fps, bitrate 1000 Kbps. + @note `LIVE_BROADCASTING` profile only. + */ + VIDEO_PROFILE_LANDSCAPE_360P_11 = 100, + /** 40: 640 * 480, frame rate 15 fps, bitrate 500 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_480P = 40, + /** 42: 480 * 480, frame rate 15 fps, bitrate 400 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_480P_3 = 42, + /** 43: 640 * 480, frame rate 30 fps, bitrate 750 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_480P_4 = 43, + /** 45: 480 * 480, frame rate 30 fps, bitrate 600 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_480P_6 = 45, + /** 47: 848 * 480, frame rate 15 fps, bitrate 610 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_480P_8 = 47, + /** 48: 848 * 480, frame rate 30 fps, bitrate 930 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_480P_9 = 48, + /** 49: 640 * 480, frame rate 10 fps, bitrate 400 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_480P_10 = 49, + /** 50: 1280 * 720, frame rate 15 fps, bitrate 1130 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_720P = 50, + /** 52: 1280 * 720, frame rate 30 fps, bitrate 1710 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_720P_3 = 52, + /** 54: 960 * 720, frame rate 15 fps, bitrate 910 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_720P_5 = 54, + /** 55: 960 * 720, frame rate 30 fps, bitrate 1380 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_720P_6 = 55, + /** 60: 1920 * 1080, frame rate 15 fps, bitrate 2080 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_1080P = 60, + /** 62: 1920 * 1080, frame rate 30 fps, bitrate 3150 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_1080P_3 = 62, + /** 64: 1920 * 1080, frame rate 60 fps, bitrate 4780 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_1080P_5 = 64, + /** 66: 2560 * 1440, frame rate 30 fps, bitrate 4850 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_1440P = 66, + /** 67: 2560 * 1440, frame rate 60 fps, bitrate 6500 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_1440P_2 = 67, + /** 70: 3840 * 2160, frame rate 30 fps, bitrate 6500 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_4K = 70, + /** 72: 3840 * 2160, frame rate 60 fps, bitrate 6500 Kbps. */ + VIDEO_PROFILE_LANDSCAPE_4K_3 = 72, + /** 1000: 120 * 160, frame rate 15 fps, bitrate 65 Kbps. */ + VIDEO_PROFILE_PORTRAIT_120P = 1000, + /** 1002: 120 * 120, frame rate 15 fps, bitrate 50 Kbps. */ + VIDEO_PROFILE_PORTRAIT_120P_3 = 1002, + /** 1010: 180 * 320, frame rate 15 fps, bitrate 140 Kbps. */ + VIDEO_PROFILE_PORTRAIT_180P = 1010, + /** 1012: 180 * 180, frame rate 15 fps, bitrate 100 Kbps. */ + VIDEO_PROFILE_PORTRAIT_180P_3 = 1012, + /** 1013: 180 * 240, frame rate 15 fps, bitrate 120 Kbps. */ + VIDEO_PROFILE_PORTRAIT_180P_4 = 1013, + /** 1020: 240 * 320, frame rate 15 fps, bitrate 200 Kbps. */ + VIDEO_PROFILE_PORTRAIT_240P = 1020, + /** 1022: 240 * 240, frame rate 15 fps, bitrate 140 Kbps. */ + VIDEO_PROFILE_PORTRAIT_240P_3 = 1022, + /** 1023: 240 * 424, frame rate 15 fps, bitrate 220 Kbps. */ + VIDEO_PROFILE_PORTRAIT_240P_4 = 1023, + /** 1030: 360 * 640, frame rate 15 fps, bitrate 400 Kbps. */ + VIDEO_PROFILE_PORTRAIT_360P = 1030, + /** 1032: 360 * 360, frame rate 15 fps, bitrate 260 Kbps. */ + VIDEO_PROFILE_PORTRAIT_360P_3 = 1032, + /** 1033: 360 * 640, frame rate 30 fps, bitrate 600 Kbps. */ + VIDEO_PROFILE_PORTRAIT_360P_4 = 1033, + /** 1035: 360 * 360, frame rate 30 fps, bitrate 400 Kbps. */ + VIDEO_PROFILE_PORTRAIT_360P_6 = 1035, + /** 1036: 360 * 480, frame rate 15 fps, bitrate 320 Kbps. */ + VIDEO_PROFILE_PORTRAIT_360P_7 = 1036, + /** 1037: 360 * 480, frame rate 30 fps, bitrate 490 Kbps. */ + VIDEO_PROFILE_PORTRAIT_360P_8 = 1037, + /** 1038: 360 * 640, frame rate 15 fps, bitrate 800 Kbps. + @note `LIVE_BROADCASTING` profile only. + */ + VIDEO_PROFILE_PORTRAIT_360P_9 = 1038, + /** 1039: 360 * 640, frame rate 24 fps, bitrate 800 Kbps. + @note `LIVE_BROADCASTING` profile only. + */ + VIDEO_PROFILE_PORTRAIT_360P_10 = 1039, + /** 1100: 360 * 640, frame rate 24 fps, bitrate 1000 Kbps. + @note `LIVE_BROADCASTING` profile only. + */ + VIDEO_PROFILE_PORTRAIT_360P_11 = 1100, + /** 1040: 480 * 640, frame rate 15 fps, bitrate 500 Kbps. */ + VIDEO_PROFILE_PORTRAIT_480P = 1040, + /** 1042: 480 * 480, frame rate 15 fps, bitrate 400 Kbps. */ + VIDEO_PROFILE_PORTRAIT_480P_3 = 1042, + /** 1043: 480 * 640, frame rate 30 fps, bitrate 750 Kbps. */ + VIDEO_PROFILE_PORTRAIT_480P_4 = 1043, + /** 1045: 480 * 480, frame rate 30 fps, bitrate 600 Kbps. */ + VIDEO_PROFILE_PORTRAIT_480P_6 = 1045, + /** 1047: 480 * 848, frame rate 15 fps, bitrate 610 Kbps. */ + VIDEO_PROFILE_PORTRAIT_480P_8 = 1047, + /** 1048: 480 * 848, frame rate 30 fps, bitrate 930 Kbps. */ + VIDEO_PROFILE_PORTRAIT_480P_9 = 1048, + /** 1049: 480 * 640, frame rate 10 fps, bitrate 400 Kbps. */ + VIDEO_PROFILE_PORTRAIT_480P_10 = 1049, + /** 1050: 720 * 1280, frame rate 15 fps, bitrate 1130 Kbps. */ + VIDEO_PROFILE_PORTRAIT_720P = 1050, + /** 1052: 720 * 1280, frame rate 30 fps, bitrate 1710 Kbps. */ + VIDEO_PROFILE_PORTRAIT_720P_3 = 1052, + /** 1054: 720 * 960, frame rate 15 fps, bitrate 910 Kbps. */ + VIDEO_PROFILE_PORTRAIT_720P_5 = 1054, + /** 1055: 720 * 960, frame rate 30 fps, bitrate 1380 Kbps. */ + VIDEO_PROFILE_PORTRAIT_720P_6 = 1055, + /** 1060: 1080 * 1920, frame rate 15 fps, bitrate 2080 Kbps. */ + VIDEO_PROFILE_PORTRAIT_1080P = 1060, + /** 1062: 1080 * 1920, frame rate 30 fps, bitrate 3150 Kbps. */ + VIDEO_PROFILE_PORTRAIT_1080P_3 = 1062, + /** 1064: 1080 * 1920, frame rate 60 fps, bitrate 4780 Kbps. */ + VIDEO_PROFILE_PORTRAIT_1080P_5 = 1064, + /** 1066: 1440 * 2560, frame rate 30 fps, bitrate 4850 Kbps. */ + VIDEO_PROFILE_PORTRAIT_1440P = 1066, + /** 1067: 1440 * 2560, frame rate 60 fps, bitrate 6500 Kbps. */ + VIDEO_PROFILE_PORTRAIT_1440P_2 = 1067, + /** 1070: 2160 * 3840, frame rate 30 fps, bitrate 6500 Kbps. */ + VIDEO_PROFILE_PORTRAIT_4K = 1070, + /** 1072: 2160 * 3840, frame rate 60 fps, bitrate 6500 Kbps. */ + VIDEO_PROFILE_PORTRAIT_4K_3 = 1072, + /** Default 640 * 360, frame rate 15 fps, bitrate 400 Kbps. */ + VIDEO_PROFILE_DEFAULT = VIDEO_PROFILE_LANDSCAPE_360P, }; /** Audio profiles. Sets the sample rate, bitrate, encoding mode, and the number of channels:*/ -enum AUDIO_PROFILE_TYPE // sample rate, bit rate, mono/stereo, speech/music codec +enum AUDIO_PROFILE_TYPE // sample rate, bit rate, mono/stereo, speech/music codec { - /** - 0: Default audio profile: - - For the interactive streaming profile: A sample rate of 48 KHz, music encoding, mono, and a bitrate of up to 64 Kbps. - - For the `COMMUNICATION` profile: - - Windows: A sample rate of 16 KHz, music encoding, mono, and a bitrate of up to 16 Kbps. - - Android/macOS/iOS: A sample rate of 32 KHz, music encoding, mono, and a bitrate of up to 18 Kbps. - */ - AUDIO_PROFILE_DEFAULT = 0, // use default settings - /** - 1: A sample rate of 32 KHz, audio encoding, mono, and a bitrate of up to 18 Kbps. - */ - AUDIO_PROFILE_SPEECH_STANDARD = 1, // 32Khz, 18Kbps, mono, speech - /** - 2: A sample rate of 48 KHz, music encoding, mono, and a bitrate of up to 64 Kbps. - */ - AUDIO_PROFILE_MUSIC_STANDARD = 2, // 48Khz, 48Kbps, mono, music - /** - 3: A sample rate of 48 KHz, music encoding, stereo, and a bitrate of up to 80 Kbps. - */ - AUDIO_PROFILE_MUSIC_STANDARD_STEREO = 3, // 48Khz, 56Kbps, stereo, music - /** - 4: A sample rate of 48 KHz, music encoding, mono, and a bitrate of up to 96 Kbps. - */ - AUDIO_PROFILE_MUSIC_HIGH_QUALITY = 4, // 48Khz, 128Kbps, mono, music - /** - 5: A sample rate of 48 KHz, music encoding, stereo, and a bitrate of up to 128 Kbps. - */ - AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO = 5, // 48Khz, 192Kbps, stereo, music - /** - 6: A sample rate of 16 KHz, audio encoding, mono, and Acoustic Echo Cancellation (AES) enabled. - */ - AUDIO_PROFILE_IOT = 6, - AUDIO_PROFILE_NUM = 7, + /** + 0: Default audio profile: + - For the interactive streaming profile: A sample rate of 48 KHz, music encoding, mono, and a bitrate of up to 64 Kbps. + - For the `COMMUNICATION` profile: + - Windows: A sample rate of 16 KHz, music encoding, mono, and a bitrate of up to 16 Kbps. + - Android/macOS/iOS: A sample rate of 32 KHz, music encoding, mono, and a bitrate of up to 18 Kbps. + */ + AUDIO_PROFILE_DEFAULT = 0, // use default settings + /** + 1: A sample rate of 32 KHz, audio encoding, mono, and a bitrate of up to 18 Kbps. + */ + AUDIO_PROFILE_SPEECH_STANDARD = 1, // 32Khz, 18Kbps, mono, speech + /** + 2: A sample rate of 48 KHz, music encoding, mono, and a bitrate of up to 64 Kbps. + */ + AUDIO_PROFILE_MUSIC_STANDARD = 2, // 48Khz, 48Kbps, mono, music + /** + 3: A sample rate of 48 KHz, music encoding, stereo, and a bitrate of up to 80 Kbps. + */ + AUDIO_PROFILE_MUSIC_STANDARD_STEREO = 3, // 48Khz, 56Kbps, stereo, music + /** + 4: A sample rate of 48 KHz, music encoding, mono, and a bitrate of up to 96 Kbps. + */ + AUDIO_PROFILE_MUSIC_HIGH_QUALITY = 4, // 48Khz, 128Kbps, mono, music + /** + 5: A sample rate of 48 KHz, music encoding, stereo, and a bitrate of up to 128 Kbps. + */ + AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO = 5, // 48Khz, 192Kbps, stereo, music + /** + 6: A sample rate of 16 KHz, audio encoding, mono, and Acoustic Echo Cancellation (AES) enabled. + */ + AUDIO_PROFILE_IOT = 6, + /// @cond + AUDIO_PROFILE_NUM = 7, + /// @endcond }; /** Audio application scenarios. -*/ -enum AUDIO_SCENARIO_TYPE // set a suitable scenario for your app type + */ +enum AUDIO_SCENARIO_TYPE // set a suitable scenario for your app type { - /** 0: Default audio scenario. */ - AUDIO_SCENARIO_DEFAULT = 0, - /** 1: Entertainment scenario where users need to frequently switch the user role. */ - AUDIO_SCENARIO_CHATROOM_ENTERTAINMENT = 1, - /** 2: Education scenario where users want smoothness and stability. */ - AUDIO_SCENARIO_EDUCATION = 2, - /** 3: High-quality audio chatroom scenario where hosts mainly play music. */ - AUDIO_SCENARIO_GAME_STREAMING = 3, - /** 4: Showroom scenario where a single host wants high-quality audio. */ - AUDIO_SCENARIO_SHOWROOM = 4, - /** 5: Gaming scenario for group chat that only contains the human voice. */ - AUDIO_SCENARIO_CHATROOM_GAMING = 5, - /** 6: IoT (Internet of Things) scenario where users use IoT devices with low power consumption. */ - AUDIO_SCENARIO_IOT = 6, - /** 8: Meeting scenario that mainly contains the human voice. - * - * @since v3.2.0 - */ - AUDIO_SCENARIO_MEETING = 8, - /** The number of elements in the enumeration. - */ - AUDIO_SCENARIO_NUM = 9, + /** 0: Default audio scenario. */ + AUDIO_SCENARIO_DEFAULT = 0, + /** 1: Entertainment scenario where users need to frequently switch the user role. */ + AUDIO_SCENARIO_CHATROOM_ENTERTAINMENT = 1, + /** 2: Education scenario where users want smoothness and stability. */ + AUDIO_SCENARIO_EDUCATION = 2, + /** 3: High-quality audio chatroom scenario where hosts mainly play music. */ + AUDIO_SCENARIO_GAME_STREAMING = 3, + /** 4: Showroom scenario where a single host wants high-quality audio. */ + AUDIO_SCENARIO_SHOWROOM = 4, + /** 5: Gaming scenario for group chat that only contains the human voice. */ + AUDIO_SCENARIO_CHATROOM_GAMING = 5, + /** 6: IoT (Internet of Things) scenario where users use IoT devices with low power consumption. */ + AUDIO_SCENARIO_IOT = 6, + /** 8: Meeting scenario that mainly contains the human voice. + * + * @since v3.2.0 + */ + AUDIO_SCENARIO_MEETING = 8, + /** The number of elements in the enumeration. + */ + AUDIO_SCENARIO_NUM = 9, }; - /** The channel profile. +/** The channel profile. */ -enum CHANNEL_PROFILE_TYPE -{ - /** (Default) Communication. This profile applies to scenarios such as an audio call or video call, - * where all users can publish and subscribe to streams. - */ - CHANNEL_PROFILE_COMMUNICATION = 0, - /** Live streaming. In this profile, uses have roles, namely, host and audience (default). - * A host both publishes and subscribes to streams, while an audience subscribes to streams only. - * This profile applies to scenarios such as a chat room or interactive video streaming. - */ - CHANNEL_PROFILE_LIVE_BROADCASTING = 1, - /** 2: Gaming. This profile uses a codec with a lower bitrate and consumes less power. Applies to the gaming scenario, where all game players can talk freely. - * - * @note Agora does not recommend using this setting. - */ - CHANNEL_PROFILE_GAME = 2, +enum CHANNEL_PROFILE_TYPE { + /** (Default) Communication. This profile applies to scenarios such as an audio call or video call, + * where all users can publish and subscribe to streams. + */ + CHANNEL_PROFILE_COMMUNICATION = 0, + /** Live streaming. In this profile, uses have roles, namely, host and audience (default). + * A host both publishes and subscribes to streams, while an audience subscribes to streams only. + * This profile applies to scenarios such as a chat room or interactive video streaming. + */ + CHANNEL_PROFILE_LIVE_BROADCASTING = 1, + /** 2: Gaming. This profile uses a codec with a lower bitrate and consumes less power. Applies to the gaming scenario, where all game players can talk freely. + * + * @note Agora does not recommend using this setting. + */ + CHANNEL_PROFILE_GAME = 2, }; -/// @cond -/** The role of a user in a live interactive streaming. */ -enum CLIENT_ROLE_TYPE -{ - /** 1: Host. A host can both send and receive streams. */ - CLIENT_ROLE_BROADCASTER = 1, - /** 2: (Default) Audience. An `audience` member can only receive streams. */ - CLIENT_ROLE_AUDIENCE = 2, + +/** The role of a user in interactive live streaming. */ +enum CLIENT_ROLE_TYPE { + /** 1: Host. A host can both send and receive streams. */ + CLIENT_ROLE_BROADCASTER = 1, + /** 2: (Default) Audience. An `audience` member can only receive streams. */ + CLIENT_ROLE_AUDIENCE = 2, }; -/** The latency level of an audience member in a live interactive streaming. +/** The latency level of an audience member in interactive live streaming. * * @note Takes effect only when the user role is `CLIENT_ROLE_BROADCASTER`. */ -enum AUDIENCE_LATENCY_LEVEL_TYPE -{ - /** 1: Low latency. */ - AUDIENCE_LATENCY_LEVEL_LOW_LATENCY = 1, - /** 2: (Default) Ultra low latency. */ - AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY = 2, +enum AUDIENCE_LATENCY_LEVEL_TYPE { + /** 1: Low latency. */ + AUDIENCE_LATENCY_LEVEL_LOW_LATENCY = 1, + /** 2: (Default) Ultra low latency. */ + AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY = 2, }; /// @cond /** The reason why the super-resolution algorithm is not successfully enabled. */ -enum SUPER_RESOLUTION_STATE_REASON -{ - /** 0: The super-resolution algorithm is successfully enabled. - */ - SR_STATE_REASON_SUCCESS = 0, - /** 1: The origin resolution of the remote video is beyond the range where - * the super-resolution algorithm can be applied. - */ - SR_STATE_REASON_STREAM_OVER_LIMITATION = 1, - /** 2: Another user is already using the super-resolution algorithm. - */ - SR_STATE_REASON_USER_COUNT_OVER_LIMITATION = 2, - /** 3: The device does not support the super-resolution algorithm. - */ - SR_STATE_REASON_DEVICE_NOT_SUPPORTED = 3, +enum SUPER_RESOLUTION_STATE_REASON { + /** 0: The super-resolution algorithm is successfully enabled. + */ + SR_STATE_REASON_SUCCESS = 0, + /** 1: The origin resolution of the remote video is beyond the range where + * the super-resolution algorithm can be applied. + */ + SR_STATE_REASON_STREAM_OVER_LIMITATION = 1, + /** 2: Another user is already using the super-resolution algorithm. + */ + SR_STATE_REASON_USER_COUNT_OVER_LIMITATION = 2, + /** 3: The device does not support the super-resolution algorithm. + */ + SR_STATE_REASON_DEVICE_NOT_SUPPORTED = 3, }; /// @endcond +enum VIRTUAL_BACKGROUND_SOURCE_STATE_REASON { + VIRTUAL_BACKGROUND_SOURCE_STATE_REASON_SUCCESS = 0, + // background image does not exist + VIRTUAL_BACKGROUND_SOURCE_STATE_REASON_IMAGE_NOT_EXIST = 1, + // color format is not supported + VIRTUAL_BACKGROUND_SOURCE_STATE_REASON_COLOR_FORMAT_NOT_SUPPORTED = 2, + // The device is not supported + VIRTUAL_BACKGROUND_SOURCE_STATE_REASON_DEVICE_NOT_SUPPORTED = 3, +}; + /** Reasons for a user being offline. */ -enum USER_OFFLINE_REASON_TYPE -{ - /** 0: The user quits the call. */ - USER_OFFLINE_QUIT = 0, - /** 1: The SDK times out and the user drops offline because no data packet is received within a certain period of time. If the user quits the call and the message is not passed to the SDK (due to an unreliable channel), the SDK assumes the user dropped offline. */ - USER_OFFLINE_DROPPED = 1, - /** 2: (`LIVE_BROADCASTING` only.) The client role switched from the host to the audience. */ - USER_OFFLINE_BECOME_AUDIENCE = 2, +enum USER_OFFLINE_REASON_TYPE { + /** 0: The user quits the call. */ + USER_OFFLINE_QUIT = 0, + /** 1: The SDK times out and the user drops offline because no data packet is received within a certain period of time. If the user quits the call and the message is not passed to the SDK (due to an unreliable channel), the SDK assumes the user dropped offline. */ + USER_OFFLINE_DROPPED = 1, + /** 2: (`LIVE_BROADCASTING` only.) The client role switched from the host to the audience. */ + USER_OFFLINE_BECOME_AUDIENCE = 2, }; /** - States of the RTMP streaming. + States of the RTMP or RTMPS streaming. */ -enum RTMP_STREAM_PUBLISH_STATE -{ - /** The RTMP streaming has not started or has ended. This state is also triggered after you remove an RTMP address from the CDN by calling removePublishStreamUrl. +enum RTMP_STREAM_PUBLISH_STATE { + /** The RTMP or RTMPS streaming has not started or has ended. This state is also triggered after you remove an RTMP or RTMPS stream from the CDN by calling `removePublishStreamUrl`. */ RTMP_STREAM_PUBLISH_STATE_IDLE = 0, - /** The SDK is connecting to Agora's streaming server and the RTMP server. This state is triggered after you call the \ref IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" method. + /** The SDK is connecting to Agora's streaming server and the CDN server. This state is triggered after you call the \ref IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" method. */ RTMP_STREAM_PUBLISH_STATE_CONNECTING = 1, - /** The RTMP streaming publishes. The SDK successfully publishes the RTMP streaming and returns this state. + /** The RTMP or RTMPS streaming publishes. The SDK successfully publishes the RTMP or RTMPS streaming and returns this state. */ RTMP_STREAM_PUBLISH_STATE_RUNNING = 2, - /** The RTMP streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted, the SDK tries to resume RTMP streaming and returns this state. + /** The RTMP or RTMPS streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted, the SDK tries to resume RTMP or RTMPS streaming and returns this state. - If the SDK successfully resumes the streaming, #RTMP_STREAM_PUBLISH_STATE_RUNNING (2) returns. - If the streaming does not resume within 60 seconds or server errors occur, #RTMP_STREAM_PUBLISH_STATE_FAILURE (4) returns. You can also reconnect to the server by calling the \ref IRtcEngine::removePublishStreamUrl "removePublishStreamUrl" and \ref IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" methods. */ RTMP_STREAM_PUBLISH_STATE_RECOVERING = 3, - /** The RTMP streaming fails. See the errCode parameter for the detailed error information. You can also call the \ref IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" method to publish the RTMP streaming again. + /** The RTMP or RTMPS streaming fails. See the errCode parameter for the detailed error information. You can also call the \ref IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" method to publish the RTMP or RTMPS streaming again. */ RTMP_STREAM_PUBLISH_STATE_FAILURE = 4, }; /** - Error codes of the RTMP streaming. + Error codes of the RTMP or RTMPS streaming. */ -enum RTMP_STREAM_PUBLISH_ERROR -{ - /** The RTMP streaming publishes successfully. */ +enum RTMP_STREAM_PUBLISH_ERROR { + /** The RTMP or RTMPS streaming publishes successfully. */ RTMP_STREAM_PUBLISH_ERROR_OK = 0, /** Invalid argument used. If, for example, you do not call the \ref IRtcEngine::setLiveTranscoding "setLiveTranscoding" method to configure the LiveTranscoding parameters before calling the addPublishStreamUrl method, the SDK returns this error. Check whether you set the parameters in the *setLiveTranscoding* method properly. */ RTMP_STREAM_PUBLISH_ERROR_INVALID_ARGUMENT = 1, - /** The RTMP streaming is encrypted and cannot be published. */ + /** The RTMP or RTMPS streaming is encrypted and cannot be published. */ RTMP_STREAM_PUBLISH_ERROR_ENCRYPTED_STREAM_NOT_ALLOWED = 2, - /** Timeout for the RTMP streaming. Call the \ref IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" method to publish the streaming again. */ + /** Timeout for the RTMP or RTMPS streaming. Call the \ref IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" method to publish the streaming again. */ RTMP_STREAM_PUBLISH_ERROR_CONNECTION_TIMEOUT = 3, - /** An error occurs in Agora's streaming server. Call the addPublishStreamUrl method to publish the streaming again. */ + /** An error occurs in Agora's streaming server. Call the `addPublishStreamUrl` method to publish the streaming again. */ RTMP_STREAM_PUBLISH_ERROR_INTERNAL_SERVER_ERROR = 4, - /** An error occurs in the RTMP server. */ + /** An error occurs in the CDN server. */ RTMP_STREAM_PUBLISH_ERROR_RTMP_SERVER_ERROR = 5, - /** The RTMP streaming publishes too frequently. */ + /** The RTMP or RTMPS streaming publishes too frequently. */ RTMP_STREAM_PUBLISH_ERROR_TOO_OFTEN = 6, /** The host publishes more than 10 URLs. Delete the unnecessary URLs before adding new ones. */ RTMP_STREAM_PUBLISH_ERROR_REACH_LIMIT = 7, /** The host manipulates other hosts' URLs. Check your app logic. */ RTMP_STREAM_PUBLISH_ERROR_NOT_AUTHORIZED = 8, - /** Agora's server fails to find the RTMP streaming. */ + /** Agora's server fails to find the RTMP or RTMPS streaming. */ RTMP_STREAM_PUBLISH_ERROR_STREAM_NOT_FOUND = 9, - /** The format of the RTMP streaming URL is not supported. Check whether the URL format is correct. */ + /** The format of the RTMP or RTMPS streaming URL is not supported. Check whether the URL format is correct. */ RTMP_STREAM_PUBLISH_ERROR_FORMAT_NOT_SUPPORTED = 10, + /** The RTMP streaming unpublishes successfully. */ + RTMP_STREAM_UNPUBLISH_ERROR_OK = 100, }; -/** Events during the RTMP streaming. */ -enum RTMP_STREAMING_EVENT -{ - /** An error occurs when you add a background image or a watermark image to the RTMP stream. +/** Events during the RTMP or RTMPS streaming. */ +enum RTMP_STREAMING_EVENT { + /** An error occurs when you add a background image or a watermark image to the RTMP or RTMPS stream. */ RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE = 1, + /** The chosen URL address is already in use for CDN live streaming. + */ + RTMP_STREAMING_EVENT_URL_ALREADY_IN_USE = 2, }; -/** States of importing an external video stream in the live interactive streaming. */ -enum INJECT_STREAM_STATUS -{ - /** 0: The external video stream imported successfully. */ - INJECT_STREAM_STATUS_START_SUCCESS = 0, - /** 1: The external video stream already exists. */ - INJECT_STREAM_STATUS_START_ALREADY_EXISTS = 1, - /** 2: The external video stream to be imported is unauthorized. */ - INJECT_STREAM_STATUS_START_UNAUTHORIZED = 2, - /** 3: Import external video stream timeout. */ - INJECT_STREAM_STATUS_START_TIMEDOUT = 3, - /** 4: Import external video stream failed. */ - INJECT_STREAM_STATUS_START_FAILED = 4, - /** 5: The external video stream stopped importing successfully. */ - INJECT_STREAM_STATUS_STOP_SUCCESS = 5, - /** 6: No external video stream is found. */ - INJECT_STREAM_STATUS_STOP_NOT_FOUND = 6, - /** 7: The external video stream to be stopped importing is unauthorized. */ - INJECT_STREAM_STATUS_STOP_UNAUTHORIZED = 7, - /** 8: Stop importing external video stream timeout. */ - INJECT_STREAM_STATUS_STOP_TIMEDOUT = 8, - /** 9: Stop importing external video stream failed. */ - INJECT_STREAM_STATUS_STOP_FAILED = 9, - /** 10: The external video stream is corrupted. */ - INJECT_STREAM_STATUS_BROKEN = 10, +/** States of importing an external video stream in the interactive live streaming. */ +enum INJECT_STREAM_STATUS { + /** 0: The external video stream imported successfully. */ + INJECT_STREAM_STATUS_START_SUCCESS = 0, + /** 1: The external video stream already exists. */ + INJECT_STREAM_STATUS_START_ALREADY_EXISTS = 1, + /** 2: The external video stream to be imported is unauthorized. */ + INJECT_STREAM_STATUS_START_UNAUTHORIZED = 2, + /** 3: Import external video stream timeout. */ + INJECT_STREAM_STATUS_START_TIMEDOUT = 3, + /** 4: Import external video stream failed. */ + INJECT_STREAM_STATUS_START_FAILED = 4, + /** 5: The external video stream stopped importing successfully. */ + INJECT_STREAM_STATUS_STOP_SUCCESS = 5, + /** 6: No external video stream is found. */ + INJECT_STREAM_STATUS_STOP_NOT_FOUND = 6, + /** 7: The external video stream to be stopped importing is unauthorized. */ + INJECT_STREAM_STATUS_STOP_UNAUTHORIZED = 7, + /** 8: Stop importing external video stream timeout. */ + INJECT_STREAM_STATUS_STOP_TIMEDOUT = 8, + /** 9: Stop importing external video stream failed. */ + INJECT_STREAM_STATUS_STOP_FAILED = 9, + /** 10: The external video stream is corrupted. */ + INJECT_STREAM_STATUS_BROKEN = 10, }; /** Remote video stream types. */ -enum REMOTE_VIDEO_STREAM_TYPE -{ - /** 0: High-stream video. */ - REMOTE_VIDEO_STREAM_HIGH = 0, - /** 1: Low-stream video. */ - REMOTE_VIDEO_STREAM_LOW = 1, +enum REMOTE_VIDEO_STREAM_TYPE { + /** 0: High-stream video. */ + REMOTE_VIDEO_STREAM_HIGH = 0, + /** 1: Low-stream video. */ + REMOTE_VIDEO_STREAM_LOW = 1, +}; +/** The brightness level of the video image captured by the local camera. + * + * @since v3.3.0 + */ +enum CAPTURE_BRIGHTNESS_LEVEL_TYPE { + /** -1: The SDK does not detect the brightness level of the video image. + * Wait a few seconds to get the brightness level from `CAPTURE_BRIGHTNESS_LEVEL_TYPE` in the next callback. + */ + CAPTURE_BRIGHTNESS_LEVEL_INVALID = -1, + /** 0: The brightness level of the video image is normal. + */ + CAPTURE_BRIGHTNESS_LEVEL_NORMAL = 0, + /** 1: The brightness level of the video image is too bright. + */ + CAPTURE_BRIGHTNESS_LEVEL_BRIGHT = 1, + /** 2: The brightness level of the video image is too dark. + */ + CAPTURE_BRIGHTNESS_LEVEL_DARK = 2, }; /** The use mode of the audio data in the \ref media::IAudioFrameObserver::onRecordAudioFrame "onRecordAudioFrame" or \ref media::IAudioFrameObserver::onPlaybackAudioFrame "onPlaybackAudioFrame" callback. */ - enum RAW_AUDIO_FRAME_OP_MODE_TYPE -{ - /** 0: Read-only mode: Users only read the \ref agora::media::IAudioFrameObserver::AudioFrame "AudioFrame" data without modifying anything. For example, when users acquire the data with the Agora SDK, then push the RTMP streams. */ - RAW_AUDIO_FRAME_OP_MODE_READ_ONLY = 0, - /** 1: Write-only mode: Users replace the \ref agora::media::IAudioFrameObserver::AudioFrame "AudioFrame" data with their own data and pass the data to the SDK for encoding. For example, when users acquire the data. */ - RAW_AUDIO_FRAME_OP_MODE_WRITE_ONLY = 1, - /** 2: Read and write mode: Users read the data from \ref agora::media::IAudioFrameObserver::AudioFrame "AudioFrame", modify it, and then play it. For example, when users have their own sound-effect processing module and perform some voice pre-processing, such as a voice change. */ - RAW_AUDIO_FRAME_OP_MODE_READ_WRITE = 2, +enum RAW_AUDIO_FRAME_OP_MODE_TYPE { + /** 0: Read-only mode: Users only read the \ref agora::media::IAudioFrameObserver::AudioFrame "AudioFrame" data without modifying anything. For example, when users acquire the data with the Agora SDK, then push the RTMP or RTMPS streams. */ + RAW_AUDIO_FRAME_OP_MODE_READ_ONLY = 0, + /** 1: Write-only mode: Users replace the \ref agora::media::IAudioFrameObserver::AudioFrame "AudioFrame" data with their own data and pass the data to the SDK for encoding. For example, when users acquire the data. */ + RAW_AUDIO_FRAME_OP_MODE_WRITE_ONLY = 1, + /** 2: Read and write mode: Users read the data from \ref agora::media::IAudioFrameObserver::AudioFrame "AudioFrame", modify it, and then play it. For example, when users have their own sound-effect processing module and perform some voice pre-processing, such as a voice change. */ + RAW_AUDIO_FRAME_OP_MODE_READ_WRITE = 2, }; /** Audio-sample rates. */ -enum AUDIO_SAMPLE_RATE_TYPE -{ - /** 32000: 32 kHz */ - AUDIO_SAMPLE_RATE_32000 = 32000, - /** 44100: 44.1 kHz */ - AUDIO_SAMPLE_RATE_44100 = 44100, - /** 48000: 48 kHz */ - AUDIO_SAMPLE_RATE_48000 = 48000, +enum AUDIO_SAMPLE_RATE_TYPE { + /** 32000: 32 kHz */ + AUDIO_SAMPLE_RATE_32000 = 32000, + /** 44100: 44.1 kHz */ + AUDIO_SAMPLE_RATE_44100 = 44100, + /** 48000: 48 kHz */ + AUDIO_SAMPLE_RATE_48000 = 48000, }; /** Video codec profile types. */ -enum VIDEO_CODEC_PROFILE_TYPE -{ /** 66: Baseline video codec profile. Generally used in video calls on mobile phones. */ - VIDEO_CODEC_PROFILE_BASELINE = 66, - /** 77: Main video codec profile. Generally used in mainstream electronics such as MP4 players, portable video players, PSP, and iPads. */ - VIDEO_CODEC_PROFILE_MAIN = 77, - /** 100: (Default) High video codec profile. Generally used in high-resolution live streaming or television. */ - VIDEO_CODEC_PROFILE_HIGH = 100, +enum VIDEO_CODEC_PROFILE_TYPE { /** 66: Baseline video codec profile. Generally used in video calls on mobile phones. */ + VIDEO_CODEC_PROFILE_BASELINE = 66, + /** 77: Main video codec profile. Generally used in mainstream electronics such as MP4 players, portable video players, PSP, and iPads. */ + VIDEO_CODEC_PROFILE_MAIN = 77, + /** 100: (Default) High video codec profile. Generally used in high-resolution live streaming or television. */ + VIDEO_CODEC_PROFILE_HIGH = 100, }; /** Video codec types */ enum VIDEO_CODEC_TYPE { - /** Standard VP8 */ - VIDEO_CODEC_VP8 = 1, - /** Standard H264 */ - VIDEO_CODEC_H264 = 2, - /** Enhanced VP8 */ - VIDEO_CODEC_EVP = 3, - /** Enhanced H264 */ - VIDEO_CODEC_E264 = 4, + /** Standard VP8 */ + VIDEO_CODEC_VP8 = 1, + /** Standard H264 */ + VIDEO_CODEC_H264 = 2, + /** Enhanced VP8 */ + VIDEO_CODEC_EVP = 3, + /** Enhanced H264 */ + VIDEO_CODEC_E264 = 4, }; /** Video Codec types for publishing streams. */ -enum VIDEO_CODEC_TYPE_FOR_STREAM -{ - VIDEO_CODEC_H264_FOR_STREAM = 1, - VIDEO_CODEC_H265_FOR_STREAM = 2, +enum VIDEO_CODEC_TYPE_FOR_STREAM { + VIDEO_CODEC_H264_FOR_STREAM = 1, + VIDEO_CODEC_H265_FOR_STREAM = 2, }; /** Audio equalization band frequencies. */ -enum AUDIO_EQUALIZATION_BAND_FREQUENCY -{ - /** 0: 31 Hz */ - AUDIO_EQUALIZATION_BAND_31 = 0, - /** 1: 62 Hz */ - AUDIO_EQUALIZATION_BAND_62 = 1, - /** 2: 125 Hz */ - AUDIO_EQUALIZATION_BAND_125 = 2, - /** 3: 250 Hz */ - AUDIO_EQUALIZATION_BAND_250 = 3, - /** 4: 500 Hz */ - AUDIO_EQUALIZATION_BAND_500 = 4, - /** 5: 1 kHz */ - AUDIO_EQUALIZATION_BAND_1K = 5, - /** 6: 2 kHz */ - AUDIO_EQUALIZATION_BAND_2K = 6, - /** 7: 4 kHz */ - AUDIO_EQUALIZATION_BAND_4K = 7, - /** 8: 8 kHz */ - AUDIO_EQUALIZATION_BAND_8K = 8, - /** 9: 16 kHz */ - AUDIO_EQUALIZATION_BAND_16K = 9, +enum AUDIO_EQUALIZATION_BAND_FREQUENCY { + /** 0: 31 Hz */ + AUDIO_EQUALIZATION_BAND_31 = 0, + /** 1: 62 Hz */ + AUDIO_EQUALIZATION_BAND_62 = 1, + /** 2: 125 Hz */ + AUDIO_EQUALIZATION_BAND_125 = 2, + /** 3: 250 Hz */ + AUDIO_EQUALIZATION_BAND_250 = 3, + /** 4: 500 Hz */ + AUDIO_EQUALIZATION_BAND_500 = 4, + /** 5: 1 kHz */ + AUDIO_EQUALIZATION_BAND_1K = 5, + /** 6: 2 kHz */ + AUDIO_EQUALIZATION_BAND_2K = 6, + /** 7: 4 kHz */ + AUDIO_EQUALIZATION_BAND_4K = 7, + /** 8: 8 kHz */ + AUDIO_EQUALIZATION_BAND_8K = 8, + /** 9: 16 kHz */ + AUDIO_EQUALIZATION_BAND_16K = 9, }; /** Audio reverberation types. */ -enum AUDIO_REVERB_TYPE -{ - /** 0: The level of the dry signal (db). The value is between -20 and 10. */ - AUDIO_REVERB_DRY_LEVEL = 0, // (dB, [-20,10]), the level of the dry signal - /** 1: The level of the early reflection signal (wet signal) (dB). The value is between -20 and 10. */ - AUDIO_REVERB_WET_LEVEL = 1, // (dB, [-20,10]), the level of the early reflection signal (wet signal) - /** 2: The room size of the reflection. The value is between 0 and 100. */ - AUDIO_REVERB_ROOM_SIZE = 2, // ([0,100]), the room size of the reflection - /** 3: The length of the initial delay of the wet signal (ms). The value is between 0 and 200. */ - AUDIO_REVERB_WET_DELAY = 3, // (ms, [0,200]), the length of the initial delay of the wet signal in ms - /** 4: The reverberation strength. The value is between 0 and 100. */ - AUDIO_REVERB_STRENGTH = 4, // ([0,100]), the strength of the reverberation +enum AUDIO_REVERB_TYPE { + /** 0: The level of the dry signal (db). The value is between -20 and 10. */ + AUDIO_REVERB_DRY_LEVEL = 0, // (dB, [-20,10]), the level of the dry signal + /** 1: The level of the early reflection signal (wet signal) (dB). The value is between -20 and 10. */ + AUDIO_REVERB_WET_LEVEL = 1, // (dB, [-20,10]), the level of the early reflection signal (wet signal) + /** 2: The room size of the reflection. The value is between 0 and 100. */ + AUDIO_REVERB_ROOM_SIZE = 2, // ([0,100]), the room size of the reflection + /** 3: The length of the initial delay of the wet signal (ms). The value is between 0 and 200. */ + AUDIO_REVERB_WET_DELAY = 3, // (ms, [0,200]), the length of the initial delay of the wet signal in ms + /** 4: The reverberation strength. The value is between 0 and 100. */ + AUDIO_REVERB_STRENGTH = 4, // ([0,100]), the strength of the reverberation }; /** * @deprecated Deprecated from v3.2.0. * * Local voice changer options. + * + * Gender-based beatification effect works best only when assigned a proper gender: + * + * - For male: #GENERAL_BEAUTY_VOICE_MALE_MAGNETIC + * - For female: #GENERAL_BEAUTY_VOICE_FEMALE_FRESH or #GENERAL_BEAUTY_VOICE_FEMALE_VITALITY + * + * Failure to do so can lead to voice distortion. */ enum VOICE_CHANGER_PRESET { - /** - * The original voice (no local voice change). - */ - VOICE_CHANGER_OFF = 0x00000000, //Turn off the voice changer - /** - * The voice of an old man. - */ - VOICE_CHANGER_OLDMAN = 0x00000001, - /** - * The voice of a little boy. - */ - VOICE_CHANGER_BABYBOY = 0x00000002, - /** - * The voice of a little girl. - */ - VOICE_CHANGER_BABYGIRL = 0x00000003, - /** - * The voice of Zhu Bajie, a character in Journey to the West who has a voice like that of a growling bear. - */ - VOICE_CHANGER_ZHUBAJIE = 0x00000004, - /** - * The ethereal voice. - */ - VOICE_CHANGER_ETHEREAL = 0x00000005, - /** - * The voice of Hulk. - */ - VOICE_CHANGER_HULK = 0x00000006, - /** - * A more vigorous voice. - */ - VOICE_BEAUTY_VIGOROUS = 0x00100001,//7, - /** - * A deeper voice. - */ - VOICE_BEAUTY_DEEP = 0x00100002, - /** - * A mellower voice. - */ - VOICE_BEAUTY_MELLOW = 0x00100003, - /** - * Falsetto. - */ - VOICE_BEAUTY_FALSETTO = 0x00100004, - /** - * A fuller voice. - */ - VOICE_BEAUTY_FULL = 0x00100005, - /** - * A clearer voice. - */ - VOICE_BEAUTY_CLEAR = 0x00100006, - /** - * A more resounding voice. - */ - VOICE_BEAUTY_RESOUNDING = 0x00100007, - /** - * A more ringing voice. - */ - VOICE_BEAUTY_RINGING = 0x00100008, - /** - * A more spatially resonant voice. - */ - VOICE_BEAUTY_SPACIAL = 0x00100009, - /** - * (For male only) A more magnetic voice. Do not use it when the speaker is a female; otherwise, voice distortion occurs. - */ - GENERAL_BEAUTY_VOICE_MALE_MAGNETIC = 0x00200001, - /** - * (For female only) A fresher voice. Do not use it when the speaker is a male; otherwise, voice distortion occurs. - */ - GENERAL_BEAUTY_VOICE_FEMALE_FRESH = 0x00200002, - /** - * (For female only) A more vital voice. Do not use it when the speaker is a male; otherwise, voice distortion occurs. - */ - GENERAL_BEAUTY_VOICE_FEMALE_VITALITY = 0x00200003 + /** + * The original voice (no local voice change). + */ + VOICE_CHANGER_OFF = 0x00000000, // Turn off the voice changer + /** + * The voice of an old man. + */ + VOICE_CHANGER_OLDMAN = 0x00000001, + /** + * The voice of a little boy. + */ + VOICE_CHANGER_BABYBOY = 0x00000002, + /** + * The voice of a little girl. + */ + VOICE_CHANGER_BABYGIRL = 0x00000003, + /** + * The voice of Zhu Bajie, a character in Journey to the West who has a voice like that of a growling bear. + */ + VOICE_CHANGER_ZHUBAJIE = 0x00000004, + /** + * The ethereal voice. + */ + VOICE_CHANGER_ETHEREAL = 0x00000005, + /** + * The voice of Hulk. + */ + VOICE_CHANGER_HULK = 0x00000006, + /** + * A more vigorous voice. + */ + VOICE_BEAUTY_VIGOROUS = 0x00100001, // 7, + /** + * A deeper voice. + */ + VOICE_BEAUTY_DEEP = 0x00100002, + /** + * A mellower voice. + */ + VOICE_BEAUTY_MELLOW = 0x00100003, + /** + * Falsetto. + */ + VOICE_BEAUTY_FALSETTO = 0x00100004, + /** + * A fuller voice. + */ + VOICE_BEAUTY_FULL = 0x00100005, + /** + * A clearer voice. + */ + VOICE_BEAUTY_CLEAR = 0x00100006, + /** + * A more resounding voice. + */ + VOICE_BEAUTY_RESOUNDING = 0x00100007, + /** + * A more ringing voice. + */ + VOICE_BEAUTY_RINGING = 0x00100008, + /** + * A more spatially resonant voice. + */ + VOICE_BEAUTY_SPACIAL = 0x00100009, + /** + * (For male only) A more magnetic voice. Do not use it when the speaker is a female; otherwise, voice distortion occurs. + */ + GENERAL_BEAUTY_VOICE_MALE_MAGNETIC = 0x00200001, + /** + * (For female only) A fresher voice. Do not use it when the speaker is a male; otherwise, voice distortion occurs. + */ + GENERAL_BEAUTY_VOICE_FEMALE_FRESH = 0x00200002, + /** + * (For female only) A more vital voice. Do not use it when the speaker is a male; otherwise, voice distortion occurs. + */ + GENERAL_BEAUTY_VOICE_FEMALE_VITALITY = 0x00200003 }; @@ -966,347 +1097,420 @@ enum VOICE_CHANGER_PRESET { * Local voice reverberation presets. */ enum AUDIO_REVERB_PRESET { - /** - * Turn off local voice reverberation, that is, to use the original voice. - */ - AUDIO_REVERB_OFF = 0x00000000, // Turn off audio reverb - /** - * The reverberation style typical of a KTV venue (enhanced). - */ - AUDIO_REVERB_FX_KTV = 0x00100001, - /** - * The reverberation style typical of a concert hall (enhanced). - */ - AUDIO_REVERB_FX_VOCAL_CONCERT = 0x00100002, - /** - * The reverberation style typical of an uncle's voice. - */ - AUDIO_REVERB_FX_UNCLE = 0x00100003, - /** - * The reverberation style typical of a little sister's voice. - */ - AUDIO_REVERB_FX_SISTER = 0x00100004, - /** - * The reverberation style typical of a recording studio (enhanced). - */ - AUDIO_REVERB_FX_STUDIO = 0x00100005, - /** - * The reverberation style typical of popular music (enhanced). - */ - AUDIO_REVERB_FX_POPULAR = 0x00100006, - /** - * The reverberation style typical of R&B music (enhanced). - */ - AUDIO_REVERB_FX_RNB = 0x00100007, - /** - * The reverberation style typical of the vintage phonograph. - */ - AUDIO_REVERB_FX_PHONOGRAPH = 0x00100008, - /** - * The reverberation style typical of popular music. - */ - AUDIO_REVERB_POPULAR = 0x00000001, - /** - * The reverberation style typical of R&B music. - */ - AUDIO_REVERB_RNB = 0x00000002, - /** - * The reverberation style typical of rock music. - */ - AUDIO_REVERB_ROCK = 0x00000003, - /** - * The reverberation style typical of hip-hop music. - */ - AUDIO_REVERB_HIPHOP = 0x00000004, - /** - * The reverberation style typical of a concert hall. - */ - AUDIO_REVERB_VOCAL_CONCERT = 0x00000005, - /** - * The reverberation style typical of a KTV venue. - */ - AUDIO_REVERB_KTV = 0x00000006, - /** - * The reverberation style typical of a recording studio. - */ - AUDIO_REVERB_STUDIO = 0x00000007, - /** - * The reverberation of the virtual stereo. The virtual stereo is an effect that renders the monophonic - * audio as the stereo audio, so that all users in the channel can hear the stereo voice effect. - * To achieve better virtual stereo reverberation, Agora recommends setting `profile` in `setAudioProfile` - * as `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`. - */ - AUDIO_VIRTUAL_STEREO = 0x00200001, - /** 1: Electronic Voice.*/ - AUDIO_ELECTRONIC_VOICE = 0x00300001, - /** 1: 3D Voice.*/ - AUDIO_THREEDIM_VOICE = 0x00400001 + /** + * @deprecated Deprecated from v3.2.0. + * + * Turn off local voice reverberation, that is, to use the original voice. + */ + AUDIO_REVERB_OFF = 0x00000000, // Turn off audio reverb + /** + * @deprecated Deprecated from v3.2.0. + * + * The reverberation style typical of a KTV venue (enhanced). + */ + AUDIO_REVERB_FX_KTV = 0x00100001, + /** + * @deprecated Deprecated from v3.2.0. + * + * The reverberation style typical of a concert hall (enhanced). + */ + AUDIO_REVERB_FX_VOCAL_CONCERT = 0x00100002, + /** + * @deprecated Deprecated from v3.2.0. + * + * The reverberation style typical of an uncle's voice. + */ + AUDIO_REVERB_FX_UNCLE = 0x00100003, + /** + * @deprecated Deprecated from v3.2.0. + * + * The reverberation style typical of a little sister's voice. + */ + AUDIO_REVERB_FX_SISTER = 0x00100004, + /** + * @deprecated Deprecated from v3.2.0. + * + * The reverberation style typical of a recording studio (enhanced). + */ + AUDIO_REVERB_FX_STUDIO = 0x00100005, + /** + * @deprecated Deprecated from v3.2.0. + * + * The reverberation style typical of popular music (enhanced). + */ + AUDIO_REVERB_FX_POPULAR = 0x00100006, + /** + * @deprecated Deprecated from v3.2.0. + * + * The reverberation style typical of R&B music (enhanced). + */ + AUDIO_REVERB_FX_RNB = 0x00100007, + /** + * @deprecated Deprecated from v3.2.0. + * + * The reverberation style typical of the vintage phonograph. + */ + AUDIO_REVERB_FX_PHONOGRAPH = 0x00100008, + /** + * @deprecated Deprecated from v3.2.0. + * + * The reverberation style typical of popular music. + */ + AUDIO_REVERB_POPULAR = 0x00000001, + /** + * @deprecated Deprecated from v3.2.0. + * + * The reverberation style typical of R&B music. + */ + AUDIO_REVERB_RNB = 0x00000002, + /** + * @deprecated Deprecated from v3.2.0. + * + * The reverberation style typical of rock music. + */ + AUDIO_REVERB_ROCK = 0x00000003, + /** + * @deprecated Deprecated from v3.2.0. + * + * The reverberation style typical of hip-hop music. + */ + AUDIO_REVERB_HIPHOP = 0x00000004, + /** + * @deprecated Deprecated from v3.2.0. + * + * The reverberation style typical of a concert hall. + */ + AUDIO_REVERB_VOCAL_CONCERT = 0x00000005, + /** + * @deprecated Deprecated from v3.2.0. + * + * The reverberation style typical of a KTV venue. + */ + AUDIO_REVERB_KTV = 0x00000006, + /** + * @deprecated Deprecated from v3.2.0. + * + * The reverberation style typical of a recording studio. + */ + AUDIO_REVERB_STUDIO = 0x00000007, + /** + * @deprecated Deprecated from v3.2.0. + * + * The reverberation of the virtual stereo. The virtual stereo is an effect that renders the monophonic + * audio as the stereo audio, so that all users in the channel can hear the stereo voice effect. + * To achieve better virtual stereo reverberation, Agora recommends setting `profile` in `setAudioProfile` + * as `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`. + */ + AUDIO_VIRTUAL_STEREO = 0x00200001, + /** + * @deprecated Deprecated from v3.2.0. + * + * A pitch correction effect that corrects the user's pitch based on the pitch of the natural C major scale. + */ + AUDIO_ELECTRONIC_VOICE = 0x00300001, + /** + * @deprecated Deprecated from v3.2.0. + * + * A 3D voice effect that makes the voice appear to be moving around the user. + */ + AUDIO_THREEDIM_VOICE = 0x00400001 }; /** The options for SDK preset voice beautifier effects. */ -enum VOICE_BEAUTIFIER_PRESET -{ - /** Turn off voice beautifier effects and use the original voice. - */ - VOICE_BEAUTIFIER_OFF = 0x00000000, - /** A more magnetic voice. - * - * @note Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may experience vocal distortion. - */ - CHAT_BEAUTIFIER_MAGNETIC = 0x01010100, - /** A fresher voice. - * - * @note Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion. - */ - CHAT_BEAUTIFIER_FRESH = 0x01010200, - /** A more vital voice. - * - * @note Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion. - */ - CHAT_BEAUTIFIER_VITALITY = 0x01010300, - /** A more vigorous voice. - */ - TIMBRE_TRANSFORMATION_VIGOROUS = 0x01030100, - /** A deeper voice. - */ - TIMBRE_TRANSFORMATION_DEEP = 0x01030200, - /** A mellower voice. - */ - TIMBRE_TRANSFORMATION_MELLOW = 0x01030300, - /** A falsetto voice. - */ - TIMBRE_TRANSFORMATION_FALSETTO = 0x01030400, - /** A falsetto voice. - */ - TIMBRE_TRANSFORMATION_FULL = 0x01030500, - /** A clearer voice. - */ - TIMBRE_TRANSFORMATION_CLEAR = 0x01030600, - /** A more resounding voice. - */ - TIMBRE_TRANSFORMATION_RESOUNDING = 0x01030700, - /** A more ringing voice. - */ - TIMBRE_TRANSFORMATION_RINGING = 0x01030800 +enum VOICE_BEAUTIFIER_PRESET { + /** Turn off voice beautifier effects and use the original voice. + */ + VOICE_BEAUTIFIER_OFF = 0x00000000, + /** A more magnetic voice. + * + * @note Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may experience vocal distortion. + */ + CHAT_BEAUTIFIER_MAGNETIC = 0x01010100, + /** A fresher voice. + * + * @note Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion. + */ + CHAT_BEAUTIFIER_FRESH = 0x01010200, + /** A more vital voice. + * + * @note Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion. + */ + CHAT_BEAUTIFIER_VITALITY = 0x01010300, + /** + * @since v3.3.0 + * + * Singing beautifier effect. + * - If you call \ref IRtcEngine::setVoiceBeautifierPreset "setVoiceBeautifierPreset" (SINGING_BEAUTIFIER), you can beautify a male-sounding voice and add a reverberation + * effect that sounds like singing in a small room. Agora recommends not using \ref IRtcEngine::setVoiceBeautifierPreset "setVoiceBeautifierPreset" (SINGING_BEAUTIFIER) + * to process a female-sounding voice; otherwise, you may experience vocal distortion. + * - If you call \ref IRtcEngine::setVoiceBeautifierParameters "setVoiceBeautifierParameters"(SINGING_BEAUTIFIER, param1, param2), you can beautify a male- or + * female-sounding voice and add a reverberation effect. + */ + SINGING_BEAUTIFIER = 0x01020100, + /** A more vigorous voice. + */ + TIMBRE_TRANSFORMATION_VIGOROUS = 0x01030100, + /** A deeper voice. + */ + TIMBRE_TRANSFORMATION_DEEP = 0x01030200, + /** A mellower voice. + */ + TIMBRE_TRANSFORMATION_MELLOW = 0x01030300, + /** A falsetto voice. + */ + TIMBRE_TRANSFORMATION_FALSETTO = 0x01030400, + /** A fuller voice. + */ + TIMBRE_TRANSFORMATION_FULL = 0x01030500, + /** A clearer voice. + */ + TIMBRE_TRANSFORMATION_CLEAR = 0x01030600, + /** A more resounding voice. + */ + TIMBRE_TRANSFORMATION_RESOUNDING = 0x01030700, + /** A more ringing voice. + */ + TIMBRE_TRANSFORMATION_RINGING = 0x01030800 }; /** The options for SDK preset audio effects. */ -enum AUDIO_EFFECT_PRESET -{ - /** Turn off audio effects and use the original voice. - */ - AUDIO_EFFECT_OFF = 0x00000000, - /** An audio effect typical of a KTV venue. - * - * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" - * and setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` - * before setting this enumerator. - */ - ROOM_ACOUSTICS_KTV = 0x02010100, - /** An audio effect typical of a concert hall. - * - * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" - * and setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` - * before setting this enumerator. - */ - ROOM_ACOUSTICS_VOCAL_CONCERT = 0x02010200, - /** An audio effect typical of a recording studio. - * - * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" - * and setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` - * before setting this enumerator. - */ - ROOM_ACOUSTICS_STUDIO = 0x02010300, - /** An audio effect typical of a vintage phonograph. - * - * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" - * and setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` - * before setting this enumerator. - */ - ROOM_ACOUSTICS_PHONOGRAPH = 0x02010400, - /** A virtual stereo effect that renders monophonic audio as stereo audio. - * - * @note Call \ref IRtcEngine::setAudioProfile "setAudioProfile" and set the `profile` parameter to - * `AUDIO_PROFILE_MUSIC_STANDARD_STEREO(3)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before setting this - * enumerator; otherwise, the enumerator setting does not take effect. - */ - ROOM_ACOUSTICS_VIRTUAL_STEREO = 0x02010500, - /** A more spatial audio effect. - * - * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" - * and setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` - * before setting this enumerator. - */ - ROOM_ACOUSTICS_SPACIAL = 0x02010600, - /** A more ethereal audio effect. - * - * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" - * and setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` - * before setting this enumerator. - */ - ROOM_ACOUSTICS_ETHEREAL = 0x02010700, - /** A 3D voice effect that makes the voice appear to be moving around the user. The default cycle period of the 3D - * voice effect is 10 seconds. To change the cycle period, call \ref IRtcEngine::setAudioEffectParameters "setAudioEffectParameters" - * after this method. - * - * @note - * - Call \ref IRtcEngine::setAudioProfile "setAudioProfile" and set the `profile` parameter to `AUDIO_PROFILE_MUSIC_STANDARD_STEREO(3)` - * or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before setting this enumerator; otherwise, the enumerator setting does not take effect. - * - If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect. - */ - ROOM_ACOUSTICS_3D_VOICE = 0x02010800, - /** The voice of an uncle. - * - * @note - * - Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect. - * - To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and - * setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before - * setting this enumerator. - */ - VOICE_CHANGER_EFFECT_UNCLE = 0x02020100, - /** The voice of an old man. - * - * @note - * - Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect. - * - To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and setting - * the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before setting - * this enumerator. - */ - VOICE_CHANGER_EFFECT_OLDMAN = 0x02020200, - /** The voice of a boy. - * - * @note - * - Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect. - * - To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and setting - * the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before - * setting this enumerator. - */ - VOICE_CHANGER_EFFECT_BOY = 0x02020300, - /** The voice of a young woman. - * - * @note - * - Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect. - * - To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and setting - * the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before - * setting this enumerator. - */ - VOICE_CHANGER_EFFECT_SISTER = 0x02020400, - /** The voice of a girl. - * - * @note - * - Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect. - * - To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and setting - * the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before - * setting this enumerator. - */ - VOICE_CHANGER_EFFECT_GIRL = 0x02020500, - /** The voice of Pig King, a character in Journey to the West who has a voice like a growling bear. - * - * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and - * setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before - * setting this enumerator. - */ - VOICE_CHANGER_EFFECT_PIGKING = 0x02020600, - /** The voice of Hulk. - * - * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and - * setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before - * setting this enumerator. - */ - VOICE_CHANGER_EFFECT_HULK = 0x02020700, - /** An audio effect typical of R&B music. - * - * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and - * setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before - * setting this enumerator. - */ - STYLE_TRANSFORMATION_RNB = 0x02030100, - /** An audio effect typical of popular music. - * - * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and - * setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before - * setting this enumerator. - */ - STYLE_TRANSFORMATION_POPULAR = 0x02030200, - /** A pitch correction effect that corrects the user's pitch based on the pitch of the natural C major scale. - * To change the basic mode and tonic pitch, call \ref IRtcEngine::setAudioEffectParameters "setAudioEffectParameters" after this method. - * - * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and - * setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before - * setting this enumerator. - */ - PITCH_CORRECTION = 0x02040100 +enum AUDIO_EFFECT_PRESET { + /** Turn off audio effects and use the original voice. + */ + AUDIO_EFFECT_OFF = 0x00000000, + /** An audio effect typical of a KTV venue. + * + * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" + * and setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` + * before setting this enumerator. + */ + ROOM_ACOUSTICS_KTV = 0x02010100, + /** An audio effect typical of a concert hall. + * + * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" + * and setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` + * before setting this enumerator. + */ + ROOM_ACOUSTICS_VOCAL_CONCERT = 0x02010200, + /** An audio effect typical of a recording studio. + * + * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" + * and setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` + * before setting this enumerator. + */ + ROOM_ACOUSTICS_STUDIO = 0x02010300, + /** An audio effect typical of a vintage phonograph. + * + * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" + * and setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` + * before setting this enumerator. + */ + ROOM_ACOUSTICS_PHONOGRAPH = 0x02010400, + /** A virtual stereo effect that renders monophonic audio as stereo audio. + * + * @note Call \ref IRtcEngine::setAudioProfile "setAudioProfile" and set the `profile` parameter to + * `AUDIO_PROFILE_MUSIC_STANDARD_STEREO(3)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before setting this + * enumerator; otherwise, the enumerator setting does not take effect. + */ + ROOM_ACOUSTICS_VIRTUAL_STEREO = 0x02010500, + /** A more spatial audio effect. + * + * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" + * and setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` + * before setting this enumerator. + */ + ROOM_ACOUSTICS_SPACIAL = 0x02010600, + /** A more ethereal audio effect. + * + * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" + * and setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` + * before setting this enumerator. + */ + ROOM_ACOUSTICS_ETHEREAL = 0x02010700, + /** A 3D voice effect that makes the voice appear to be moving around the user. The default cycle period of the 3D + * voice effect is 10 seconds. To change the cycle period, call \ref IRtcEngine::setAudioEffectParameters "setAudioEffectParameters" + * after this method. + * + * @note + * - Call \ref IRtcEngine::setAudioProfile "setAudioProfile" and set the `profile` parameter to `AUDIO_PROFILE_MUSIC_STANDARD_STEREO(3)` + * or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before setting this enumerator; otherwise, the enumerator setting does not take effect. + * - If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect. + */ + ROOM_ACOUSTICS_3D_VOICE = 0x02010800, + /** The voice of a middle-aged man. + * + * @note + * - Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect. + * - To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and + * setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before + * setting this enumerator. + */ + VOICE_CHANGER_EFFECT_UNCLE = 0x02020100, + /** The voice of an old man. + * + * @note + * - Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect. + * - To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and setting + * the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before setting + * this enumerator. + */ + VOICE_CHANGER_EFFECT_OLDMAN = 0x02020200, + /** The voice of a boy. + * + * @note + * - Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect. + * - To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and setting + * the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before + * setting this enumerator. + */ + VOICE_CHANGER_EFFECT_BOY = 0x02020300, + /** The voice of a young woman. + * + * @note + * - Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect. + * - To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and setting + * the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before + * setting this enumerator. + */ + VOICE_CHANGER_EFFECT_SISTER = 0x02020400, + /** The voice of a girl. + * + * @note + * - Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect. + * - To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and setting + * the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before + * setting this enumerator. + */ + VOICE_CHANGER_EFFECT_GIRL = 0x02020500, + /** The voice of Pig King, a character in Journey to the West who has a voice like a growling bear. + * + * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and + * setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before + * setting this enumerator. + */ + VOICE_CHANGER_EFFECT_PIGKING = 0x02020600, + /** The voice of Hulk. + * + * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and + * setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before + * setting this enumerator. + */ + VOICE_CHANGER_EFFECT_HULK = 0x02020700, + /** An audio effect typical of R&B music. + * + * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and + * setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before + * setting this enumerator. + */ + STYLE_TRANSFORMATION_RNB = 0x02030100, + /** An audio effect typical of popular music. + * + * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and + * setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before + * setting this enumerator. + */ + STYLE_TRANSFORMATION_POPULAR = 0x02030200, + /** A pitch correction effect that corrects the user's pitch based on the pitch of the natural C major scale. + * To change the basic mode and tonic pitch, call \ref IRtcEngine::setAudioEffectParameters "setAudioEffectParameters" after this method. + * + * @note To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and + * setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before + * setting this enumerator. + */ + PITCH_CORRECTION = 0x02040100 +}; +/** The options for SDK preset voice conversion effects. + * + * @since v3.3.1 + */ +enum VOICE_CONVERSION_PRESET { + /** Turn off voice conversion effects and use the original voice. + */ + VOICE_CONVERSION_OFF = 0x00000000, + /** A gender-neutral voice. To avoid audio distortion, ensure that you use + * this enumerator to process a female-sounding voice. + */ + VOICE_CHANGER_NEUTRAL = 0x03010100, + /** A sweet voice. To avoid audio distortion, ensure that you use this + * enumerator to process a female-sounding voice. + */ + VOICE_CHANGER_SWEET = 0x03010200, + /** A steady voice. To avoid audio distortion, ensure that you use this + * enumerator to process a male-sounding voice. + */ + VOICE_CHANGER_SOLID = 0x03010300, + /** A deep voice. To avoid audio distortion, ensure that you use this + * enumerator to process a male-sounding voice. + */ + VOICE_CHANGER_BASS = 0x03010400 }; /** Audio codec profile types. The default value is LC_ACC. */ -enum AUDIO_CODEC_PROFILE_TYPE -{ - /** 0: LC-AAC, which is the low-complexity audio codec type. */ - AUDIO_CODEC_PROFILE_LC_AAC = 0, - /** 1: HE-AAC, which is the high-efficiency audio codec type. */ - AUDIO_CODEC_PROFILE_HE_AAC = 1, +enum AUDIO_CODEC_PROFILE_TYPE { + /** 0: LC-AAC, which is the low-complexity audio codec type. */ + AUDIO_CODEC_PROFILE_LC_AAC = 0, + /** 1: HE-AAC, which is the high-efficiency audio codec type. */ + AUDIO_CODEC_PROFILE_HE_AAC = 1, }; /** Remote audio states. */ -enum REMOTE_AUDIO_STATE -{ - /** 0: The remote audio is in the default state, probably due to - * #REMOTE_AUDIO_REASON_LOCAL_MUTED (3), - * #REMOTE_AUDIO_REASON_REMOTE_MUTED (5), or - * #REMOTE_AUDIO_REASON_REMOTE_OFFLINE (7). - */ - REMOTE_AUDIO_STATE_STOPPED = 0, // Default state, audio is started or remote user disabled/muted audio stream - /** 1: The first remote audio packet is received. - */ - REMOTE_AUDIO_STATE_STARTING = 1, // The first audio frame packet has been received - /** 2: The remote audio stream is decoded and plays normally, probably - * due to #REMOTE_AUDIO_REASON_NETWORK_RECOVERY (2), - * #REMOTE_AUDIO_REASON_LOCAL_UNMUTED (4), or - * #REMOTE_AUDIO_REASON_REMOTE_UNMUTED (6). - */ - REMOTE_AUDIO_STATE_DECODING = 2, // The first remote audio frame has been decoded or fronzen state ends - /** 3: The remote audio is frozen, probably due to - * #REMOTE_AUDIO_REASON_NETWORK_CONGESTION (1). - */ - REMOTE_AUDIO_STATE_FROZEN = 3, // Remote audio is frozen, probably due to network issue - /** 4: The remote audio fails to start, probably due to - * #REMOTE_AUDIO_REASON_INTERNAL (0). - */ - REMOTE_AUDIO_STATE_FAILED = 4, // Remote audio play failed +enum REMOTE_AUDIO_STATE { + /** 0: The remote audio is in the default state, probably due to + * #REMOTE_AUDIO_REASON_LOCAL_MUTED (3), + * #REMOTE_AUDIO_REASON_REMOTE_MUTED (5), or + * #REMOTE_AUDIO_REASON_REMOTE_OFFLINE (7). + */ + REMOTE_AUDIO_STATE_STOPPED = 0, // Default state, audio is started or remote user disabled/muted audio stream + /** 1: The first remote audio packet is received. + */ + REMOTE_AUDIO_STATE_STARTING = 1, // The first audio frame packet has been received + /** 2: The remote audio stream is decoded and plays normally, probably + * due to #REMOTE_AUDIO_REASON_NETWORK_RECOVERY (2), + * #REMOTE_AUDIO_REASON_LOCAL_UNMUTED (4), or + * #REMOTE_AUDIO_REASON_REMOTE_UNMUTED (6). + */ + REMOTE_AUDIO_STATE_DECODING = 2, // The first remote audio frame has been decoded or fronzen state ends + /** 3: The remote audio is frozen, probably due to + * #REMOTE_AUDIO_REASON_NETWORK_CONGESTION (1). + */ + REMOTE_AUDIO_STATE_FROZEN = 3, // Remote audio is frozen, probably due to network issue + /** 4: The remote audio fails to start, probably due to + * #REMOTE_AUDIO_REASON_INTERNAL (0). + */ + REMOTE_AUDIO_STATE_FAILED = 4, // Remote audio play failed }; /** Remote audio state reasons. */ -enum REMOTE_AUDIO_STATE_REASON -{ - /** 0: The SDK reports this reason when the audio state changes. - */ - REMOTE_AUDIO_REASON_INTERNAL = 0, - /** 1: Network congestion. - */ - REMOTE_AUDIO_REASON_NETWORK_CONGESTION = 1, - /** 2: Network recovery. - */ - REMOTE_AUDIO_REASON_NETWORK_RECOVERY = 2, - /** 3: The local user stops receiving the remote audio stream or - * disables the audio module. - */ - REMOTE_AUDIO_REASON_LOCAL_MUTED = 3, - /** 4: The local user resumes receiving the remote audio stream or - * enables the audio module. - */ - REMOTE_AUDIO_REASON_LOCAL_UNMUTED = 4, - /** 5: The remote user stops sending the audio stream or disables the - * audio module. - */ - REMOTE_AUDIO_REASON_REMOTE_MUTED = 5, - /** 6: The remote user resumes sending the audio stream or enables the - * audio module. - */ - REMOTE_AUDIO_REASON_REMOTE_UNMUTED = 6, - /** 7: The remote user leaves the channel. - */ - REMOTE_AUDIO_REASON_REMOTE_OFFLINE = 7, +enum REMOTE_AUDIO_STATE_REASON { + /** 0: The SDK reports this reason when the audio state changes. + */ + REMOTE_AUDIO_REASON_INTERNAL = 0, + /** 1: Network congestion. + */ + REMOTE_AUDIO_REASON_NETWORK_CONGESTION = 1, + /** 2: Network recovery. + */ + REMOTE_AUDIO_REASON_NETWORK_RECOVERY = 2, + /** 3: The local user stops receiving the remote audio stream or + * disables the audio module. + */ + REMOTE_AUDIO_REASON_LOCAL_MUTED = 3, + /** 4: The local user resumes receiving the remote audio stream or + * enables the audio module. + */ + REMOTE_AUDIO_REASON_LOCAL_UNMUTED = 4, + /** 5: The remote user stops sending the audio stream or disables the + * audio module. + */ + REMOTE_AUDIO_REASON_REMOTE_MUTED = 5, + /** 6: The remote user resumes sending the audio stream or enables the + * audio module. + */ + REMOTE_AUDIO_REASON_REMOTE_UNMUTED = 6, + /** 7: The remote user leaves the channel. + */ + REMOTE_AUDIO_REASON_REMOTE_OFFLINE = 7, }; /** Remote video states. */ @@ -1322,161 +1526,160 @@ enum REMOTE_AUDIO_STATE_REASON /** The state of the remote video. */ enum REMOTE_VIDEO_STATE { - /** 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_STOPPED = 0, + /** 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_STOPPED = 0, - /** 1: The first remote video packet is received. - */ - REMOTE_VIDEO_STATE_STARTING = 1, + /** 1: The first remote video packet is received. + */ + REMOTE_VIDEO_STATE_STARTING = 1, - /** 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_DECODING = 2, + /** 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_DECODING = 2, - /** 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_FROZEN = 3, + /** 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_FROZEN = 3, - /** 4: The remote video fails to start, probably due to #REMOTE_VIDEO_STATE_REASON_INTERNAL (0). - */ - REMOTE_VIDEO_STATE_FAILED = 4 + /** 4: The remote video fails to start, probably due to #REMOTE_VIDEO_STATE_REASON_INTERNAL (0). + */ + REMOTE_VIDEO_STATE_FAILED = 4 }; /** The publishing state. */ enum STREAM_PUBLISH_STATE { - /** 0: The initial publishing state after joining the channel. - */ - PUB_STATE_IDLE = 0, - /** 1: Fails to publish the local stream. Possible reasons: - * - The local user calls \ref IRtcEngine::muteLocalAudioStream "muteLocalAudioStream(true)" or \ref IRtcEngine::muteLocalVideoStream "muteLocalVideoStream(true)" to stop sending local streams. - * - The local user calls \ref IRtcEngine::disableAudio "disableAudio" or \ref IRtcEngine::disableVideo "disableVideo" to disable the entire audio or video module. - * - The local user calls \ref IRtcEngine::enableLocalAudio "enableLocalAudio(false)" or \ref IRtcEngine::enableLocalVideo "enableLocalVideo(false)" to disable the local audio sampling or video capturing. - * - The role of the local user is `AUDIENCE`. - */ - PUB_STATE_NO_PUBLISHED = 1, - /** 2: Publishing. - */ - PUB_STATE_PUBLISHING = 2, - /** 3: Publishes successfully. - */ - PUB_STATE_PUBLISHED = 3 + /** 0: The initial publishing state after joining the channel. + */ + PUB_STATE_IDLE = 0, + /** 1: Fails to publish the local stream. Possible reasons: + * - The local user calls \ref IRtcEngine::muteLocalAudioStream "muteLocalAudioStream(true)" or \ref IRtcEngine::muteLocalVideoStream "muteLocalVideoStream(true)" to stop sending local streams. + * - The local user calls \ref IRtcEngine::disableAudio "disableAudio" or \ref IRtcEngine::disableVideo "disableVideo" to disable the entire audio or video module. + * - The local user calls \ref IRtcEngine::enableLocalAudio "enableLocalAudio(false)" or \ref IRtcEngine::enableLocalVideo "enableLocalVideo(false)" to disable the local audio sampling or video capturing. + * - The role of the local user is `AUDIENCE`. + */ + PUB_STATE_NO_PUBLISHED = 1, + /** 2: Publishing. + */ + PUB_STATE_PUBLISHING = 2, + /** 3: Publishes successfully. + */ + PUB_STATE_PUBLISHED = 3 }; /** The subscribing state. */ -enum STREAM_SUBSCRIBE_STATE { - /** 0: The initial subscribing state after joining the channel. - */ - SUB_STATE_IDLE = 0, - /** 1: Fails to subscribe to the remote stream. Possible reasons: - * - The remote user: - * - Calls \ref IRtcEngine::muteLocalAudioStream "muteLocalAudioStream(true)" or \ref IRtcEngine::muteLocalVideoStream "muteLocalVideoStream(true)" to stop sending local streams. - * - Calls \ref IRtcEngine::disableAudio "disableAudio" or \ref IRtcEngine::disableVideo "disableVideo" to disable the entire audio or video modules. - * - Calls \ref IRtcEngine::enableLocalAudio "enableLocalAudio(false)" or \ref IRtcEngine::enableLocalVideo "enableLocalVideo(false)" to disable the local audio sampling or video capturing. - * - The role of the remote user is `AUDIENCE`. - * - The local user calls the following methods to stop receiving remote streams: - * - Calls \ref IRtcEngine::muteRemoteAudioStream "muteRemoteAudioStream(true)", \ref IRtcEngine::muteAllRemoteAudioStreams "muteAllRemoteAudioStreams(true)", or \ref IRtcEngine::setDefaultMuteAllRemoteAudioStreams "setDefaultMuteAllRemoteAudioStreams(true)" to stop receiving remote audio streams. - * - Calls \ref IRtcEngine::muteRemoteVideoStream "muteRemoteVideoStream(true)", \ref IRtcEngine::muteAllRemoteVideoStreams "muteAllRemoteVideoStreams(true)", or \ref IRtcEngine::setDefaultMuteAllRemoteVideoStreams "setDefaultMuteAllRemoteVideoStreams(true)" to stop receiving remote video streams. - */ - SUB_STATE_NO_SUBSCRIBED = 1, - /** 2: Subscribing. - */ - SUB_STATE_SUBSCRIBING = 2, - /** 3: Subscribes to and receives the remote stream successfully. - */ - SUB_STATE_SUBSCRIBED = 3 +enum STREAM_SUBSCRIBE_STATE { + /** 0: The initial subscribing state after joining the channel. + */ + SUB_STATE_IDLE = 0, + /** 1: Fails to subscribe to the remote stream. Possible reasons: + * - The remote user: + * - Calls \ref IRtcEngine::muteLocalAudioStream "muteLocalAudioStream(true)" or \ref IRtcEngine::muteLocalVideoStream "muteLocalVideoStream(true)" to stop sending local streams. + * - Calls \ref IRtcEngine::disableAudio "disableAudio" or \ref IRtcEngine::disableVideo "disableVideo" to disable the entire audio or video modules. + * - Calls \ref IRtcEngine::enableLocalAudio "enableLocalAudio(false)" or \ref IRtcEngine::enableLocalVideo "enableLocalVideo(false)" to disable the local audio sampling or video capturing. + * - The role of the remote user is `AUDIENCE`. + * - The local user calls the following methods to stop receiving remote streams: + * - Calls \ref IRtcEngine::muteRemoteAudioStream "muteRemoteAudioStream(true)", \ref IRtcEngine::muteAllRemoteAudioStreams "muteAllRemoteAudioStreams(true)", or \ref IRtcEngine::setDefaultMuteAllRemoteAudioStreams "setDefaultMuteAllRemoteAudioStreams(true)" to stop receiving remote audio streams. + * - Calls \ref IRtcEngine::muteRemoteVideoStream "muteRemoteVideoStream(true)", \ref IRtcEngine::muteAllRemoteVideoStreams "muteAllRemoteVideoStreams(true)", or \ref IRtcEngine::setDefaultMuteAllRemoteVideoStreams "setDefaultMuteAllRemoteVideoStreams(true)" to stop receiving remote video streams. + */ + SUB_STATE_NO_SUBSCRIBED = 1, + /** 2: Subscribing. + */ + SUB_STATE_SUBSCRIBING = 2, + /** 3: Subscribes to and receives the remote stream successfully. + */ + SUB_STATE_SUBSCRIBED = 3 }; /** The remote video frozen type. */ enum XLA_REMOTE_VIDEO_FROZEN_TYPE { - /** 0: 500ms video frozen type. - */ - XLA_REMOTE_VIDEO_FROZEN_500MS = 0, - /** 1: 200ms video frozen type. - */ - XLA_REMOTE_VIDEO_FROZEN_200MS = 1, - /** 2: 600ms video frozen type. - */ - XLA_REMOTE_VIDEO_FROZEN_600MS = 2, - /** 3: max video frozen type. - */ - XLA_REMOTE_VIDEO_FROZEN_TYPE_MAX = 3, + /** 0: 500ms video frozen type. + */ + XLA_REMOTE_VIDEO_FROZEN_500MS = 0, + /** 1: 200ms video frozen type. + */ + XLA_REMOTE_VIDEO_FROZEN_200MS = 1, + /** 2: 600ms video frozen type. + */ + XLA_REMOTE_VIDEO_FROZEN_600MS = 2, + /** 3: max video frozen type. + */ + XLA_REMOTE_VIDEO_FROZEN_TYPE_MAX = 3, }; /** The remote audio frozen type. */ enum XLA_REMOTE_AUDIO_FROZEN_TYPE { - /** 0: 80ms audio frozen. - */ - XLA_REMOTE_AUDIO_FROZEN_80MS = 0, - /** 1: 200ms audio frozen. - */ - XLA_REMOTE_AUDIO_FROZEN_200MS = 1, - /** 2: max audio frozen type. - */ - XLA_REMOTE_AUDIO_FROZEN_TYPE_MAX = 2, + /** 0: 80ms audio frozen. + */ + XLA_REMOTE_AUDIO_FROZEN_80MS = 0, + /** 1: 200ms audio frozen. + */ + XLA_REMOTE_AUDIO_FROZEN_200MS = 1, + /** 2: max audio frozen type. + */ + XLA_REMOTE_AUDIO_FROZEN_TYPE_MAX = 2, }; /** The reason for the remote video state change. */ enum REMOTE_VIDEO_STATE_REASON { - /** 0: The SDK reports this reason when the video state changes. - */ - REMOTE_VIDEO_STATE_REASON_INTERNAL = 0, + /** 0: The SDK reports this reason when the video state changes. + */ + REMOTE_VIDEO_STATE_REASON_INTERNAL = 0, - /** 1: Network congestion. - */ - REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION = 1, + /** 1: Network congestion. + */ + REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION = 1, - /** 2: Network recovery. - */ - REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY = 2, + /** 2: Network recovery. + */ + REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY = 2, - /** 3: The local user stops receiving the remote video stream or disables the video module. - */ - REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED = 3, + /** 3: The local user stops receiving the remote video stream or disables the video module. + */ + REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED = 3, - /** 4: The local user resumes receiving the remote video stream or enables the video module. - */ - REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED = 4, + /** 4: The local user resumes receiving the remote video stream or enables the video module. + */ + REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED = 4, - /** 5: The remote user stops sending the video stream or disables the video module. - */ - REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED = 5, + /** 5: The remote user stops sending the video stream or disables the video module. + */ + REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED = 5, - /** 6: The remote user resumes sending the video stream or enables the video module. - */ - REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED = 6, + /** 6: The remote user resumes sending the video stream or enables the video module. + */ + REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED = 6, - /** 7: The remote user leaves the channel. - */ - REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE = 7, + /** 7: The remote user leaves the channel. + */ + REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE = 7, - /** 8: The remote audio-and-video stream falls back to the audio-only stream due to poor network conditions. - */ - REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK = 8, + /** 8: The remote audio-and-video stream falls back to the audio-only stream due to poor network conditions. + */ + REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK = 8, - /** 9: The remote audio-only stream switches back to the audio-and-video stream after the network conditions improve. - */ - REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY = 9 + /** 9: The remote audio-only stream switches back to the audio-and-video stream after the network conditions improve. + */ + REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY = 9 }; /** Video frame rates. */ -enum FRAME_RATE -{ - /** 1: 1 fps */ - FRAME_RATE_FPS_1 = 1, - /** 7: 7 fps */ - FRAME_RATE_FPS_7 = 7, - /** 10: 10 fps */ - FRAME_RATE_FPS_10 = 10, - /** 15: 15 fps */ - FRAME_RATE_FPS_15 = 15, - /** 24: 24 fps */ - FRAME_RATE_FPS_24 = 24, - /** 30: 30 fps */ - FRAME_RATE_FPS_30 = 30, - /** 60: 60 fps (Windows and macOS only) */ - FRAME_RATE_FPS_60 = 60, +enum FRAME_RATE { + /** 1: 1 fps */ + FRAME_RATE_FPS_1 = 1, + /** 7: 7 fps */ + FRAME_RATE_FPS_7 = 7, + /** 10: 10 fps */ + FRAME_RATE_FPS_10 = 10, + /** 15: 15 fps */ + FRAME_RATE_FPS_15 = 15, + /** 24: 24 fps */ + FRAME_RATE_FPS_24 = 24, + /** 30: 30 fps */ + FRAME_RATE_FPS_30 = 30, + /** 60: 60 fps (Windows and macOS only) */ + FRAME_RATE_FPS_60 = 60, }; /** Video output orientation modes. @@ -1489,72 +1692,94 @@ enum ORIENTATION_MODE { - If the width of the captured video from the SDK is greater than the height, the encoder sends the video in landscape mode. The encoder also sends the rotational information of the video, and the receiver uses the rotational information to rotate the received video. - When you use a custom video source, the output video from the encoder inherits the orientation of the original video. If the original video is in portrait mode, the output video from the encoder is also in portrait mode. The encoder also sends the rotational information of the video to the receiver. */ - ORIENTATION_MODE_ADAPTIVE = 0, - /** 1: Landscape mode. + ORIENTATION_MODE_ADAPTIVE = 0, + /** 1: Landscape mode. - The video encoder always sends the video in landscape mode. The video encoder rotates the original video before sending it and the rotational infomation is 0. This mode applies to scenarios involving CDN live streaming. - */ - ORIENTATION_MODE_FIXED_LANDSCAPE = 1, - /** 2: Portrait mode. + The video encoder always sends the video in landscape mode. The video encoder rotates the original video before sending it and the rotational infomation is 0. This mode applies to scenarios involving CDN live streaming. + */ + ORIENTATION_MODE_FIXED_LANDSCAPE = 1, + /** 2: Portrait mode. - The video encoder always sends the video in portrait mode. The video encoder rotates the original video before sending it and the rotational infomation is 0. This mode applies to scenarios involving CDN live streaming. - */ - ORIENTATION_MODE_FIXED_PORTRAIT = 2, + The video encoder always sends the video in portrait mode. The video encoder rotates the original video before sending it and the rotational infomation is 0. This mode applies to scenarios involving CDN live streaming. + */ + ORIENTATION_MODE_FIXED_PORTRAIT = 2, }; -/** Video degradation preferences when the bandwidth is a constraint. */ +/** Video degradation preferences under limited bandwidth. */ enum DEGRADATION_PREFERENCE { - /** 0: (Default) Degrade the frame rate in order to maintain the video quality. */ - MAINTAIN_QUALITY = 0, - /** 1: Degrade the video quality in order to maintain the frame rate. */ - MAINTAIN_FRAMERATE = 1, - /** 2: (For future use) Maintain a balance between the frame rate and video quality. */ - MAINTAIN_BALANCED = 2, + /** 0: (Default) Prefers to reduce the video frame rate while maintaining + * video quality during video encoding under limited bandwidth. This + * degradation preference is suitable for scenarios where video quality is + * prioritized. + * + * @note In the `COMMUNICATION` channel profile, the resolution of the video + * sent may change, so remote users need to handle this issue. + * See \ref IRtcEngineEventHandler::onVideoSizeChanged "onVideoSizeChanged". + */ + MAINTAIN_QUALITY = 0, + /** 1: Prefers to reduce the video quality while maintaining the video frame + * rate during video encoding under limited bandwidth. This degradation + * preference is suitable for scenarios where smoothness is prioritized and + * video quality is allowed to be reduced. + */ + MAINTAIN_FRAMERATE = 1, + /** 2: Reduces the video frame rate and video quality simultaneously during + * video encoding under limited bandwidth. `MAINTAIN_BALANCED` has a lower + * reduction than `MAINTAIN_QUALITY` and `MAINTAIN_FRAMERATE`, and this + * preference is suitable for scenarios where both smoothness and video + * quality are a priority. + * + * @note The resolution of the video sent may change, so remote users need + * to handle this issue. + * See \ref IRtcEngineEventHandler::onVideoSizeChanged "onVideoSizeChanged". + */ + MAINTAIN_BALANCED = 2, }; /** Stream fallback options. */ -enum STREAM_FALLBACK_OPTIONS -{ - /** 0: No fallback behavior for the local/remote video stream when the uplink/downlink network conditions are poor. The quality of the stream is not guaranteed. */ - STREAM_FALLBACK_OPTION_DISABLED = 0, - /** 1: Under poor downlink network conditions, the remote video stream, to which you subscribe, falls back to the low-stream (low resolution and low bitrate) video. You can set this option only in the \ref IRtcEngine::setRemoteSubscribeFallbackOption "setRemoteSubscribeFallbackOption" method. Nothing happens when you set this in the \ref IRtcEngine::setLocalPublishFallbackOption "setLocalPublishFallbackOption" method. */ - STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW = 1, - /** 2: Under poor uplink network conditions, the published video stream falls back to audio only. - - Under poor downlink network conditions, the remote video stream, to which you subscribe, first falls back to the low-stream (low resolution and low bitrate) video; and then to an audio-only stream if the network conditions worsen.*/ - STREAM_FALLBACK_OPTION_AUDIO_ONLY = 2, +enum STREAM_FALLBACK_OPTIONS { + /** 0: No fallback behavior for the local/remote video stream when the uplink/downlink network conditions are poor. The quality of the stream is not guaranteed. */ + STREAM_FALLBACK_OPTION_DISABLED = 0, + /** 1: Under poor downlink network conditions, the remote video stream, to which you subscribe, falls back to the low-stream (low resolution and low bitrate) video. You can set this option only in the \ref IRtcEngine::setRemoteSubscribeFallbackOption "setRemoteSubscribeFallbackOption" method. Nothing happens when you set this in the \ref IRtcEngine::setLocalPublishFallbackOption "setLocalPublishFallbackOption" method. */ + STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW = 1, + /** 2: Under poor uplink network conditions, the published video stream falls back to audio only. + + Under poor downlink network conditions, the remote video stream, to which you subscribe, first falls back to the low-stream (low resolution and low bitrate) video; and then to an audio-only stream if the network conditions worsen.*/ + STREAM_FALLBACK_OPTION_AUDIO_ONLY = 2, }; - /** Camera capturer configuration. +/** Camera capture preference. */ - enum CAPTURER_OUTPUT_PREFERENCE - { - /** 0: (Default) self-adapts the camera output parameters to the system performance and network conditions to balance CPU consumption and video preview quality. - */ - CAPTURER_OUTPUT_PREFERENCE_AUTO = 0, - /** 1: Prioritizes the system performance. The SDK chooses the dimension and frame rate of the local camera capture closest to those set by \ref IRtcEngine::setVideoEncoderConfiguration "setVideoEncoderConfiguration". - */ - CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE = 1, - /** 2: Prioritizes the local preview quality. The SDK chooses higher camera output parameters to improve the local video preview quality. This option requires extra CPU and RAM usage for video pre-processing. - */ - CAPTURER_OUTPUT_PREFERENCE_PREVIEW = 2, - }; +enum CAPTURER_OUTPUT_PREFERENCE { + /** 0: (Default) self-adapts the camera output parameters to the system performance and network conditions to balance CPU consumption and video preview quality. + */ + CAPTURER_OUTPUT_PREFERENCE_AUTO = 0, + /** 1: Prioritizes the system performance. The SDK chooses the dimension and frame rate of the local camera capture closest to those set by \ref IRtcEngine::setVideoEncoderConfiguration "setVideoEncoderConfiguration". + */ + CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE = 1, + /** 2: Prioritizes the local preview quality. The SDK chooses higher camera output parameters to improve the local video preview quality. This option requires extra CPU and RAM usage for video pre-processing. + */ + CAPTURER_OUTPUT_PREFERENCE_PREVIEW = 2, + /** 3: Allows you to customize the width and height of the video image captured by the local camera. + * + * @since v3.3.0 + */ + CAPTURER_OUTPUT_PREFERENCE_MANUAL = 3, +}; /** The priority of the remote user. */ -enum PRIORITY_TYPE -{ +enum PRIORITY_TYPE { /** 50: The user's priority is high. */ PRIORITY_HIGH = 50, /** 100: (Default) The user's priority is normal. - */ + */ PRIORITY_NORMAL = 100, }; /** Connection states. */ -enum CONNECTION_STATE_TYPE -{ +enum CONNECTION_STATE_TYPE { /** 1: The SDK is disconnected from Agora's edge server. - This is the initial state before calling the \ref agora::rtc::IRtcEngine::joinChannel "joinChannel" method. @@ -1591,15 +1816,14 @@ enum CONNECTION_STATE_TYPE }; /** Reasons for a connection state change. */ -enum CONNECTION_CHANGED_REASON_TYPE -{ +enum CONNECTION_CHANGED_REASON_TYPE { /** 0: The SDK is connecting to Agora's edge server. */ CONNECTION_CHANGED_CONNECTING = 0, /** 1: The SDK has joined the channel successfully. */ CONNECTION_CHANGED_JOIN_SUCCESS = 1, /** 2: The connection between the SDK and Agora's edge server is interrupted. */ CONNECTION_CHANGED_INTERRUPTED = 2, - /** 3: The connection between the SDK and Agora's edge server is banned by Agora's edge server. */ + /** 3: The user is banned by the server. This error occurs when the user is kicked out the channel from the server. */ CONNECTION_CHANGED_BANNED_BY_SERVER = 3, /** 4: The SDK fails to join the channel for more than 20 minutes and stops reconnecting to the channel. */ CONNECTION_CHANGED_JOIN_FAILED = 4, @@ -1633,18 +1857,19 @@ enum CONNECTION_CHANGED_REASON_TYPE CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED = 13, /** 14: Timeout for the keep-alive of the connection between the SDK and Agora's edge server. The connection state changes to CONNECTION_STATE_RECONNECTING(4). */ CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT = 14, + /** 15: In cloud proxy mode, the proxy server connection interrupted. */ + CONNECTION_CHANGED_PROXY_SERVER_INTERRUPTED = 15, }; /** Network type. */ -enum NETWORK_TYPE -{ +enum NETWORK_TYPE { /** -1: The network type is unknown. */ NETWORK_TYPE_UNKNOWN = -1, /** 0: The SDK disconnects from the network. */ NETWORK_TYPE_DISCONNECTED = 0, /** 1: The network type is LAN. */ NETWORK_TYPE_LAN = 1, - /** 2: The network type is Wi-Fi(including hotspots). */ + /** 2: The network type is Wi-Fi (including hotspots). */ NETWORK_TYPE_WIFI = 2, /** 3: The network type is mobile 2G. */ NETWORK_TYPE_MOBILE_2G = 3, @@ -1653,6 +1878,26 @@ enum NETWORK_TYPE /** 5: The network type is mobile 4G. */ NETWORK_TYPE_MOBILE_4G = 5, }; +/// @cond +/** + * The reason for the upload failure. + * + * @since v3.3.0 + */ +enum UPLOAD_ERROR_REASON { + /** 0: The log file is successfully uploaded. + */ + UPLOAD_SUCCESS = 0, + /** + * 1: Network error. Check the network connection and call \ref IRtcEngine::uploadLogFile "uploadLogFile" again to upload the log file. + */ + UPLOAD_NET_ERROR = 1, + /** + * 2: An error occurs in the Agora server. Try uploading the log files later. + */ + UPLOAD_SERVER_ERROR = 2, +}; +/// @endcond /** States of the last-mile network probe test. */ enum LASTMILE_PROBE_RESULT_STATE { @@ -1663,68 +1908,118 @@ enum LASTMILE_PROBE_RESULT_STATE { /** 3: The last-mile network probe test is not carried out, probably due to poor network conditions. */ LASTMILE_PROBE_RESULT_UNAVAILABLE = 3 }; -/** Audio output routing. */ +/** The current audio route. + * + * Reports in the \ref IRtcEngineEventHandler::onAudioRouteChanged "onAudioRouteChanged" callback. + */ enum AUDIO_ROUTE_TYPE { - /** Default. - */ - AUDIO_ROUTE_DEFAULT = -1, - /** Headset. - */ - AUDIO_ROUTE_HEADSET = 0, - /** Earpiece. - */ - AUDIO_ROUTE_EARPIECE = 1, - /** Headset with no microphone. - */ - AUDIO_ROUTE_HEADSET_NO_MIC = 2, - /** Speakerphone. - */ - AUDIO_ROUTE_SPEAKERPHONE = 3, - /** Loudspeaker. - */ - AUDIO_ROUTE_LOUDSPEAKER = 4, - /** Bluetooth headset. - */ - AUDIO_ROUTE_BLUETOOTH = 5, - /** USB peripheral (macOS only). - */ - AUDIO_ROUTE_USB = 6, - /** HDMI peripheral (macOS only). - */ - AUDIO_ROUTE_HDMI = 7, - /** DisplayPort peripheral (macOS only). - */ - AUDIO_ROUTE_DISPLAYPORT = 8, - /** Apple AirPlay (macOS only). - */ - AUDIO_ROUTE_AIRPLAY = 9, + /** -1: Default audio route. + */ + AUDIO_ROUTE_DEFAULT = -1, + /** 0: The audio route is a headset with a microphone. + */ + AUDIO_ROUTE_HEADSET = 0, + /** 1: The audio route is an earpiece. + */ + AUDIO_ROUTE_EARPIECE = 1, + /** 2: The audio route is a headset without a microphone. + */ + AUDIO_ROUTE_HEADSET_NO_MIC = 2, + /** 3: The audio route is the speaker that comes with the device. + */ + AUDIO_ROUTE_SPEAKERPHONE = 3, + /** 4: (iOS and macOS only) The audio route is an external speaker. + */ + AUDIO_ROUTE_LOUDSPEAKER = 4, + /** 5: The audio route is a Bluetooth headset. + */ + AUDIO_ROUTE_BLUETOOTH = 5, + /** 6: (macOS only) The audio route is a USB peripheral device. + */ + AUDIO_ROUTE_USB = 6, + /** 7: (macOS only) The audio route is an HDMI peripheral device. + */ + AUDIO_ROUTE_HDMI = 7, + /** 8: (macOS only) The audio route is a DisplayPort peripheral device. + */ + AUDIO_ROUTE_DISPLAYPORT = 8, + /** 9: (iOS and macOS only) The audio route is Apple AirPlay. + */ + AUDIO_ROUTE_AIRPLAY = 9, +}; + +/** The cloud proxy type. + * + * @since v3.3.0 + */ +enum CLOUD_PROXY_TYPE { + /** 0: Do not use the cloud proxy. + */ + NONE_PROXY = 0, + /** 1: The cloud proxy for the UDP protocol. + */ + UDP_PROXY = 1, + /** 2: The cloud proxy for the TCP (encrypted) protocol. + */ + TCP_PROXY = 2, }; #if (defined(__APPLE__) && TARGET_OS_IOS) -/** Audio session restriction. */ +/** + * The operational permission of the SDK on the audio session. + */ enum AUDIO_SESSION_OPERATION_RESTRICTION { - /** No restriction, the SDK has full control of the audio session operations. */ - AUDIO_SESSION_OPERATION_RESTRICTION_NONE = 0, - /** The SDK does not change the audio session category. */ - AUDIO_SESSION_OPERATION_RESTRICTION_SET_CATEGORY = 1, - /** The SDK does not change any setting of the audio session (category, mode, categoryOptions). */ - AUDIO_SESSION_OPERATION_RESTRICTION_CONFIGURE_SESSION = 1 << 1, - /** The SDK keeps the audio session active when leaving a channel. */ - AUDIO_SESSION_OPERATION_RESTRICTION_DEACTIVATE_SESSION = 1 << 2, - /** The SDK does not configure the audio session anymore. */ - AUDIO_SESSION_OPERATION_RESTRICTION_ALL = 1 << 7, + /** + * 0: No restriction; the SDK can change the audio session. + */ + AUDIO_SESSION_OPERATION_RESTRICTION_NONE = 0, + /** + * 1: The SDK cannot change the audio session category. + */ + AUDIO_SESSION_OPERATION_RESTRICTION_SET_CATEGORY = 1, + /** + * 2: The SDK cannot change the audio session category, mode, or categoryOptions. + */ + AUDIO_SESSION_OPERATION_RESTRICTION_CONFIGURE_SESSION = 1 << 1, + /** + * 4: The SDK keeps the audio session active when the user leaves the + * channel, for example, to play an audio file in the background. + */ + AUDIO_SESSION_OPERATION_RESTRICTION_DEACTIVATE_SESSION = 1 << 2, + /** + * 128: Completely restricts the operational permission of the SDK on the + * audio session; the SDK cannot change the audio session. + */ + AUDIO_SESSION_OPERATION_RESTRICTION_ALL = 1 << 7, }; #endif #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) enum CAMERA_DIRECTION { - /** The rear camera. */ - CAMERA_REAR = 0, - /** The front camera. */ - CAMERA_FRONT = 1, + /** The rear camera. */ + CAMERA_REAR = 0, + /** The front camera. */ + CAMERA_FRONT = 1, }; #endif +/** + * Recording content, which is set + * in \ref IRtcEngine::startAudioRecording(const AudioRecordingConfiguration&) "startAudioRecording". + */ +enum AUDIO_RECORDING_POSITION { + /** 0: (Default) Records the mixed audio of the local user and all remote + * users. + */ + AUDIO_RECORDING_POSITION_MIXED_RECORDING_AND_PLAYBACK = 0, + /** 1: Records the audio of the local user only. + */ + AUDIO_RECORDING_POSITION_RECORDING = 1, + /** 2: Records the audio of all remote users only. + */ + AUDIO_RECORDING_POSITION_MIXED_PLAYBACK = 2, +}; + /** The uplink or downlink last-mile network probe test result. */ struct LastmileProbeOneWayResult { /** The packet loss rate (%). */ @@ -1736,7 +2031,7 @@ struct LastmileProbeOneWayResult { }; /** The uplink and downlink last-mile network probe test result. */ -struct LastmileProbeResult{ +struct LastmileProbeResult { /** The state of the probe test. */ LASTMILE_PROBE_RESULT_STATE state; /** The uplink last-mile network probe test result. */ @@ -1749,11 +2044,11 @@ struct LastmileProbeResult{ /** Configurations of the last-mile network probe test. */ struct LastmileProbeConfig { - /** Sets whether or not to test the uplink network. Some users, for example, the audience in a `LIVE_BROADCASTING` channel, do not need such a test: + /** Sets whether to test the uplink network. Some users, for example, the audience in a `LIVE_BROADCASTING` channel, do not need such a test: - true: test. - false: do not test. */ bool probeUplink; - /** Sets whether or not to test the downlink network: + /** Sets whether to test the downlink network: - true: test. - false: do not test. */ bool probeDownlink; @@ -1763,180 +2058,158 @@ struct LastmileProbeConfig { unsigned int expectedDownlinkBitrate; }; -/** Properties of the audio volume information. - - An array containing the user ID and volume information for each speaker. +/** The volume information of users. */ -struct AudioVolumeInfo -{ - /** - User ID of the speaker. The uid of the local user is 0. - */ - uid_t uid; - /** The volume of the speaker. The volume ranges between 0 (lowest volume) and 255 (highest volume). - */ - unsigned int volume; - /** Voice activity status of the local user. - * - 0: The local user is not speaking. - * - 1: The local user is speaking. - * - * @note - * - The `vad` parameter cannot report the voice activity status of the remote users. In the remote users' callback, `vad` = 0. - * - Ensure that you set `report_vad`(true) in the \ref agora::rtc::IRtcEngine::enableAudioVolumeIndication(int, int, bool) "enableAudioVolumeIndication" method to enable the voice activity detection of the local user. - */ - unsigned int vad; - /** The channel ID, which indicates which channel the speaker is in. - */ - const char * channelId; +struct AudioVolumeInfo { + /** + * The user ID. + * - In the local user's callback, `uid = 0`. + * - In the remote users' callback, `uid` is the ID of a remote user whose instantaneous volume is one of the three highest. + */ + uid_t uid; + /** The volume of each user after audio mixing. The value ranges between 0 (lowest volume) and 255 (highest volume). + * In the local user's callback, `volume = totalVolume`. + */ + unsigned int volume; + /** Voice activity status of the local user. + * - `0`: The local user is not speaking. + * - `1`: The local user is speaking. + * + * @note + * - The `vad` parameter cannot report the voice activity status of remote users. + * In the remote users' callback, `vad` is always `0`. + * - To use this parameter, you must set the `report_vad` parameter to `true` + * when calling \ref agora::rtc::IRtcEngine::enableAudioVolumeIndication(int, int, bool) "enableAudioVolumeIndication". + */ + unsigned int vad; + /** The name of the channel where the user is in. + */ + const char* channelId; }; -/// @cond /** The detailed options of a user. */ -struct ClientRoleOptions -{ - /** The latency level of an audience member in a live interactive streaming. See #AUDIENCE_LATENCY_LEVEL_TYPE. - */ - AUDIENCE_LATENCY_LEVEL_TYPE audienceLatencyLevel; - ClientRoleOptions() - : audienceLatencyLevel(AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY) {} +struct ClientRoleOptions { + /** The latency level of an audience member in interactive live streaming. See #AUDIENCE_LATENCY_LEVEL_TYPE. + */ + AUDIENCE_LATENCY_LEVEL_TYPE audienceLatencyLevel; + ClientRoleOptions() : audienceLatencyLevel(AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY) {} }; -/// @endcond /** Statistics of the channel. */ -struct RtcStats -{ - /** - * Call duration of the local user in seconds, represented by an aggregate value. - */ - unsigned int duration; - /** - * Total number of bytes transmitted, represented by an aggregate value. - */ - unsigned int txBytes; - /** - * Total number of bytes received, represented by an aggregate value. - */ - unsigned int rxBytes; - /** Total number of audio bytes sent (bytes), represented - * by an aggregate value. - */ - unsigned int txAudioBytes; - /** Total number of video bytes sent (bytes), represented - * by an aggregate value. - */ - unsigned int txVideoBytes; - /** Total number of audio bytes received (bytes) before - * network countermeasures, represented by an aggregate value. - */ - unsigned int rxAudioBytes; - /** Total number of video bytes received (bytes), - * represented by an aggregate value. - */ - unsigned int rxVideoBytes; - - /** - * Transmission bitrate (Kbps), represented by an instantaneous value. - */ - unsigned short txKBitRate; - /** - * Receive bitrate (Kbps), represented by an instantaneous value. - */ - unsigned short rxKBitRate; - /** - * Audio receive bitrate (Kbps), represented by an instantaneous value. - */ - unsigned short rxAudioKBitRate; - /** - * Audio transmission bitrate (Kbps), represented by an instantaneous value. - */ - unsigned short txAudioKBitRate; - /** - * Video receive bitrate (Kbps), represented by an instantaneous value. - */ - unsigned short rxVideoKBitRate; - /** - * Video transmission bitrate (Kbps), represented by an instantaneous value. - */ - unsigned short txVideoKBitRate; - /** Client-server latency (ms) - */ - unsigned short lastmileDelay; - /** The packet loss rate (%) from the local client to Agora's edge server, - * before using the anti-packet-loss method. - */ - unsigned short txPacketLossRate; - /** The packet loss rate (%) from Agora's edge server to the local client, - * before using the anti-packet-loss method. - */ - unsigned short rxPacketLossRate; - /** Number of users in the channel. - * - * - `COMMUNICATION` profile: The number of users in the channel. - * - `LIVE_BROADCASTING` profile: - * - If the local user is an audience: The number of users in the channel = The number of hosts in the channel + 1. - * - If the user is a host: The number of users in the channel = The number of hosts in the channel. - */ - unsigned int userCount; - /** - * Application CPU usage (%). - */ - double cpuAppUsage; - /** - System CPU usage (%). +struct RtcStats { + /** + * Call duration of the local user in seconds, represented by an aggregate value. + */ + unsigned int duration; + /** + * Total number of bytes transmitted, represented by an aggregate value. + */ + unsigned int txBytes; + /** + * Total number of bytes received, represented by an aggregate value. + */ + unsigned int rxBytes; + /** Total number of audio bytes sent (bytes), represented + * by an aggregate value. + */ + unsigned int txAudioBytes; + /** Total number of video bytes sent (bytes), represented + * by an aggregate value. + */ + unsigned int txVideoBytes; + /** Total number of audio bytes received (bytes) before + * network countermeasures, represented by an aggregate value. + */ + unsigned int rxAudioBytes; + /** Total number of video bytes received (bytes), + * represented by an aggregate value. + */ + unsigned int rxVideoBytes; - In the multi-kernel environment, this member represents the average CPU usage. - The value **=** 100 **-** System Idle Progress in Task Manager (%). - */ - double cpuTotalUsage; - /** The round-trip time delay from the client to the local router. - */ - int gatewayRtt; - /** - * The memory usage ratio of the app (%). - * - * @note This value is for reference only. Due to system limitations, you may not get the value of this member. - */ - double memoryAppUsageRatio; - /** - * The memory usage ratio of the system (%). - * - * @note This value is for reference only. Due to system limitations, you may not get the value of this member. - */ - double memoryTotalUsageRatio; - /** - * The memory usage of the app (KB). - * - * @note This value is for reference only. Due to system limitations, you may not get the value of this member. - */ - int memoryAppUsageInKbytes; - RtcStats() - : duration(0) - , txBytes(0) - , rxBytes(0) - , txAudioBytes(0) - , txVideoBytes(0) - , rxAudioBytes(0) - , rxVideoBytes(0) - , txKBitRate(0) - , rxKBitRate(0) - , rxAudioKBitRate(0) - , txAudioKBitRate(0) - , rxVideoKBitRate(0) - , txVideoKBitRate(0) - , lastmileDelay(0) - , txPacketLossRate(0) - , rxPacketLossRate(0) - , userCount(0) - , cpuAppUsage(0) - , cpuTotalUsage(0) - , gatewayRtt(0) - , memoryAppUsageRatio(0) - , memoryTotalUsageRatio(0) - , memoryAppUsageInKbytes(0) {} + /** + * Transmission bitrate (Kbps), represented by an instantaneous value. + */ + unsigned short txKBitRate; + /** + * Receive bitrate (Kbps), represented by an instantaneous value. + */ + unsigned short rxKBitRate; + /** + * Audio receive bitrate (Kbps), represented by an instantaneous value. + */ + unsigned short rxAudioKBitRate; + /** + * Audio transmission bitrate (Kbps), represented by an instantaneous value. + */ + unsigned short txAudioKBitRate; + /** + * Video receive bitrate (Kbps), represented by an instantaneous value. + */ + unsigned short rxVideoKBitRate; + /** + * Video transmission bitrate (Kbps), represented by an instantaneous value. + */ + unsigned short txVideoKBitRate; + /** Client-server latency (ms) + */ + unsigned short lastmileDelay; + /** The packet loss rate (%) from the local client to Agora's edge server, + * before using the anti-packet-loss method. + */ + unsigned short txPacketLossRate; + /** The packet loss rate (%) from Agora's edge server to the local client, + * before using the anti-packet-loss method. + */ + unsigned short rxPacketLossRate; + /** Number of users in the channel. + * + * - `COMMUNICATION` profile: The number of users in the channel. + * - `LIVE_BROADCASTING` profile: + * - If the local user is an audience: The number of users in the channel = The number of hosts in the channel + 1. + * - If the user is a host: The number of users in the channel = The number of hosts in the channel. + */ + unsigned int userCount; + /** + * Application CPU usage (%). + * + * @note The `cpuAppUsage` reported in the \ref IRtcEngineEventHandler::onLeaveChannel "onLeaveChannel" callback is always 0. + */ + double cpuAppUsage; + /** + * System CPU usage (%). + * + * In the multi-kernel environment, this member represents the average CPU usage. + * The value **=** 100 **-** System Idle Progress in Task Manager (%). + * + * @note The `cpuTotalUsage` reported in the \ref IRtcEngineEventHandler::onLeaveChannel "onLeaveChannel" callback is always 0. + */ + double cpuTotalUsage; + /** The round-trip time delay from the client to the local router. + */ + int gatewayRtt; + /** + * The memory usage ratio of the app (%). + * + * @note This value is for reference only. Due to system limitations, you may not get the value of this member. + */ + double memoryAppUsageRatio; + /** + * The memory usage ratio of the system (%). + * + * @note This value is for reference only. Due to system limitations, you may not get the value of this member. + */ + double memoryTotalUsageRatio; + /** + * The memory usage of the app (KB). + * + * @note This value is for reference only. Due to system limitations, you may not get the value of this member. + */ + int memoryAppUsageInKbytes; + RtcStats() : duration(0), txBytes(0), rxBytes(0), txAudioBytes(0), txVideoBytes(0), rxAudioBytes(0), rxVideoBytes(0), txKBitRate(0), rxKBitRate(0), rxAudioKBitRate(0), txAudioKBitRate(0), rxVideoKBitRate(0), txVideoKBitRate(0), lastmileDelay(0), txPacketLossRate(0), rxPacketLossRate(0), userCount(0), cpuAppUsage(0), cpuTotalUsage(0), gatewayRtt(0), memoryAppUsageRatio(0), memoryTotalUsageRatio(0), memoryAppUsageInKbytes(0) {} }; /** Quality change of the local video in terms of target frame rate and target bit rate since last count. - */ + */ enum QUALITY_ADAPT_INDICATION { /** The quality of the local video stays the same. */ ADAPT_NONE = 0, @@ -1945,123 +2218,156 @@ enum QUALITY_ADAPT_INDICATION { /** The quality worsens because the network bandwidth decreases. */ ADAPT_DOWN_BANDWIDTH = 2, }; +/** Quality of experience (QoE) of the local user when receiving a remote audio stream. + * + * @since v3.3.0 + */ +enum EXPERIENCE_QUALITY_TYPE { + /** 0: QoE of the local user is good. */ + EXPERIENCE_QUALITY_GOOD = 0, + /** 1: QoE of the local user is poor. */ + EXPERIENCE_QUALITY_BAD = 1, +}; + +/** + * The reason for poor QoE of the local user when receiving a remote audio stream. + * + * @since v3.3.0 + */ +enum EXPERIENCE_POOR_REASON { + /** 0: No reason, indicating good QoE of the local user. + */ + EXPERIENCE_REASON_NONE = 0, + /** 1: The remote user's network quality is poor. + */ + REMOTE_NETWORK_QUALITY_POOR = 1, + /** 2: The local user's network quality is poor. + */ + LOCAL_NETWORK_QUALITY_POOR = 2, + /** 4: The local user's Wi-Fi or mobile network signal is weak. + */ + WIRELESS_SIGNAL_POOR = 4, + /** 8: The local user enables both Wi-Fi and bluetooth, and their signals interfere with each other. + * As a result, audio transmission quality is undermined. + */ + WIFI_BLUETOOTH_COEXIST = 8, +}; /** The error code in CHANNEL_MEDIA_RELAY_ERROR. */ enum CHANNEL_MEDIA_RELAY_ERROR { - /** 0: The state is normal. - */ - RELAY_OK = 0, - /** 1: An error occurs in the server response. - */ - RELAY_ERROR_SERVER_ERROR_RESPONSE = 1, - /** 2: No server response. - * - * You can call the - * \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method to - * leave the channel. - * - * This error can also occur if your project has not enabled co-host token - * authentication. Contact support@agora.io to enable the co-host token - * authentication service before starting a channel media relay. - */ - RELAY_ERROR_SERVER_NO_RESPONSE = 2, - /** 3: The SDK fails to access the service, probably due to limited - * resources of the server. - */ - RELAY_ERROR_NO_RESOURCE_AVAILABLE = 3, - /** 4: Fails to send the relay request. - */ - RELAY_ERROR_FAILED_JOIN_SRC = 4, - /** 5: Fails to accept the relay request. - */ - RELAY_ERROR_FAILED_JOIN_DEST = 5, - /** 6: The server fails to receive the media stream. - */ - RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC = 6, - /** 7: The server fails to send the media stream. - */ - RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST = 7, - /** 8: The SDK disconnects from the server due to poor network - * connections. You can call the \ref agora::rtc::IRtcEngine::leaveChannel - * "leaveChannel" method to leave the channel. - */ - RELAY_ERROR_SERVER_CONNECTION_LOST = 8, - /** 9: An internal error occurs in the server. - */ - RELAY_ERROR_INTERNAL_ERROR = 9, - /** 10: The token of the source channel has expired. - */ - RELAY_ERROR_SRC_TOKEN_EXPIRED = 10, - /** 11: The token of the destination channel has expired. - */ - RELAY_ERROR_DEST_TOKEN_EXPIRED = 11, + /** 0: The state is normal. + */ + RELAY_OK = 0, + /** 1: An error occurs in the server response. + */ + RELAY_ERROR_SERVER_ERROR_RESPONSE = 1, + /** 2: No server response. + * + * You can call the + * \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method to + * leave the channel. + * + * This error can also occur if your project has not enabled co-host token + * authentication. Contact support@agora.io to enable the co-host token + * authentication service before starting a channel media relay. + */ + RELAY_ERROR_SERVER_NO_RESPONSE = 2, + /** 3: The SDK fails to access the service, probably due to limited + * resources of the server. + */ + RELAY_ERROR_NO_RESOURCE_AVAILABLE = 3, + /** 4: Fails to send the relay request. + */ + RELAY_ERROR_FAILED_JOIN_SRC = 4, + /** 5: Fails to accept the relay request. + */ + RELAY_ERROR_FAILED_JOIN_DEST = 5, + /** 6: The server fails to receive the media stream. + */ + RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC = 6, + /** 7: The server fails to send the media stream. + */ + RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST = 7, + /** 8: The SDK disconnects from the server due to poor network + * connections. You can call the \ref agora::rtc::IRtcEngine::leaveChannel + * "leaveChannel" method to leave the channel. + */ + RELAY_ERROR_SERVER_CONNECTION_LOST = 8, + /** 9: An internal error occurs in the server. + */ + RELAY_ERROR_INTERNAL_ERROR = 9, + /** 10: The token of the source channel has expired. + */ + RELAY_ERROR_SRC_TOKEN_EXPIRED = 10, + /** 11: The token of the destination channel has expired. + */ + RELAY_ERROR_DEST_TOKEN_EXPIRED = 11, }; /** The event code in CHANNEL_MEDIA_RELAY_EVENT. */ enum CHANNEL_MEDIA_RELAY_EVENT { - /** 0: The user disconnects from the server due to poor network - * connections. - */ - RELAY_EVENT_NETWORK_DISCONNECTED = 0, - /** 1: The network reconnects. - */ - RELAY_EVENT_NETWORK_CONNECTED = 1, - /** 2: The user joins the source channel. - */ - RELAY_EVENT_PACKET_JOINED_SRC_CHANNEL = 2, - /** 3: The user joins the destination channel. - */ - RELAY_EVENT_PACKET_JOINED_DEST_CHANNEL = 3, - /** 4: The SDK starts relaying the media stream to the destination channel. - */ - RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL = 4, - /** 5: The server receives the video stream from the source channel. - */ - RELAY_EVENT_PACKET_RECEIVED_VIDEO_FROM_SRC = 5, - /** 6: The server receives the audio stream from the source channel. - */ - RELAY_EVENT_PACKET_RECEIVED_AUDIO_FROM_SRC = 6, - /** 7: The destination channel is updated. - */ - RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL = 7, - /** 8: The destination channel update fails due to internal reasons. - */ - RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_REFUSED = 8, - /** 9: The destination channel does not change, which means that the - * destination channel fails to be updated. - */ - RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_NOT_CHANGE = 9, - /** 10: The destination channel name is NULL. - */ - RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_IS_NULL = 10, - /** 11: The video profile is sent to the server. - */ - RELAY_EVENT_VIDEO_PROFILE_UPDATE = 11, + /** 0: The user disconnects from the server due to poor network + * connections. + */ + RELAY_EVENT_NETWORK_DISCONNECTED = 0, + /** 1: The network reconnects. + */ + RELAY_EVENT_NETWORK_CONNECTED = 1, + /** 2: The user joins the source channel. + */ + RELAY_EVENT_PACKET_JOINED_SRC_CHANNEL = 2, + /** 3: The user joins the destination channel. + */ + RELAY_EVENT_PACKET_JOINED_DEST_CHANNEL = 3, + /** 4: The SDK starts relaying the media stream to the destination channel. + */ + RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL = 4, + /** 5: The server receives the video stream from the source channel. + */ + RELAY_EVENT_PACKET_RECEIVED_VIDEO_FROM_SRC = 5, + /** 6: The server receives the audio stream from the source channel. + */ + RELAY_EVENT_PACKET_RECEIVED_AUDIO_FROM_SRC = 6, + /** 7: The destination channel is updated. + */ + RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL = 7, + /** 8: The destination channel update fails due to internal reasons. + */ + RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_REFUSED = 8, + /** 9: The destination channel does not change, which means that the + * destination channel fails to be updated. + */ + RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_NOT_CHANGE = 9, + /** 10: The destination channel name is NULL. + */ + RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_IS_NULL = 10, + /** 11: The video profile is sent to the server. + */ + RELAY_EVENT_VIDEO_PROFILE_UPDATE = 11, }; /** The state code in CHANNEL_MEDIA_RELAY_STATE. */ enum CHANNEL_MEDIA_RELAY_STATE { - /** 0: The initial state. After you successfully stop the channel media - * relay by calling \ref IRtcEngine::stopChannelMediaRelay "stopChannelMediaRelay", - * the \ref IRtcEngineEventHandler::onChannelMediaRelayStateChanged "onChannelMediaRelayStateChanged" callback returns this state. - */ - RELAY_STATE_IDLE = 0, - /** 1: The SDK tries to relay the media stream to the destination channel. - */ - RELAY_STATE_CONNECTING = 1, - /** 2: The SDK successfully relays the media stream to the destination - * channel. - */ - RELAY_STATE_RUNNING = 2, - /** 3: A failure occurs. See the details in code. - */ - RELAY_STATE_FAILURE = 3, + /** 0: The initial state. After you successfully stop the channel media + * relay by calling \ref IRtcEngine::stopChannelMediaRelay "stopChannelMediaRelay", + * the \ref IRtcEngineEventHandler::onChannelMediaRelayStateChanged "onChannelMediaRelayStateChanged" callback returns this state. + */ + RELAY_STATE_IDLE = 0, + /** 1: The SDK tries to relay the media stream to the destination channel. + */ + RELAY_STATE_CONNECTING = 1, + /** 2: The SDK successfully relays the media stream to the destination + * channel. + */ + RELAY_STATE_RUNNING = 2, + /** 3: A failure occurs. See the details in code. + */ + RELAY_STATE_FAILURE = 3, }; /** Statistics of the local video stream. */ -struct LocalVideoStats -{ +struct LocalVideoStats { /** Bitrate (Kbps) sent in the reported interval, which does not include * the bitrate of the retransmission video after packet loss. */ @@ -2077,10 +2383,10 @@ struct LocalVideoStats */ int rendererOutputFrameRate; /** The target bitrate (Kbps) of the current encoder. This value is estimated by the SDK based on the current network conditions. - */ + */ int targetBitrate; /** The target frame rate (fps) of the current encoder. - */ + */ int targetFrameRate; /** Quality change of the local video in terms of target frame rate and * target bit rate in this reported interval. See #QUALITY_ADAPT_INDICATION. @@ -2110,149 +2416,181 @@ struct LocalVideoStats /** The capture frame rate (fps) of the local video. */ int captureFrameRate; + /** The brightness level of the video image captured by the local camera. See #CAPTURE_BRIGHTNESS_LEVEL_TYPE. + * + * @since v3.3.0 + */ + CAPTURE_BRIGHTNESS_LEVEL_TYPE captureBrightnessLevel; }; /** Statistics of the remote video stream. */ -struct RemoteVideoStats -{ -/** - User ID of the remote user sending the video streams. - */ -uid_t uid; -/** **DEPRECATED** Time delay (ms). - * - * In scenarios where audio and video is synchronized, you can use the value of - * `networkTransportDelay` and `jitterBufferDelay` in `RemoteAudioStats` to know the delay statistics of the remote video. - */ -int delay; -/** Width (pixels) of the video stream. - */ -int width; -/** - Height (pixels) of the video stream. - */ -int height; -/** - Bitrate (Kbps) received since the last count. - */ -int receivedBitrate; -/** The decoder output frame rate (fps) of the remote video. - */ -int decoderOutputFrameRate; -/** The render output frame rate (fps) of the remote video. - */ -int rendererOutputFrameRate; -/** Packet loss rate (%) of the remote video stream after using the anti-packet-loss method. - */ -int packetLossRate; -/** The type of the remote video stream: #REMOTE_VIDEO_STREAM_TYPE - */ -REMOTE_VIDEO_STREAM_TYPE rxStreamType; -/** - The total freeze time (ms) of the remote video stream after the remote user joins the channel. - In a video session where the frame rate is set to no less than 5 fps, video freeze occurs when - the time interval between two adjacent renderable video frames is more than 500 ms. - */ -int totalFrozenTime; -/** - The total video freeze time as a percentage (%) of the total time when the video is available. - */ -int frozenRate; -/** - The total time (ms) when the remote user in the Communication profile or the remote - broadcaster in the Live-broadcast profile neither stops sending the video stream nor - disables the video module after joining the channel. +struct RemoteVideoStats { + /** + User ID of the remote user sending the video streams. + */ + uid_t uid; + /** **DEPRECATED** Time delay (ms). + * + * In scenarios where audio and video is synchronized, you can use the value of + * `networkTransportDelay` and `jitterBufferDelay` in `RemoteAudioStats` to know the delay statistics of the remote video. + */ + int delay; + /** Width (pixels) of the video stream. + */ + int width; + /** + Height (pixels) of the video stream. + */ + int height; + /** + Bitrate (Kbps) received since the last count. + */ + int receivedBitrate; + /** The decoder output frame rate (fps) of the remote video. + */ + int decoderOutputFrameRate; + /** The render output frame rate (fps) of the remote video. + */ + int rendererOutputFrameRate; + /** Packet loss rate (%) of the remote video stream after using the anti-packet-loss method. + */ + int packetLossRate; + /** The type of the remote video stream: #REMOTE_VIDEO_STREAM_TYPE + */ + REMOTE_VIDEO_STREAM_TYPE rxStreamType; + /** + The total freeze time (ms) of the remote video stream after the remote user joins the channel. + In a video session where the frame rate is set to no less than 5 fps, video freeze occurs when + the time interval between two adjacent renderable video frames is more than 500 ms. + */ + int totalFrozenTime; + /** + The total video freeze time as a percentage (%) of the total time when the video is available. + */ + int frozenRate; + /** + The total time (ms) when the remote user in the Communication profile or the remote + broadcaster in the Live-broadcast profile neither stops sending the video stream nor + disables the video module after joining the channel. - @since v3.0.1 -*/ -int totalActiveTime; -/** - * The total publish duration (ms) of the remote video stream. - */ -int publishDuration; + @since v3.0.1 + */ + int totalActiveTime; + /** + * The total publish duration (ms) of the remote video stream. + */ + int publishDuration; }; /** Audio statistics of the local user */ -struct LocalAudioStats -{ - /** The number of channels. - */ - int numChannels; - /** The sample rate (Hz). - */ - int sentSampleRate; - /** The average sending bitrate (Kbps). - */ - int sentBitrate; - /** The audio packet loss rate (%) from the local client to the Agora edge server before applying the anti-packet loss strategies. - */ - unsigned short txPacketLossRate; +struct LocalAudioStats { + /** The number of channels. + */ + int numChannels; + /** The sample rate (Hz). + */ + int sentSampleRate; + /** The average sending bitrate (Kbps). + */ + int sentBitrate; + /** The audio packet loss rate (%) from the local client to the Agora edge server before applying the anti-packet loss strategies. + */ + unsigned short txPacketLossRate; }; /** Audio statistics of a remote user */ -struct RemoteAudioStats -{ - /** User ID of the remote user sending the audio streams. - * - */ - uid_t uid; - /** Audio quality received by the user: #QUALITY_TYPE. - */ - int quality; - /** Network delay (ms) from the sender to the receiver. - */ - int networkTransportDelay; - /** Network delay (ms) from the receiver to the jitter buffer. - */ - int jitterBufferDelay; - /** The audio frame loss rate in the reported interval. - */ - int audioLossRate; - /** The number of channels. - */ - int numChannels; - /** The sample rate (Hz) of the received audio stream in the reported - * interval. - */ - int receivedSampleRate; - /** The average bitrate (Kbps) of the received audio stream in the - * reported interval. */ - int receivedBitrate; - /** The total freeze time (ms) of the remote audio stream after the remote user joins the channel. In a session, audio freeze occurs when the audio frame loss rate reaches 4%. - */ - int totalFrozenTime; - /** The total audio freeze time as a percentage (%) of the total time when the audio is available. */ - int frozenRate; - /** The total time (ms) when the remote user in the `COMMUNICATION` profile or the remote host in - the `LIVE_BROADCASTING` profile neither stops sending the audio stream nor disables the audio module after joining the channel. - */ - int totalActiveTime; - /** - * The total publish duration (ms) of the remote audio stream. - */ - int publishDuration; +struct RemoteAudioStats { + /** User ID of the remote user sending the audio streams. + * + */ + uid_t uid; + /** Audio quality received by the user: #QUALITY_TYPE. + */ + int quality; + /** Network delay (ms) from the sender to the receiver. + */ + int networkTransportDelay; + /** Network delay (ms) from the receiver to the jitter buffer. + */ + int jitterBufferDelay; + /** The audio frame loss rate in the reported interval. + */ + int audioLossRate; + /** The number of channels. + */ + int numChannels; + /** The sample rate (Hz) of the received audio stream in the reported + * interval. + */ + int receivedSampleRate; + /** The average bitrate (Kbps) of the received audio stream in the + * reported interval. */ + int receivedBitrate; + /** The total freeze time (ms) of the remote audio stream after the remote user joins the channel. In a session, audio freeze occurs when the audio frame loss rate reaches 4%. + */ + int totalFrozenTime; + /** The total audio freeze time as a percentage (%) of the total time when the audio is available. */ + int frozenRate; + /** The total time (ms) when the remote user in the `COMMUNICATION` profile or the remote host in + the `LIVE_BROADCASTING` profile neither stops sending the audio stream nor disables the audio module after joining the channel. + */ + int totalActiveTime; + /** + * The total publish duration (ms) of the remote audio stream. + */ + int publishDuration; + /** + * Quality of experience (QoE) of the local user when receiving a remote audio stream. See #EXPERIENCE_QUALITY_TYPE. + * + * @since v3.3.0 + */ + int qoeQuality; + /** + * The reason for poor QoE of the local user when receiving a remote audio stream. See #EXPERIENCE_POOR_REASON. + * + * @since v3.3.0 + */ + int qualityChangedReason; + /** + * The quality of the remote audio stream as determined by the Agora + * real-time audio MOS (Mean Opinion Score) measurement method in the + * reported interval. The return value ranges from 0 to 500. Dividing the + * return value by 100 gets the MOS score, which ranges from 0 to 5. The + * higher the score, the better the audio quality. + * + * @since v3.3.1 + * + * The subjective perception of audio quality corresponding to the Agora + * real-time audio MOS scores is as follows: + * + * | MOS score | Perception of audio quality | + * |-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| + * | Greater than 4 | Excellent. The audio sounds clear and smooth. | + * | From 3.5 to 4 | Good. The audio has some perceptible impairment, but still sounds clear. | + * | From 3 to 3.5 | Fair. The audio freezes occasionally and requires attentive listening. | + * | From 2.5 to 3 | Poor. The audio sounds choppy and requires considerable effort to understand. | + * | From 2 to 2.5 | Bad. The audio has occasional noise. Consecutive audio dropouts occur, resulting in some information loss. The users can communicate only with difficulty. | + * | Less than 2 | Very bad. The audio has persistent noise. Consecutive audio dropouts are frequent, resulting in severe information loss. Communication is nearly impossible. | + */ + int mosValue; }; /** * Video dimensions. */ struct VideoDimensions { - /** Width (pixels) of the video. */ - int width; - /** Height (pixels) of the video. */ - int height; - VideoDimensions() - : width(640), height(480) - {} - VideoDimensions(int w, int h) - : width(w), height(h) - {} + /** Width (pixels) of the video. */ + int width; + /** Height (pixels) of the video. */ + int height; + VideoDimensions() : width(640), height(480) {} + VideoDimensions(int w, int h) : width(w), height(h) {} }; /** (Recommended) The standard bitrate set in the \ref IRtcEngine::setVideoEncoderConfiguration "setVideoEncoderConfiguration" method. - In this mode, the bitrates differ between the live interactive streaming and communication profiles: + In this mode, the bitrates differ between the interactive live streaming and communication profiles: - `COMMUNICATION` profile: The video bitrate is the same as the base bitrate. - `LIVE_BROADCASTING` profile: The video bitrate is twice the base bitrate. @@ -2274,173 +2612,175 @@ const int DEFAULT_MIN_BITRATE = -1; */ struct VideoEncoderConfiguration { /** The video frame dimensions (px) used to specify the video quality and measured by the total number of pixels along a frame's width and height: VideoDimensions. The default value is 640 x 360. + */ + VideoDimensions dimensions; + /** The frame rate of the video: #FRAME_RATE. The default value is 15. + + Note that we do not recommend setting this to a value greater than 30. */ - VideoDimensions dimensions; - /** The frame rate of the video: #FRAME_RATE. The default value is 15. + FRAME_RATE frameRate; + /** The minimum frame rate of the video. The default value is -1. + */ + int minFrameRate; + /** The video encoding bitrate (Kbps). + + Choose one of the following options: + + - #STANDARD_BITRATE: (Recommended) The standard bitrate. + - the `COMMUNICATION` profile: the encoding bitrate equals the base bitrate. + - the `LIVE_BROADCASTING` profile: the encoding bitrate is twice the base bitrate. + - #COMPATIBLE_BITRATE: The compatible bitrate: the bitrate stays the same regardless of the profile. + + the `COMMUNICATION` profile prioritizes smoothness, while the `LIVE_BROADCASTING` profile prioritizes video quality (requiring a higher bitrate). We recommend setting the bitrate mode as #STANDARD_BITRATE to address this difference. + + The following table lists the recommended video encoder configurations, where the base bitrate applies to the `COMMUNICATION` profile. Set your bitrate based on this table. If you set a bitrate beyond the proper range, the SDK automatically sets it to within the range. + + @note + In the following table, **Base Bitrate** applies to the `COMMUNICATION` profile, and **Live Bitrate** applies to the `LIVE_BROADCASTING` profile. + + | Resolution | Frame Rate (fps) | Base Bitrate (Kbps) | Live Bitrate (Kbps) | + |------------------------|------------------|----------------------------------------|----------------------------------------| + | 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 | - Note that we do not recommend setting this to a value greater than 30. - */ - FRAME_RATE frameRate; - /** The minimum frame rate of the video. The default value is -1. - */ - int minFrameRate; - /** The video encoding bitrate (Kbps). - - Choose one of the following options: - - - #STANDARD_BITRATE: (Recommended) The standard bitrate. - - the `COMMUNICATION` profile: the encoding bitrate equals the base bitrate. - - the `LIVE_BROADCASTING` profile: the encoding bitrate is twice the base bitrate. - - #COMPATIBLE_BITRATE: The compatible bitrate: the bitrate stays the same regardless of the profile. - - the `COMMUNICATION` profile prioritizes smoothness, while the `LIVE_BROADCASTING` profile prioritizes video quality (requiring a higher bitrate). We recommend setting the bitrate mode as #STANDARD_BITRATE to address this difference. - - The following table lists the recommended video encoder configurations, where the base bitrate applies to the `COMMUNICATION` profile. Set your bitrate based on this table. If you set a bitrate beyond the proper range, the SDK automatically sets it to within the range. - - @note - In the following table, **Base Bitrate** applies to the `COMMUNICATION` profile, and **Live Bitrate** applies to the `LIVE_BROADCASTING` profile. - - | Resolution | Frame Rate (fps) | Base Bitrate (Kbps) | Live Bitrate (Kbps) | - |------------------------|------------------|----------------------------------------|----------------------------------------| - | 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 | + */ + int bitrate; + /** The minimum encoding bitrate (Kbps). - */ - int bitrate; - /** The minimum encoding bitrate (Kbps). + The 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. - The 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 only to the `LIVE_BROADCASTING` profile. + */ + int minBitrate; + /** The video orientation mode of the video: #ORIENTATION_MODE. + */ + ORIENTATION_MODE orientationMode; + /** The video encoding degradation preference under limited bandwidth: #DEGRADATION_PREFERENCE. + */ + DEGRADATION_PREFERENCE degradationPreference; + /** Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees. See #VIDEO_MIRROR_MODE_TYPE - @note This parameter applies only to the `LIVE_BROADCASTING` profile. - */ - int minBitrate; - /** The video orientation mode of the video: #ORIENTATION_MODE. - */ - ORIENTATION_MODE orientationMode; - /** The video encoding degradation preference under limited bandwidth: #DEGRADATION_PREFERENCE. - */ - DEGRADATION_PREFERENCE degradationPreference; - /** Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees. See #VIDEO_MIRROR_MODE_TYPE - - @note: The SDK disables the mirror mode by default. - */ - VIDEO_MIRROR_MODE_TYPE mirrorMode; - - VideoEncoderConfiguration( - const VideoDimensions& d, FRAME_RATE f, - int b, ORIENTATION_MODE m, VIDEO_MIRROR_MODE_TYPE mr = VIDEO_MIRROR_MODE_AUTO) - : dimensions(d), frameRate(f), minFrameRate(-1), bitrate(b), - minBitrate(DEFAULT_MIN_BITRATE), orientationMode(m), - degradationPreference(MAINTAIN_QUALITY), mirrorMode(mr) - {} - VideoEncoderConfiguration( - int width, int height, FRAME_RATE f, - int b, ORIENTATION_MODE m, VIDEO_MIRROR_MODE_TYPE mr = VIDEO_MIRROR_MODE_AUTO) - : dimensions(width, height), frameRate(f), - minFrameRate(-1), bitrate(b), - minBitrate(DEFAULT_MIN_BITRATE), orientationMode(m), - degradationPreference(MAINTAIN_QUALITY), mirrorMode(mr) - {} - VideoEncoderConfiguration() - : dimensions(640, 480) - , frameRate(FRAME_RATE_FPS_15) - , minFrameRate(-1) - , bitrate(STANDARD_BITRATE) - , minBitrate(DEFAULT_MIN_BITRATE) - , orientationMode(ORIENTATION_MODE_ADAPTIVE) - , degradationPreference(MAINTAIN_QUALITY) - , mirrorMode(VIDEO_MIRROR_MODE_AUTO) - {} + @note The SDK disables the mirror mode by default. + */ + VIDEO_MIRROR_MODE_TYPE mirrorMode; + + VideoEncoderConfiguration(const VideoDimensions& d, FRAME_RATE f, int b, ORIENTATION_MODE m, VIDEO_MIRROR_MODE_TYPE mr = VIDEO_MIRROR_MODE_AUTO) : dimensions(d), frameRate(f), minFrameRate(-1), bitrate(b), minBitrate(DEFAULT_MIN_BITRATE), orientationMode(m), degradationPreference(MAINTAIN_QUALITY), mirrorMode(mr) {} + VideoEncoderConfiguration(int width, int height, FRAME_RATE f, int b, ORIENTATION_MODE m, VIDEO_MIRROR_MODE_TYPE mr = VIDEO_MIRROR_MODE_AUTO) : dimensions(width, height), frameRate(f), minFrameRate(-1), bitrate(b), minBitrate(DEFAULT_MIN_BITRATE), orientationMode(m), degradationPreference(MAINTAIN_QUALITY), mirrorMode(mr) {} + VideoEncoderConfiguration() : dimensions(640, 480), frameRate(FRAME_RATE_FPS_15), minFrameRate(-1), bitrate(STANDARD_BITRATE), minBitrate(DEFAULT_MIN_BITRATE), orientationMode(ORIENTATION_MODE_ADAPTIVE), degradationPreference(MAINTAIN_QUALITY), mirrorMode(VIDEO_MIRROR_MODE_AUTO) {} +}; + +/** Recording configuration, which is set in + * \ref IRtcEngine::startAudioRecording(const AudioRecordingConfiguration&) "startAudioRecording". + * + * @since v3.4.0 + */ +struct AudioRecordingConfiguration { + /** The absolute path (including the filename extensions) of the recording + * file. For example: `C:\music\audio.aac`. + * + * @note Ensure that the path you specify exists and is writable. + */ + const char* filePath; + /** Audio recording quality. See #AUDIO_RECORDING_QUALITY_TYPE. + * + * @note This parameter applies to AAC files only. + */ + AUDIO_RECORDING_QUALITY_TYPE recordingQuality; + /** Recording content. See #AUDIO_RECORDING_POSITION. + */ + AUDIO_RECORDING_POSITION recordingPosition; + /** Recording sample rate (Hz). The following values are supported: + * + * - `16000` + * - (Default) `32000` + * - `44100` + * - `48000` + * + * @note If this parameter is set to `44100` or `48000`, for better + * recording effects, Agora recommends recording WAV files or AAC files + * whose `recordingQuality` is + * #AUDIO_RECORDING_QUALITY_MEDIUM or #AUDIO_RECORDING_QUALITY_HIGH. + */ + int recordingSampleRate; + AudioRecordingConfiguration() : filePath(nullptr), recordingQuality(AUDIO_RECORDING_QUALITY_MEDIUM), recordingPosition(AUDIO_RECORDING_POSITION_MIXED_RECORDING_AND_PLAYBACK), recordingSampleRate(32000) {} + AudioRecordingConfiguration(const char* path, AUDIO_RECORDING_QUALITY_TYPE quality, AUDIO_RECORDING_POSITION position, int sampleRate) : filePath(path), recordingQuality(quality), recordingPosition(position), recordingSampleRate(sampleRate) {} }; /** The video and audio properties of the user displaying the video in the CDN live. Agora supports a maximum of 17 transcoding users in a CDN streaming channel. -*/ + */ typedef struct TranscodingUser { /** User ID of the user displaying the video in the CDN live. - */ - uid_t uid; + */ + uid_t uid; -/** Horizontal position (pixel) of the video frame relative to the top left corner. -*/ - int x; - /** Vertical position (pixel) of the video frame relative to the top left corner. - */ - int y; - /** Width (pixel) of the video frame. The default value is 360. - */ - int width; - /** Height (pixel) of the video frame. The default value is 640. - */ - int height; - - /** The layer index of the video frame. An integer. The value range is [0, 100]. - - - 0: (Default) Bottom layer. - - 100: Top layer. - - @note - - If zOrder is beyond this range, the SDK reports #ERR_INVALID_ARGUMENT. - - As of v2.3, the SDK supports zOrder = 0. - */ - int zOrder; - /** The transparency level of the user's video. The value ranges between 0 and 1.0: + /** Horizontal position (pixel) of the video frame relative to the top left corner. + */ + int x; + /** Vertical position (pixel) of the video frame relative to the top left corner. + */ + int y; + /** Width (pixel) of the video frame. The default value is 360. + */ + int width; + /** Height (pixel) of the video frame. The default value is 640. + */ + int height; - - 0: Completely transparent - - 1.0: (Default) Opaque - */ - double alpha; - /** The audio channel of the sound. The default value is 0: + /** The layer index of the video frame. An integer. The value range is [0, 100]. - - 0: (Default) Supports dual channels at most, depending on the upstream of the host. - - 1: The audio stream of the host uses the FL audio channel. If the upstream of the host uses multiple audio channels, these channels are mixed into mono first. - - 2: The audio stream of the host uses the FC audio channel. If the upstream of the host uses multiple audio channels, these channels are mixed into mono first. - - 3: The audio stream of the host uses the FR audio channel. If the upstream of the host uses multiple audio channels, these channels are mixed into mono first. - - 4: The audio stream of the host uses the BL audio channel. If the upstream of the host uses multiple audio channels, these channels are mixed into mono first. - - 5: The audio stream of the host uses the BR audio channel. If the upstream of the host uses multiple audio channels, these channels are mixed into mono first. + - 0: (Default) Bottom layer. + - 100: Top layer. - @note If your setting is not 0, you may need a specialized player. - */ - int audioChannel; - TranscodingUser() - : uid(0) - , x(0) - , y(0) - , width(0) - , height(0) - , zOrder(0) - , alpha(1.0) - , audioChannel(0) - {} + @note + - If zOrder is beyond this range, the SDK reports #ERR_INVALID_ARGUMENT. + - As of v2.3, the SDK supports zOrder = 0. + */ + int zOrder; + /** The transparency level of the user's video. The value ranges between 0 and 1.0: + + - 0: Completely transparent + - 1.0: (Default) Opaque + */ + double alpha; + /** The audio channel of the sound. The default value is 0: + + - 0: (Default) Supports dual channels at most, depending on the upstream of the host. + - 1: The audio stream of the host uses the FL audio channel. If the upstream of the host uses multiple audio channels, these channels are mixed into mono first. + - 2: The audio stream of the host uses the FC audio channel. If the upstream of the host uses multiple audio channels, these channels are mixed into mono first. + - 3: The audio stream of the host uses the FR audio channel. If the upstream of the host uses multiple audio channels, these channels are mixed into mono first. + - 4: The audio stream of the host uses the BL audio channel. If the upstream of the host uses multiple audio channels, these channels are mixed into mono first. + - 5: The audio stream of the host uses the BR audio channel. If the upstream of the host uses multiple audio channels, these channels are mixed into mono first. + + @note If your setting is not 0, you may need a specialized player. + */ + int audioChannel; + TranscodingUser() : uid(0), x(0), y(0), width(0), height(0), zOrder(0), alpha(1.0), audioChannel(0) {} } TranscodingUser; @@ -2449,550 +2789,530 @@ typedef struct TranscodingUser { The properties of the watermark and background images. */ typedef struct RtcImage { - RtcImage() : - url(NULL), - x(0), - y(0), - width(0), - height(0) - {} - /** HTTP/HTTPS URL address of the image on the live video. The maximum length of this parameter is 1024 bytes. */ - const char* url; - /** Horizontal position of the image from the upper left of the live video. */ - int x; - /** Vertical position of the image from the upper left of the live video. */ - int y; - /** Width of the image on the live video. */ - int width; - /** Height of the image on the live video. */ - int height; + RtcImage() : url(NULL), x(0), y(0), width(0), height(0) {} + /** HTTP/HTTPS URL address of the image on the live video. The maximum length of this parameter is 1024 bytes. */ + const char* url; + /** Horizontal position of the image from the upper left of the live video. */ + int x; + /** Vertical position of the image from the upper left of the live video. */ + int y; + /** Width of the image on the live video. */ + int width; + /** Height of the image on the live video. */ + int height; } RtcImage; /// @cond -/** The configuration for advanced features of the RTMP streaming with transcoding. +/** The configuration for advanced features of the RTMP or RTMPS streaming with transcoding. */ typedef struct LiveStreamAdvancedFeature { - LiveStreamAdvancedFeature() : featureName(NULL) , opened(false) { - } + LiveStreamAdvancedFeature() : featureName(NULL), opened(false) {} - /** The advanced feature for high-quality video with a lower bitrate. */ - const char* LBHQ = "lbhq"; - /** The advanced feature for the optimized video encoder. */ - const char* VEO = "veo"; + /** The advanced feature for high-quality video with a lower bitrate. */ + const char* LBHQ = "lbhq"; + /** The advanced feature for the optimized video encoder. */ + const char* VEO = "veo"; - /** The name of the advanced feature. It contains LBHQ and VEO. - */ - const char* featureName; + /** The name of the advanced feature. It contains LBHQ and VEO. + */ + const char* featureName; - /** Whether to enable the advanced feature: - * - true: Enable the advanced feature. - * - false: (Default) Disable the advanced feature. - */ - bool opened; + /** Whether to enable the advanced feature: + * - true: Enable the advanced feature. + * - false: (Default) Disable the advanced feature. + */ + bool opened; } LiveStreamAdvancedFeature; /// @endcond /** A struct for managing CDN live audio/video transcoding settings. -*/ + */ typedef struct LiveTranscoding { - /** The width of the video in pixels. The default value is 360. - * - When pushing video streams to the CDN, ensure that `width` is at least 64; otherwise, the Agora server adjusts the value to 64. - * - When pushing audio streams to the CDN, set `width` and `height` as 0. - */ - int width; - /** The height of the video in pixels. The default value is 640. - * - When pushing video streams to the CDN, ensure that `height` is at least 64; otherwise, the Agora server adjusts the value to 64. - * - When pushing audio streams to the CDN, set `width` and `height` as 0. - */ - int height; - /** Bitrate of the CDN live output video stream. The default value is 400 Kbps. - - Set this parameter according to the Video Bitrate Table. If you set a bitrate beyond the proper range, the SDK automatically adapts it to a value within the range. - */ - int videoBitrate; - /** Frame rate of the output video stream set for the CDN live streaming. The default value is 15 fps, and the value range is (0,30]. - - @note The Agora server adjusts any value over 30 to 30. - */ - int videoFramerate; - - /** **DEPRECATED** Latency mode: - - - true: Low latency with unassured quality. - - false: (Default) High latency with assured quality. - */ - bool lowLatency; + /** The width of the video in pixels. The default value is 360. + * - When pushing video streams to the CDN, ensure that `width` is at least 64; otherwise, the Agora server adjusts the value to 64. + * - When pushing audio streams to the CDN, set `width` and `height` as 0. + */ + int width; + /** The height of the video in pixels. The default value is 640. + * - When pushing video streams to the CDN, ensure that `height` is at least 64; otherwise, the Agora server adjusts the value to 64. + * - When pushing audio streams to the CDN, set `width` and `height` as 0. + */ + int height; + /** Bitrate of the CDN live output video stream. The default value is 400 Kbps. - /** Video GOP in frames. The default value is 30 fps. - */ - int videoGop; - /** Self-defined video codec profile: #VIDEO_CODEC_PROFILE_TYPE. + Set this parameter according to the Video Bitrate Table. If you set a bitrate beyond the proper range, the SDK automatically adapts it to a value within the range. + */ + int videoBitrate; + /** Frame rate of the output video stream set for the CDN live streaming. The default value is 15 fps, and the value range is (0,30]. - @note If you set this parameter to other values, Agora adjusts it to the default value of 100. - */ - VIDEO_CODEC_PROFILE_TYPE videoCodecProfile; - /** The background color in RGB hex value. Value only. Do not include a preceeding #. For example, 0xFFB6C1 (light pink). The default value is 0x000000 (black). - */ - unsigned int backgroundColor; + @note The Agora server adjusts any value over 30 to 30. + */ + int videoFramerate; - /** video codec type */ - VIDEO_CODEC_TYPE_FOR_STREAM videoCodecType; + /** **DEPRECATED** Latency mode: - /** The number of users in the live interactive streaming. - */ - unsigned int userCount; - /** TranscodingUser - */ - TranscodingUser *transcodingUsers; - /** Reserved property. Extra user-defined information to send SEI for the H.264/H.265 video stream to the CDN live client. Maximum length: 4096 Bytes. + - true: Low latency with unassured quality. + - false: (Default) High latency with assured quality. + */ + bool lowLatency; - For more information on SEI frame, see [SEI-related questions](https://docs.agora.io/en/faq/sei). - */ - const char *transcodingExtraInfo; + /** Video GOP in frames. The default value is 30 fps. + */ + int videoGop; + /** Self-defined video codec profile: #VIDEO_CODEC_PROFILE_TYPE. - /** **DEPRECATED** The metadata sent to the CDN live client defined by the RTMP or HTTP-FLV metadata. - */ - const char *metadata; - /** The watermark image added to the CDN live publishing stream. - - Ensure that the format of the image is PNG. Once a watermark image is added, the audience of the CDN live publishing stream can see the watermark image. See RtcImage. - */ - RtcImage* watermark; - /** The background image added to the CDN live publishing stream. - - Once a background image is added, the audience of the CDN live publishing stream can see the background image. See RtcImage. - */ - RtcImage* backgroundImage; - /** Self-defined audio-sample rate: #AUDIO_SAMPLE_RATE_TYPE. - */ - AUDIO_SAMPLE_RATE_TYPE audioSampleRate; - /** Bitrate of the CDN live audio output stream. The default value is 48 Kbps, and the highest value is 128. - */ - int audioBitrate; - /** The numbder of audio channels for the CDN live stream. Agora recommends choosing 1 (mono), or 2 (stereo) audio channels. Special players are required if you choose option 3, 4, or 5: - - - 1: (Default) Mono. - - 2: Stereo. - - 3: Three audio channels. - - 4: Four audio channels. - - 5: Five audio channels. - */ - int audioChannels; - /** Self-defined audio codec profile: #AUDIO_CODEC_PROFILE_TYPE. - */ + @note If you set this parameter to other values, Agora adjusts it to the default value of 100. + */ + VIDEO_CODEC_PROFILE_TYPE videoCodecProfile; + /** The background color in RGB hex value. Value only. Do not include a preceeding #. For example, 0xFFB6C1 (light pink). The default value is 0x000000 (black). + */ + unsigned int backgroundColor; - AUDIO_CODEC_PROFILE_TYPE audioCodecProfile; - /// @cond - /** Advanced features of the RTMP streaming with transcoding. See LiveStreamAdvancedFeature. - * - * @since v3.1.0 - */ - LiveStreamAdvancedFeature* advancedFeatures; - - /** The number of enabled advanced features. The default value is 0. */ - unsigned int advancedFeatureCount; - /// @endcond - LiveTranscoding() - : width(360) - , height(640) - , videoBitrate(400) - , videoFramerate(15) - , lowLatency(false) - , videoGop(30) - , videoCodecProfile(VIDEO_CODEC_PROFILE_HIGH) - , backgroundColor(0x000000) - , videoCodecType(VIDEO_CODEC_H264_FOR_STREAM) - , userCount(0) - , transcodingUsers(NULL) - , transcodingExtraInfo(NULL) - , metadata(NULL) - , watermark(NULL) - , backgroundImage(NULL) - , audioSampleRate(AUDIO_SAMPLE_RATE_48000) - , audioBitrate(48) - , audioChannels(1) - , audioCodecProfile(AUDIO_CODEC_PROFILE_LC_AAC) - , advancedFeatures(NULL) - , advancedFeatureCount(0) - {} -} LiveTranscoding; + /** video codec type */ + VIDEO_CODEC_TYPE_FOR_STREAM videoCodecType; + + /** The number of users in the interactive live streaming. + */ + unsigned int userCount; + /** TranscodingUser + */ + TranscodingUser* transcodingUsers; + /** Reserved property. Extra user-defined information to send SEI for the H.264/H.265 video stream to the CDN live client. Maximum length: 4096 Bytes. + + For more information on SEI frame, see [SEI-related questions](https://docs.agora.io/en/faq/sei). + */ + const char* transcodingExtraInfo; + + /** **DEPRECATED** The metadata sent to the CDN live client defined by the RTMP or HTTP-FLV metadata. + */ + const char* metadata; + /** The watermark image added to the CDN live publishing stream. + + Ensure that the format of the image is PNG. Once a watermark image is added, the audience of the CDN live publishing stream can see the watermark image. See RtcImage. + */ + RtcImage* watermark; + /** The background image added to the CDN live publishing stream. - /** Camera capturer configuration. + Once a background image is added, the audience of the CDN live publishing stream can see the background image. See RtcImage. */ - struct CameraCapturerConfiguration{ + RtcImage* backgroundImage; + /** Self-defined audio-sample rate: #AUDIO_SAMPLE_RATE_TYPE. + */ + AUDIO_SAMPLE_RATE_TYPE audioSampleRate; + /** Bitrate of the CDN live audio output stream. The default value is 48 Kbps, and the highest value is 128. + */ + int audioBitrate; + /** The numbder of audio channels for the CDN live stream. Agora recommends choosing 1 (mono), or 2 (stereo) audio channels. Special players are required if you choose option 3, 4, or 5: + + - 1: (Default) Mono. + - 2: Stereo. + - 3: Three audio channels. + - 4: Four audio channels. + - 5: Five audio channels. + */ + int audioChannels; + /** Self-defined audio codec profile: #AUDIO_CODEC_PROFILE_TYPE. + */ + + AUDIO_CODEC_PROFILE_TYPE audioCodecProfile; + /// @cond + /** Advanced features of the RTMP or RTMPS streaming with transcoding. See LiveStreamAdvancedFeature. + * + * @since v3.1.0 + */ + LiveStreamAdvancedFeature* advancedFeatures; + + /** The number of enabled advanced features. The default value is 0. */ + unsigned int advancedFeatureCount; + /// @endcond + LiveTranscoding() : width(360), height(640), videoBitrate(400), videoFramerate(15), lowLatency(false), videoGop(30), videoCodecProfile(VIDEO_CODEC_PROFILE_HIGH), backgroundColor(0x000000), videoCodecType(VIDEO_CODEC_H264_FOR_STREAM), userCount(0), transcodingUsers(NULL), transcodingExtraInfo(NULL), metadata(NULL), watermark(NULL), backgroundImage(NULL), audioSampleRate(AUDIO_SAMPLE_RATE_48000), audioBitrate(48), audioChannels(1), audioCodecProfile(AUDIO_CODEC_PROFILE_LC_AAC), advancedFeatures(NULL), advancedFeatureCount(0) {} +} LiveTranscoding; + +/** Camera capturer configuration. + */ +struct CameraCapturerConfiguration { + /** Camera capturer preference settings. See: #CAPTURER_OUTPUT_PREFERENCE. */ + CAPTURER_OUTPUT_PREFERENCE preference; + /** The width (px) of the video image captured by the local camera. + * To customize the width of the video image, set `preference` as #CAPTURER_OUTPUT_PREFERENCE_MANUAL (3) first, + * and then use `captureWidth`. + * + * @since v3.3.0 + */ + int captureWidth; + /** The height (px) of the video image captured by the local camera. + * To customize the height of the video image, set `preference` as #CAPTURER_OUTPUT_PREFERENCE_MANUAL (3) first, + * and then use `captureHeight`. + * + * @since v3.3.0 + */ + int captureHeight; +#if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) + /** Camera direction settings (for Android/iOS only). See: #CAMERA_DIRECTION. */ + CAMERA_DIRECTION cameraDirection; +#endif - /** Camera capturer preference settings. See: #CAPTURER_OUTPUT_PREFERENCE. */ - CAPTURER_OUTPUT_PREFERENCE preference; - #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) - /** Camera direction settings (for Android/iOS only). See: #CAMERA_DIRECTION. */ - CAMERA_DIRECTION cameraDirection; - #endif - }; + CameraCapturerConfiguration() : preference(CAPTURER_OUTPUT_PREFERENCE_AUTO), captureWidth(640), captureHeight(480) {} + CameraCapturerConfiguration(int width, int height) : preference(CAPTURER_OUTPUT_PREFERENCE_MANUAL), captureWidth(width), captureHeight(height) {} +}; +/** The configurations for the data stream. + * + * @since v3.3.0 + * + * |`syncWithAudio` |`ordered`| SDK behaviors| + * |--------------|--------|-------------| + * | false | false |The SDK triggers the `onStreamMessage` callback immediately after the receiver receives a data packet | + * | true | false |

If the data packet delay is within the audio delay, the SDK triggers the `onStreamMessage` callback when the synchronized audio packet is played out.

If the data packet delay exceeds the audio delay, the SDK triggers the `onStreamMessage` callback as soon as the data packet is received. In this case, the data packet is not synchronized with the audio packet.

| + * | false | true |

If the delay of a data packet is within five seconds, the SDK corrects the order of the data packet.

If the delay of a data packet exceeds five seconds, the SDK discards the data packet.

| + * | true | true |

If the delay of a data packet is within the audio delay, the SDK corrects the order of the data packet.

If the delay of a data packet exceeds the audio delay, the SDK discards this data packet.

| + */ +struct DataStreamConfig { + /** Whether to synchronize the data packet with the published audio packet. + * + * - true: Synchronize the data packet with the audio packet. + * - false: Do not synchronize the data packet with the audio packet. + * + * When you set the data packet to synchronize with the audio, then if the data + * packet delay is within the audio delay, the SDK triggers the `onStreamMessage` callback when + * the synchronized audio packet is played out. Do not set this parameter as `true` if you + * need the receiver to receive the data packet immediately. Agora recommends that you set + * this parameter to `true` only when you need to implement specific functions, for example + * lyric synchronization. + */ + bool syncWithAudio; + /** Whether the SDK guarantees that the receiver receives the data in the sent order. + * + * - true: Guarantee that the receiver receives the data in the sent order. + * - false: Do not guarantee that the receiver receives the data in the sent order. + * + * Do not set this parameter to `true` if you need the receiver to receive the data immediately. + */ + bool ordered; +}; /** Configuration of the injected media stream. */ struct InjectStreamConfig { - /** Width of the injected stream in the live interactive streaming. The default value is 0 (same width as the original stream). - */ - int width; - /** Height of the injected stream in the live interactive streaming. The default value is 0 (same height as the original stream). - */ - int height; - /** Video GOP (in frames) of the injected stream in the live interactive streaming. The default value is 30 fps. - */ - int videoGop; - /** Video frame rate of the injected stream in the live interactive streaming. The default value is 15 fps. - */ - int videoFramerate; - /** Video bitrate of the injected stream in the live interactive streaming. The default value is 400 Kbps. + /** Width of the injected stream in the interactive live streaming. The default value is 0 (same width as the original stream). + */ + int width; + /** Height of the injected stream in the interactive live streaming. The default value is 0 (same height as the original stream). + */ + int height; + /** Video GOP (in frames) of the injected stream in the interactive live streaming. The default value is 30 fps. + */ + int videoGop; + /** Video frame rate of the injected stream in the interactive live streaming. The default value is 15 fps. + */ + int videoFramerate; + /** Video bitrate of the injected stream in the interactive live streaming. The default value is 400 Kbps. - @note The setting of the video bitrate is closely linked to the resolution. If the video bitrate you set is beyond a reasonable range, the SDK sets it within a reasonable range. - */ - int videoBitrate; - /** Audio-sample rate of the injected stream in the live interactive streaming: #AUDIO_SAMPLE_RATE_TYPE. The default value is 48000 Hz. + @note The setting of the video bitrate is closely linked to the resolution. If the video bitrate you set is beyond a reasonable range, the SDK sets it within a reasonable range. + */ + int videoBitrate; + /** Audio-sample rate of the injected stream in the interactive live streaming: #AUDIO_SAMPLE_RATE_TYPE. The default value is 48000 Hz. - @note We recommend setting the default value. - */ - AUDIO_SAMPLE_RATE_TYPE audioSampleRate; - /** Audio bitrate of the injected stream in the live interactive streaming. The default value is 48. + @note We recommend setting the default value. + */ + AUDIO_SAMPLE_RATE_TYPE audioSampleRate; + /** Audio bitrate of the injected stream in the interactive live streaming. The default value is 48. + + @note We recommend setting the default value. + */ + int audioBitrate; + /** Audio channels in the interactive live streaming. - @note We recommend setting the default value. - */ - int audioBitrate; - /** Audio channels in the live interactive streaming. + - 1: (Default) Mono + - 2: Two-channel stereo - - 1: (Default) Mono - - 2: Two-channel stereo + @note We recommend setting the default value. + */ + int audioChannels; - @note We recommend setting the default value. - */ - int audioChannels; - - // width / height default set to 0 means pull the stream with its original resolution - InjectStreamConfig() - : width(0) - , height(0) - , videoGop(30) - , videoFramerate(15) - , videoBitrate(400) - , audioSampleRate(AUDIO_SAMPLE_RATE_48000) - , audioBitrate(48) - , audioChannels(1) - {} + // width / height default set to 0 means pull the stream with its original resolution + InjectStreamConfig() : width(0), height(0), videoGop(30), videoFramerate(15), videoBitrate(400), audioSampleRate(AUDIO_SAMPLE_RATE_48000), audioBitrate(48), audioChannels(1) {} }; /** The definition of ChannelMediaInfo. */ struct ChannelMediaInfo { - /** The channel name. - */ - const char* channelName; - /** The token that enables the user to join the channel. - */ - const char* token; - /** The user ID. - */ - uid_t uid; + /** The channel name. + */ + const char* channelName; + /** The token that enables the user to join the channel. + */ + const char* token; + /** The user ID. + */ + uid_t uid; }; /** The definition of ChannelMediaRelayConfiguration. */ struct ChannelMediaRelayConfiguration { - /** Pointer to the information of the source channel: ChannelMediaInfo. It contains the following members: - * - `channelName`: The name of the source channel. The default value is `NULL`, which means the SDK applies the name of the current channel. - * - `uid`: The unique ID to identify the relay stream in the source channel. The default value is 0, which means the SDK generates a random UID. You must set it as 0. - * - `token`: The token for joining the source channel. It is generated with the `channelName` and `uid` you set in `srcInfo`. - * - If you have not enabled the App Certificate, set this parameter as the default value `NULL`, which means the SDK applies the App ID. - * - If you have enabled the App Certificate, you must use the `token` generated with the `channelName` and `uid`, and the `uid` must be set as 0. - */ - ChannelMediaInfo *srcInfo; - /** Pointer to the information of the destination channel: ChannelMediaInfo. It contains the following members: - * - `channelName`: The name of the destination channel. - * - `uid`: The unique ID to identify the relay stream in the destination channel. The value ranges from 0 to (232-1). - * To avoid UID conflicts, this `uid` must be different from any other UIDs in the destination channel. The default - * value is 0, which means the SDK generates a random UID. Do not set this parameter as the `uid` of the host in - * the destination channel, and ensure that this `uid` is different from any other `uid` in the channel. - * - `token`: The token for joining the destination channel. It is generated with the `channelName` and `uid` you set in `destInfos`. - * - If you have not enabled the App Certificate, set this parameter as the default value `NULL`, which means the SDK applies the App ID. - * - If you have enabled the App Certificate, you must use the `token` generated with the `channelName` and `uid`. - */ - ChannelMediaInfo *destInfos; - /** The number of destination channels. The default value is 0, and the - * value range is [0,4). Ensure that the value of this parameter - * corresponds to the number of ChannelMediaInfo structs you define in - * `destInfos`. - */ - int destCount; + /** Pointer to the information of the source channel: ChannelMediaInfo. It contains the following members: + * - `channelName`: The name of the source channel. The default value is `NULL`, which means the SDK applies the name of the current channel. + * - `uid`: The unique ID to identify the relay stream in the source channel. The default value is 0, which means the SDK generates a random UID. You must set it as 0. + * - `token`: The token for joining the source channel. It is generated with the `channelName` and `uid` you set in `srcInfo`. + * - If you have not enabled the App Certificate, set this parameter as the default value `NULL`, which means the SDK applies the App ID. + * - If you have enabled the App Certificate, you must use the `token` generated with the `channelName` and `uid`, and the `uid` must be set as 0. + */ + ChannelMediaInfo* srcInfo; + /** Pointer to the information of the destination channel: ChannelMediaInfo. It contains the following members: + * - `channelName`: The name of the destination channel. + * - `uid`: The unique ID to identify the relay stream in the destination channel. The value ranges from 0 to (232-1). + * To avoid UID conflicts, this `uid` must be different from any other UIDs in the destination channel. The default + * value is 0, which means the SDK generates a random UID. Do not set this parameter as the `uid` of the host in + * the destination channel, and ensure that this `uid` is different from any other `uid` in the channel. + * - `token`: The token for joining the destination channel. It is generated with the `channelName` and `uid` you set in `destInfos`. + * - If you have not enabled the App Certificate, set this parameter as the default value `NULL`, which means the SDK applies the App ID. + * - If you have enabled the App Certificate, you must use the `token` generated with the `channelName` and `uid`. + */ + ChannelMediaInfo* destInfos; + /** The number of destination channels. The default value is 0, and the + * value range is [0,4]. Ensure that the value of this parameter + * corresponds to the number of ChannelMediaInfo structs you define in + * `destInfos`. + */ + int destCount; - ChannelMediaRelayConfiguration() - : srcInfo(nullptr) - , destInfos(nullptr) - , destCount(0) - {} + ChannelMediaRelayConfiguration() : srcInfo(nullptr), destInfos(nullptr), destCount(0) {} }; /** **DEPRECATED** Lifecycle of the CDN live video stream. -*/ -enum RTMP_STREAM_LIFE_CYCLE_TYPE -{ + */ +enum RTMP_STREAM_LIFE_CYCLE_TYPE { /** Bind to the channel lifecycle. If all hosts leave the channel, the CDN live streaming stops after 30 seconds. - */ - RTMP_STREAM_LIFE_CYCLE_BIND2CHANNEL = 1, + */ + RTMP_STREAM_LIFE_CYCLE_BIND2CHANNEL = 1, /** Bind to the owner of the RTMP stream. If the owner leaves the channel, the CDN live streaming stops immediately. - */ - RTMP_STREAM_LIFE_CYCLE_BIND2OWNER = 2, + */ + RTMP_STREAM_LIFE_CYCLE_BIND2OWNER = 2, }; /** Content hints for screen sharing. -*/ -enum VideoContentHint -{ - /** (Default) No content hint. - */ - CONTENT_HINT_NONE, - /** Motion-intensive content. Choose this option if you prefer smoothness or when you are sharing a video clip, movie, or video game. - */ - CONTENT_HINT_MOTION, - /** Motionless content. Choose this option if you prefer sharpness or when you are sharing a picture, PowerPoint slide, or text. - */ - CONTENT_HINT_DETAILS + */ +enum VideoContentHint { + /** (Default) No content hint. + */ + CONTENT_HINT_NONE, + /** Motion-intensive content. Choose this option if you prefer smoothness or when you are sharing a video clip, movie, or video game. + */ + CONTENT_HINT_MOTION, + /** Motionless content. Choose this option if you prefer sharpness or when you are sharing a picture, PowerPoint slide, or text. + */ + CONTENT_HINT_DETAILS }; /** The relative location of the region to the screen or window. */ -struct Rectangle -{ - /** The horizontal offset from the top-left corner. - */ - int x; - /** The vertical offset from the top-left corner. - */ - int y; - /** The width of the region. - */ - int width; - /** The height of the region. - */ - int height; - - Rectangle(): x(0), y(0), width(0), height(0) {} - Rectangle(int xx, int yy, int ww, int hh): x(xx), y(yy), width(ww), height(hh) {} +struct Rectangle { + /** The horizontal offset from the top-left corner. + */ + int x; + /** The vertical offset from the top-left corner. + */ + int y; + /** The width of the region. + */ + int width; + /** The height of the region. + */ + int height; + + Rectangle() : x(0), y(0), width(0), height(0) {} + Rectangle(int xx, int yy, int ww, int hh) : x(xx), y(yy), width(ww), height(hh) {} }; /** **DEPRECATED** Definition of the rectangular region. */ typedef struct Rect { - /** Y-axis of the top line. - */ - int top; - /** X-axis of the left line. - */ - int left; - /** Y-axis of the bottom line. - */ - int bottom; - /** X-axis of the right line. - */ - int right; + /** Y-axis of the top line. + */ + int top; + /** X-axis of the left line. + */ + int left; + /** Y-axis of the bottom line. + */ + int bottom; + /** X-axis of the right line. + */ + int right; - Rect(): top(0), left(0), bottom(0), right(0) {} - Rect(int t, int l, int b, int r): top(t), left(l), bottom(b), right(r) {} + Rect() : top(0), left(0), bottom(0), right(0) {} + Rect(int t, int l, int b, int r) : top(t), left(l), bottom(b), right(r) {} } Rect; /** The options of the watermark image to be added. */ typedef struct WatermarkOptions { - /** Sets whether or not the watermark image is visible in the local video preview: - * - true: (Default) The watermark image is visible in preview. - * - false: The watermark image is not visible in preview. - */ - bool visibleInPreview; - /** - * The watermark position in the landscape mode. See Rectangle. - * For detailed information on the landscape mode, see the advanced guide *Video Rotation*. - */ - Rectangle positionInLandscapeMode; - /** - * The watermark position in the portrait mode. See Rectangle. - * For detailed information on the portrait mode, see the advanced guide *Video Rotation*. - */ - Rectangle positionInPortraitMode; + /** Sets whether or not the watermark image is visible in the local video preview: + * - true: (Default) The watermark image is visible in preview. + * - false: The watermark image is not visible in preview. + */ + bool visibleInPreview; + /** + * The watermark position in the landscape mode. See Rectangle. + * For detailed information on the landscape mode, see the advanced guide *Video Rotation*. + */ + Rectangle positionInLandscapeMode; + /** + * The watermark position in the portrait mode. See Rectangle. + * For detailed information on the portrait mode, see the advanced guide *Video Rotation*. + */ + Rectangle positionInPortraitMode; - WatermarkOptions() - : visibleInPreview(true) - , positionInLandscapeMode(0, 0, 0, 0) - , positionInPortraitMode(0, 0, 0, 0) - {} + WatermarkOptions() : visibleInPreview(true), positionInLandscapeMode(0, 0, 0, 0), positionInPortraitMode(0, 0, 0, 0) {} } WatermarkOptions; /** Screen sharing encoding parameters. -*/ -struct ScreenCaptureParameters -{ - /** The maximum encoding dimensions of the shared region in terms of width * height. + */ +struct ScreenCaptureParameters { + /** The maximum encoding dimensions of the shared region in terms of width * height. - The default value is 1920 * 1080 pixels, that is, 2073600 pixels. Agora uses the value of this parameter to calculate the charges. + The default value is 1920 * 1080 pixels, that is, 2073600 pixels. Agora uses the value of this parameter to calculate the charges. - If the aspect ratio is different between the encoding dimensions and screen dimensions, Agora applies the following algorithms for encoding. Suppose the encoding dimensions are 1920 x 1080: + If the aspect ratio is different between the encoding dimensions and screen dimensions, Agora applies the following algorithms for encoding. Suppose the encoding dimensions are 1920 x 1080: - - If the value of the screen dimensions is lower than that of the encoding dimensions, for example, 1000 * 1000, the SDK uses 1000 * 1000 for encoding. - - If the value of the screen dimensions is higher than that of the encoding dimensions, for example, 2000 * 1500, the SDK uses the maximum value under 1920 * 1080 with the aspect ratio of the screen dimension (4:3) for encoding, that is, 1440 * 1080. - */ - VideoDimensions dimensions; - /** The frame rate (fps) of the shared region. + - If the value of the screen dimensions is lower than that of the encoding dimensions, for example, 1000 * 1000, the SDK uses 1000 * 1000 for encoding. + - If the value of the screen dimensions is higher than that of the encoding dimensions, for example, 2000 * 1500, the SDK uses the maximum value under 1920 * 1080 with the aspect ratio of the screen dimension (4:3) for encoding, that is, 1440 * 1080. + */ + VideoDimensions dimensions; + /** The frame rate (fps) of the shared region. - The default value is 5. We do not recommend setting this to a value greater than 15. - */ - int frameRate; - /** The bitrate (Kbps) of the shared region. + The default value is 5. We do not recommend setting this to a value greater than 15. + */ + int frameRate; + /** The bitrate (Kbps) of the shared region. - The default value is 0 (the SDK works out a bitrate according to the dimensions of the current screen). - */ - int bitrate; - /** Sets whether or not to capture the mouse for screen sharing: + The default value is 0 (the SDK works out a bitrate according to the dimensions of the current screen). + */ + int bitrate; + /** Sets whether to capture the mouse for screen sharing: - - true: (Default) Capture the mouse. - - false: Do not capture the mouse. - */ - bool captureMouseCursor; - /** Whether to bring the window to the front when calling \ref IRtcEngine::startScreenCaptureByWindowId "startScreenCaptureByWindowId" to share the window: - * - true: Bring the window to the front. - * - false: (Default) Do not bring the window to the front. - */ - bool windowFocus; - /** A list of IDs of windows to be blocked. - * - * When calling \ref IRtcEngine::startScreenCaptureByScreenRect "startScreenCaptureByScreenRect" to start screen sharing, you can use this parameter to block the specified windows. - * When calling \ref IRtcEngine::updateScreenCaptureParameters "updateScreenCaptureParameters" to update the configuration for screen sharing, you can use this parameter to dynamically block the specified windows during screen sharing. - */ - view_t* excludeWindowList; - /** The number of windows to be blocked. - */ - int excludeWindowCount; + - true: (Default) Capture the mouse. + - false: Do not capture the mouse. + */ + bool captureMouseCursor; + /** Whether to bring the window to the front when calling \ref IRtcEngine::startScreenCaptureByWindowId "startScreenCaptureByWindowId" to share the window: + * - true: Bring the window to the front. + * - false: (Default) Do not bring the window to the front. + */ + bool windowFocus; + /** A list of IDs of windows to be blocked. + * + * When calling \ref IRtcEngine::startScreenCaptureByScreenRect "startScreenCaptureByScreenRect" to start screen sharing, you can use this parameter to block the specified windows. + * When calling \ref IRtcEngine::updateScreenCaptureParameters "updateScreenCaptureParameters" to update the configuration for screen sharing, you can use this parameter to dynamically block the specified windows during screen sharing. + */ + view_t* excludeWindowList; + /** The number of windows to be blocked. + */ + int excludeWindowCount; - ScreenCaptureParameters() : dimensions(1920, 1080), frameRate(5), bitrate(STANDARD_BITRATE), captureMouseCursor(true), windowFocus(false), excludeWindowList(NULL), excludeWindowCount(0) {} - ScreenCaptureParameters(const VideoDimensions& d, int f, int b, bool c, bool focus, view_t *ex = NULL, int cnt = 0) : dimensions(d), frameRate(f), bitrate(b), captureMouseCursor(c), windowFocus(focus), excludeWindowList(ex), excludeWindowCount(cnt) {} - ScreenCaptureParameters(int width, int height, int f, int b, bool c, bool focus, view_t *ex = NULL, int cnt = 0) : dimensions(width, height), frameRate(f), bitrate(b), captureMouseCursor(c), windowFocus(focus), excludeWindowList(ex), excludeWindowCount(cnt) {} + ScreenCaptureParameters() : dimensions(1920, 1080), frameRate(5), bitrate(STANDARD_BITRATE), captureMouseCursor(true), windowFocus(false), excludeWindowList(NULL), excludeWindowCount(0) {} + ScreenCaptureParameters(const VideoDimensions& d, int f, int b, bool c, bool focus, view_t* ex = NULL, int cnt = 0) : dimensions(d), frameRate(f), bitrate(b), captureMouseCursor(c), windowFocus(focus), excludeWindowList(ex), excludeWindowCount(cnt) {} + ScreenCaptureParameters(int width, int height, int f, int b, bool c, bool focus, view_t* ex = NULL, int cnt = 0) : dimensions(width, height), frameRate(f), bitrate(b), captureMouseCursor(c), windowFocus(focus), excludeWindowList(ex), excludeWindowCount(cnt) {} }; /** Video display settings of the VideoCanvas class. -*/ -struct VideoCanvas -{ - /** Video display window (view). - */ - view_t view; - /** The rendering mode of the video view. See #RENDER_MODE_TYPE - */ - int renderMode; - /** The unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are: - - All lowercase English letters: a to z. - - All uppercase English letters: A to Z. - - All numeric characters: 0 to 9. - - The space character. - - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". - - @note - - The default value is the empty string "". Use the default value if the user joins the channel using the \ref IRtcEngine::joinChannel "joinChannel" method in the IRtcEngine class. The `VideoCanvas` struct defines the video canvas of the user in the channel. - - If the user joins the channel using the \ref IRtcEngine::joinChannel "joinChannel" method in the IChannel class, set this parameter as the `channelId` of the `IChannel` object. The `VideoCanvas` struct defines the video canvas of the user in the channel with the specified channel ID. - */ - char channelId[MAX_CHANNEL_ID_LENGTH]; - /** The user ID. */ - uid_t uid; - void *priv; // private data (underlying video engine denotes it) - /** The mirror mode of the video view. See VIDEO_MIRROR_MODE_TYPE - @note - - For the mirror mode of the local video view: If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default. - - For the mirror mode of the remote video view: The SDK disables the mirror mode by default. - */ - VIDEO_MIRROR_MODE_TYPE mirrorMode; - - VideoCanvas() - : view(NULL) - , renderMode(RENDER_MODE_HIDDEN) - , uid(0) - , priv(NULL) - , mirrorMode(VIDEO_MIRROR_MODE_AUTO) - { - channelId[0] = '\0'; - } - VideoCanvas(view_t v, int m, uid_t u) - : view(v) - , renderMode(m) - , uid(u) - , priv(NULL) - , mirrorMode(VIDEO_MIRROR_MODE_AUTO) - { - channelId[0] = '\0'; - } - VideoCanvas(view_t v, int m, const char *ch, uid_t u) - : view(v) - , renderMode(m) - , uid(u) - , priv(NULL) - , mirrorMode(VIDEO_MIRROR_MODE_AUTO) - { - strncpy(channelId, ch, MAX_CHANNEL_ID_LENGTH); - channelId[MAX_CHANNEL_ID_LENGTH - 1] = '\0'; - } - VideoCanvas(view_t v, int rm, uid_t u, VIDEO_MIRROR_MODE_TYPE mm) - : view(v) - , renderMode(rm) - , uid(u) - , priv(NULL) - , mirrorMode(mm) - { - channelId[0] = '\0'; - } - VideoCanvas(view_t v, int rm, const char *ch, uid_t u, VIDEO_MIRROR_MODE_TYPE mm) - : view(v) - , renderMode(rm) - , uid(u) - , priv(NULL) - , mirrorMode(mm) - { - strncpy(channelId, ch, MAX_CHANNEL_ID_LENGTH); - channelId[MAX_CHANNEL_ID_LENGTH - 1] = '\0'; - } + */ +struct VideoCanvas { + /** Video display window (view). + */ + view_t view; + /** The rendering mode of the video view. See #RENDER_MODE_TYPE + */ + int renderMode; + /** The unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are: + - All lowercase English letters: a to z. + - All uppercase English letters: A to Z. + - All numeric characters: 0 to 9. + - The space character. + - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". + + @note + - The default value is the empty string "". Use the default value if the user joins the channel using the \ref IRtcEngine::joinChannel "joinChannel" method in the IRtcEngine class. The `VideoCanvas` struct defines the video canvas of the user in the channel. + - If the user joins the channel using the \ref IRtcEngine::joinChannel "joinChannel" method in the IChannel class, set this parameter as the `channelId` of the `IChannel` object. The `VideoCanvas` struct defines the video canvas of the user in the channel with the specified channel ID. + */ + char channelId[MAX_CHANNEL_ID_LENGTH]; + /** The user ID. */ + uid_t uid; + void* priv; // private data (underlying video engine denotes it) + /** The mirror mode of the video view. See VIDEO_MIRROR_MODE_TYPE + @note + - For the mirror mode of the local video view: If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default. + - For the mirror mode of the remote video view: The SDK disables the mirror mode by default. + */ + VIDEO_MIRROR_MODE_TYPE mirrorMode; + + VideoCanvas() : view(NULL), renderMode(RENDER_MODE_HIDDEN), uid(0), priv(NULL), mirrorMode(VIDEO_MIRROR_MODE_AUTO) { channelId[0] = '\0'; } + VideoCanvas(view_t v, int m, uid_t u) : view(v), renderMode(m), uid(u), priv(NULL), mirrorMode(VIDEO_MIRROR_MODE_AUTO) { channelId[0] = '\0'; } + VideoCanvas(view_t v, int m, const char* ch, uid_t u) : view(v), renderMode(m), uid(u), priv(NULL), mirrorMode(VIDEO_MIRROR_MODE_AUTO) { + strncpy(channelId, ch, MAX_CHANNEL_ID_LENGTH); + channelId[MAX_CHANNEL_ID_LENGTH - 1] = '\0'; + } + VideoCanvas(view_t v, int rm, uid_t u, VIDEO_MIRROR_MODE_TYPE mm) : view(v), renderMode(rm), uid(u), priv(NULL), mirrorMode(mm) { channelId[0] = '\0'; } + VideoCanvas(view_t v, int rm, const char* ch, uid_t u, VIDEO_MIRROR_MODE_TYPE mm) : view(v), renderMode(rm), uid(u), priv(NULL), mirrorMode(mm) { + strncpy(channelId, ch, MAX_CHANNEL_ID_LENGTH); + channelId[MAX_CHANNEL_ID_LENGTH - 1] = '\0'; + } }; /** Image enhancement options. -*/ + */ struct BeautyOptions { - /** The contrast level, used with the @p lightening parameter. - */ - enum LIGHTENING_CONTRAST_LEVEL - { - /** Low contrast level. */ - LIGHTENING_CONTRAST_LOW = 0, - /** (Default) Normal contrast level. */ - LIGHTENING_CONTRAST_NORMAL, - /** High contrast level. */ - LIGHTENING_CONTRAST_HIGH - }; - -/** The contrast level, used with the @p lightening parameter. -*/ -LIGHTENING_CONTRAST_LEVEL lighteningContrastLevel; + /** The contrast level, used with the @p lightening parameter. + */ + enum LIGHTENING_CONTRAST_LEVEL { + /** Low contrast level. */ + LIGHTENING_CONTRAST_LOW = 0, + /** (Default) Normal contrast level. */ + LIGHTENING_CONTRAST_NORMAL, + /** High contrast level. */ + LIGHTENING_CONTRAST_HIGH + }; + + /** The contrast level, used with the @p lightening parameter. + */ + LIGHTENING_CONTRAST_LEVEL lighteningContrastLevel; -/** The brightness level. The value ranges from 0.0 (original) to 1.0. */ -float lighteningLevel; + /** The brightness level. The value ranges from 0.0 (original) to 1.0. */ + float lighteningLevel; -/** The sharpness level. The value ranges between 0 (original) and 1. This parameter is usually used to remove blemishes. + /** The sharpness level. The value ranges between 0 (original) and 1. This parameter is usually used to remove blemishes. + */ + float smoothnessLevel; + + /** The redness level. The value ranges between 0 (original) and 1. This parameter adjusts the red saturation level. + */ + float rednessLevel; + + BeautyOptions(LIGHTENING_CONTRAST_LEVEL contrastLevel, float lightening, float smoothness, float redness) : lighteningLevel(lightening), smoothnessLevel(smoothness), rednessLevel(redness), lighteningContrastLevel(contrastLevel) {} + + BeautyOptions() : lighteningLevel(0), smoothnessLevel(0), rednessLevel(0), lighteningContrastLevel(LIGHTENING_CONTRAST_NORMAL) {} +}; + +/** Background substitutoin meta data. */ -float smoothnessLevel; +struct VirtualBackgroundSource { + /** The source used to substitude image background(foreground is portrait area). + */ + enum BACKGROUND_SOURCE_TYPE { + /** Background source is pure color*/ + BACKGROUND_COLOR = 1, + /** Background source is image path, only support png and jpg format*/ + BACKGROUND_IMG, + }; + + /** The source type used to substitude capture image background. + */ + BACKGROUND_SOURCE_TYPE background_source_type; -/** The redness level. The value ranges between 0 (original) and 1. This parameter adjusts the red saturation level. -*/ -float rednessLevel; - -BeautyOptions(LIGHTENING_CONTRAST_LEVEL contrastLevel, float lightening, float smoothness, float redness) - : lighteningLevel(lightening), - smoothnessLevel(smoothness), - rednessLevel(redness), - lighteningContrastLevel(contrastLevel) {} - -BeautyOptions() - : lighteningLevel(0), - smoothnessLevel(0), - rednessLevel(0), - lighteningContrastLevel(LIGHTENING_CONTRAST_NORMAL) {} + /** The background color in RGB hex value. Value only. Do not include a preceeding #. For example, 0xFFB6C1 (light pink). The default value is 0xffffff (white). + */ + unsigned int color; + + /** image file path */ + const char* source; + + VirtualBackgroundSource() : color(0xffffff), source(NULL), background_source_type(BACKGROUND_COLOR) {} }; /** @@ -3007,6031 +3327,6628 @@ struct UserInfo { * The user account. */ char userAccount[MAX_USER_ACCOUNT_LENGTH]; - UserInfo() - : uid(0) { - userAccount[0] = '\0'; - } + UserInfo() : uid(0) { userAccount[0] = '\0'; } }; /** * Regions for connetion. */ enum AREA_CODE { - /** - * Mainland China. - */ - AREA_CODE_CN = 0x00000001, - /** - * North America. - */ - AREA_CODE_NA = 0x00000002, - /** - * Europe. - */ - AREA_CODE_EU = 0x00000004, - /** - * Asia, excluding Mainland China. - */ - AREA_CODE_AS = 0x00000008, - /** - * Japan. - */ - AREA_CODE_JP = 0x00000010, - /** - * India. - */ - AREA_CODE_IN = 0x00000020, - /** - * (Default) Global. - */ - AREA_CODE_GLOB = 0xFFFFFFFF + /** + * Mainland China. + */ + AREA_CODE_CN = 0x00000001, + /** + * North America. + */ + AREA_CODE_NA = 0x00000002, + /** + * Europe. + */ + AREA_CODE_EU = 0x00000004, + /** + * Asia, excluding Mainland China. + */ + AREA_CODE_AS = 0x00000008, + /** + * Japan. + */ + AREA_CODE_JP = 0x00000010, + /** + * India. + */ + AREA_CODE_IN = 0x00000020, + /** + * (Default) Global. + */ + AREA_CODE_GLOB = 0xFFFFFFFF }; enum ENCRYPTION_CONFIG { - /** - * - 1: Force set master key and mode; - * - 0: Not force set, checking whether encryption plugin exists - */ - ENCRYPTION_FORCE_SETTING = (1 << 0), - /** - * - 1: Force not encrypting packet; - * - 0: Not force encrypting; - */ - ENCRYPTION_FORCE_DISABLE_PACKET = (1 << 1) + /** + * - 1: Force set master key and mode; + * - 0: Not force set, checking whether encryption plugin exists + */ + ENCRYPTION_FORCE_SETTING = (1 << 0), + /** + * - 1: Force not encrypting packet; + * - 0: Not force encrypting; + */ + ENCRYPTION_FORCE_DISABLE_PACKET = (1 << 1) }; /** Definition of IPacketObserver. -*/ -class IPacketObserver -{ -public: -/** Definition of Packet. */ - struct Packet - { - /** Buffer address of the sent or received data. - * @note Agora recommends that the value of buffer is more than 2048 bytes, otherwise, you may meet undefined behaviors such as a crash. - */ - const unsigned char* buffer; - /** Buffer size of the sent or received data. - */ - unsigned int size; - }; - /** Occurs when the local user sends an audio packet. - - @param packet The sent audio packet. See Packet. - @return - - true: The audio packet is sent successfully. - - false: The audio packet is discarded. +class IPacketObserver { + public: + /** Definition of Packet. + */ + struct Packet { + /** Buffer address of the sent or received data. + * + * @note Agora recommends that the value of buffer is more than 2048 bytes, + * otherwise, you may meet undefined behaviors such as a crash. */ - virtual bool onSendAudioPacket(Packet& packet) = 0; - /** Occurs when the local user sends a video packet. - - @param packet The sent video packet. See Packet. - @return - - true: The video packet is sent successfully. - - false: The video packet is discarded. + const unsigned char* buffer; + /** Buffer size of the sent or received data. */ - virtual bool onSendVideoPacket(Packet& packet) = 0; - /** Occurs when the local user receives an audio packet. + unsigned int size; + }; + /** Occurs when the local user sends an audio packet. - @param packet The received audio packet. See Packet. - @return - - true: The audio packet is received successfully. - - false: The audio packet is discarded. - */ - virtual bool onReceiveAudioPacket(Packet& packet) = 0; - /** Occurs when the local user receives a video packet. + @param packet The sent audio packet. See Packet. + @return + - true: The audio packet is sent successfully. + - false: The audio packet is discarded. + */ + virtual bool onSendAudioPacket(Packet& packet) = 0; + /** Occurs when the local user sends a video packet. - @param packet The received video packet. See Packet. - @return - - true: The video packet is received successfully. - - false: The video packet is discarded. - */ - virtual bool onReceiveVideoPacket(Packet& packet) = 0; -}; + @param packet The sent video packet. See Packet. + @return + - true: The video packet is sent successfully. + - false: The video packet is discarded. + */ + virtual bool onSendVideoPacket(Packet& packet) = 0; + /** Occurs when the local user receives an audio packet. + + @param packet The received audio packet. See Packet. + @return + - true: The audio packet is received successfully. + - false: The audio packet is discarded. + */ + virtual bool onReceiveAudioPacket(Packet& packet) = 0; + /** Occurs when the local user receives a video packet. + @param packet The received video packet. See Packet. + @return + - true: The video packet is received successfully. + - false: The video packet is discarded. + */ + virtual bool onReceiveVideoPacket(Packet& packet) = 0; +}; #if defined(_WIN32) /** The capture type of the custom video source. */ enum VIDEO_CAPTURE_TYPE { - /** Unknown type. - */ - VIDEO_CAPTURE_UNKNOWN, - /** (Default) Video captured by the camera. - */ - VIDEO_CAPTURE_CAMERA, - /** Video for screen sharing. - */ - VIDEO_CAPTURE_SCREEN, + /** Unknown type. + */ + VIDEO_CAPTURE_UNKNOWN, + /** (Default) Video captured by the camera. + */ + VIDEO_CAPTURE_CAMERA, + /** Video for screen sharing. + */ + VIDEO_CAPTURE_SCREEN, }; /** The IVideoFrameConsumer class. The SDK uses it to receive the video frame that you capture. */ class IVideoFrameConsumer { -public: - /** Receives the raw video frame. - * - * @note Ensure that the video frame type that you specify in this method is the same as that in the \ref agora::rtc::IVideoSource::getBufferType "getBufferType" callback. - * - * @param buffer The video buffer. - * @param frameType The video frame type. See \ref agora::media::ExternalVideoFrame::VIDEO_PIXEL_FORMAT "VIDEO_PIXEL_FORMAT". - * @param width The width (px) of the video frame. - * @param height The height (px) of the video frame. - * @param rotation The angle (degree) at which the video frame rotates clockwise. If you set the rotation angle, the - * SDK rotates the video frame after receiving it. You can set the rotation angle as `0`, `90`, `180`, and `270`. - * @param timestamp The Unix timestamp (ms) of the video frame. You must set a timestamp for each video frame. - */ - virtual void consumeRawVideoFrame(const unsigned char *buffer, agora::media::ExternalVideoFrame::VIDEO_PIXEL_FORMAT frameType, int width, int height, int rotation, long timestamp) = 0; + public: + /** Receives the raw video frame. + * + * @note Ensure that the video frame type that you specify in this method is the same as that in the \ref agora::rtc::IVideoSource::getBufferType "getBufferType" callback. + * + * @param buffer The video buffer. + * @param frameType The video frame type. See \ref agora::media::ExternalVideoFrame::VIDEO_PIXEL_FORMAT "VIDEO_PIXEL_FORMAT". + * @param width The width (px) of the video frame. + * @param height The height (px) of the video frame. + * @param rotation The angle (degree) at which the video frame rotates clockwise. If you set the rotation angle, the + * SDK rotates the video frame after receiving it. You can set the rotation angle as `0`, `90`, `180`, and `270`. + * @param timestamp The Unix timestamp (ms) of the video frame. You must set a timestamp for each video frame. + */ + virtual void consumeRawVideoFrame(const unsigned char* buffer, agora::media::ExternalVideoFrame::VIDEO_PIXEL_FORMAT frameType, int width, int height, int rotation, long timestamp) = 0; }; /** The IVideoSource class. You can use it to customize the video source. */ class IVideoSource { -public: - /** Notification for initializing the custom video source. - * - * The SDK triggers this callback to remind you to initialize the custom video source. After receiving this callback, - * you can do some preparation, such as enabling the camera, and then use the return value to tell the SDK whether the - * custom video source is prepared. - * - * @param consumer An IVideoFrameConsumer object that the SDK passes to you. You need to reserve this object and use it - * to send the video frame to the SDK once the custom video source is started. See IVideoFrameConsumer. - * - * @return - * - true: The custom video source is initialized. - * - false: The custom video source is not ready or fails to initialize. The SDK stops and reports the error. - */ - virtual bool onInitialize(IVideoFrameConsumer *consumer) = 0; + public: + /** Notification for initializing the custom video source. + * + * The SDK triggers this callback to remind you to initialize the custom video source. After receiving this callback, + * you can do some preparation, such as enabling the camera, and then use the return value to tell the SDK whether the + * custom video source is prepared. + * + * @param consumer An IVideoFrameConsumer object that the SDK passes to you. You need to reserve this object and use it + * to send the video frame to the SDK once the custom video source is started. See IVideoFrameConsumer. + * + * @return + * - true: The custom video source is initialized. + * - false: The custom video source is not ready or fails to initialize. The SDK stops and reports the error. + */ + virtual bool onInitialize(IVideoFrameConsumer* consumer) = 0; - /** Notification for disabling the custom video source. - * - * The SDK triggers this callback to remind you to disable the custom video source device. This callback tells you - * that the SDK is about to release the IVideoFrameConsumer object. Ensure that you no longer use IVideoFrameConsumer - * after receiving this callback. - */ - virtual void onDispose() = 0; + /** Notification for disabling the custom video source. + * + * The SDK triggers this callback to remind you to disable the custom video source device. This callback tells you + * that the SDK is about to release the IVideoFrameConsumer object. Ensure that you no longer use IVideoFrameConsumer + * after receiving this callback. + */ + virtual void onDispose() = 0; - /** Notification for starting the custom video source. - * - * The SDK triggers this callback to remind you to start the custom video source for capturing video. The SDK uses - * IVideoFrameConsumer to receive the video frame that you capture after the video source is started. You must use - * the return value to tell the SDK whether the custom video source is started. - * - * @return - * - true: The custom video source is started. - * - false: The custom video source fails to start. The SDK stops and reports the error. - */ - virtual bool onStart() = 0; + /** Notification for starting the custom video source. + * + * The SDK triggers this callback to remind you to start the custom video source for capturing video. The SDK uses + * IVideoFrameConsumer to receive the video frame that you capture after the video source is started. You must use + * the return value to tell the SDK whether the custom video source is started. + * + * @return + * - true: The custom video source is started. + * - false: The custom video source fails to start. The SDK stops and reports the error. + */ + virtual bool onStart() = 0; - /** Notification for stopping capturing video. - * - * The SDK triggers this callback to remind you to stop capturing video. This callback tells you that the SDK is about - * to stop using IVideoFrameConsumer to receive the video frame that you capture. - */ - virtual void onStop() = 0; + /** Notification for stopping capturing video. + * + * The SDK triggers this callback to remind you to stop capturing video. This callback tells you that the SDK is about + * to stop using IVideoFrameConsumer to receive the video frame that you capture. + */ + virtual void onStop() = 0; - /** Gets the video frame type. - * - * Before you initialize the custom video source, the SDK triggers this callback to query the video frame type. You - * must specify the video frame type in the return value and then pass it to the SDK. - * - * @note Ensure that the video frame type that you specify in this callback is the same as that in the \ref agora::rtc::IVideoFrameConsumer::consumeRawVideoFrame "consumeRawVideoFrame" method. - * - * @return \ref agora::media::ExternalVideoFrame::VIDEO_PIXEL_FORMAT "VIDEO_PIXEL_FORMAT" - */ - virtual agora::media::ExternalVideoFrame::VIDEO_PIXEL_FORMAT getBufferType() = 0; - /** Gets the capture type of the custom video source. - * - * Before you initialize the custom video source, the SDK triggers this callback to query the capture type of the video source. - * You must specify the capture type in the return value and then pass it to the SDK. The SDK enables the corresponding video - * processing algorithm according to the capture type after receiving the video frame. - * - * @return #VIDEO_CAPTURE_TYPE - */ - virtual VIDEO_CAPTURE_TYPE getVideoCaptureType() = 0; - /** Gets the content hint of the custom video source. - * - * If you specify the custom video source as a screen-sharing video, the SDK triggers this callback to query the - * content hint of the video source before you initialize the video source. You must specify the content hint in the - * return value and then pass it to the SDK. The SDK enables the corresponding video processing algorithm according - * to the content hint after receiving the video frame. - * - * @return \ref agora::rtc::VideoContentHint "VideoContentHint" - */ - virtual VideoContentHint getVideoContentHint() = 0; + /** Gets the video frame type. + * + * Before you initialize the custom video source, the SDK triggers this callback to query the video frame type. You + * must specify the video frame type in the return value and then pass it to the SDK. + * + * @note Ensure that the video frame type that you specify in this callback is the same as that in the \ref agora::rtc::IVideoFrameConsumer::consumeRawVideoFrame "consumeRawVideoFrame" method. + * + * @return \ref agora::media::ExternalVideoFrame::VIDEO_PIXEL_FORMAT "VIDEO_PIXEL_FORMAT" + */ + virtual agora::media::ExternalVideoFrame::VIDEO_PIXEL_FORMAT getBufferType() = 0; + /** Gets the capture type of the custom video source. + * + * Before you initialize the custom video source, the SDK triggers this callback to query the capture type of the video source. + * You must specify the capture type in the return value and then pass it to the SDK. The SDK enables the corresponding video + * processing algorithm according to the capture type after receiving the video frame. + * + * @return #VIDEO_CAPTURE_TYPE + */ + virtual VIDEO_CAPTURE_TYPE getVideoCaptureType() = 0; + /** Gets the content hint of the custom video source. + * + * If you specify the custom video source as a screen-sharing video, the SDK triggers this callback to query the + * content hint of the video source before you initialize the video source. You must specify the content hint in the + * return value and then pass it to the SDK. The SDK enables the corresponding video processing algorithm according + * to the content hint after receiving the video frame. + * + * @return \ref agora::rtc::VideoContentHint "VideoContentHint" + */ + virtual VideoContentHint getVideoContentHint() = 0; }; #endif -/** The SDK uses the IRtcEngineEventHandler interface class to send callbacks to the application. The application inherits the methods of this interface class to retrieve these callbacks. +/** The SDK uses the IRtcEngineEventHandler interface class to send callbacks to the application. The application inherits the methods of this interface class to get these callbacks. All methods in this interface class have default (empty) implementations. Therefore, the application can only inherit some required events. In the callbacks, avoid time-consuming tasks or calling blocking APIs, such as the SendMessage method. Otherwise, the SDK may not work properly. */ -class IRtcEngineEventHandler -{ -public: - virtual ~IRtcEngineEventHandler() {} +class IRtcEngineEventHandler { + public: + virtual ~IRtcEngineEventHandler() {} - /** Reports a warning during SDK runtime. + /** Reports a warning during SDK runtime. - In most cases, the application can ignore the warning reported by the SDK because the SDK can usually fix the issue and resume running. For example, when losing connection with the server, the SDK may report #WARN_LOOKUP_CHANNEL_TIMEOUT and automatically try to reconnect. + In most cases, the application can ignore the warning reported by the SDK because the SDK can usually fix the issue and resume running. For example, when losing connection with the server, the SDK may report #WARN_LOOKUP_CHANNEL_TIMEOUT and automatically try to reconnect. - @param warn Warning code: #WARN_CODE_TYPE. - @param msg Pointer to the warning message. - */ - virtual void onWarning(int warn, const char* msg) { - (void)warn; - (void)msg; - } + @param warn Warning code: #WARN_CODE_TYPE. + @param msg Pointer to the warning message. + */ + virtual void onWarning(int warn, const char* msg) { + (void)warn; + (void)msg; + } - /** Reports an error during SDK runtime. + /** Reports an error during SDK runtime. - In most cases, the SDK cannot fix the issue and resume running. The SDK requires the application to take action or informs the user about the issue. + In most cases, the SDK cannot fix the issue and resume running. The SDK requires the application to take action or informs the user about the issue. - For example, the SDK reports an #ERR_START_CALL error when failing to initialize a call. The application informs the user that the call initialization failed and invokes the \ref IRtcEngine::leaveChannel "leaveChannel" method to leave the channel. + For example, the SDK reports an #ERR_START_CALL error when failing to initialize a call. The application informs the user that the call initialization failed and invokes the \ref IRtcEngine::leaveChannel "leaveChannel" method to leave the channel. - @param err Error code: #ERROR_CODE_TYPE. - @param msg Pointer to the error message. - */ - virtual void onError(int err, const char* msg) { - (void)err; - (void)msg; - } + @param err Error code: #ERROR_CODE_TYPE. + @param msg Pointer to the error message. + */ + virtual void onError(int err, const char* msg) { + (void)err; + (void)msg; + } - /** Occurs when a user joins a channel. + /** Occurs when a user joins a channel. - This callback notifies the application that a user joins a specified channel when the application calls the \ref IRtcEngine::joinChannel "joinChannel" method. + This callback notifies the application that a user joins a specified channel when the application calls the \ref IRtcEngine::joinChannel "joinChannel" method. - The channel name assignment is based on @p channelName specified in the \ref IRtcEngine::joinChannel "joinChannel" method. + The channel name assignment is based on @p channelName specified in the \ref IRtcEngine::joinChannel "joinChannel" method. - If the @p uid is not specified in the *joinChannel* method, the server automatically assigns a @p uid. + If the @p uid is not specified in the *joinChannel* method, the server automatically assigns a @p uid. - @param channel Pointer to the channel name. - @param uid User ID of the user joining the channel. - @param elapsed Time elapsed (ms) from the user calling the \ref IRtcEngine::joinChannel "joinChannel" method until the SDK triggers this callback. - */ - virtual void onJoinChannelSuccess(const char* channel, uid_t uid, int elapsed) { - (void)channel; - (void)uid; - (void)elapsed; - } + @param channel Pointer to the channel name. + @param uid User ID of the user joining the channel. + @param elapsed Time elapsed (ms) from the user calling the \ref IRtcEngine::joinChannel "joinChannel" method until the SDK triggers this callback. + */ + virtual void onJoinChannelSuccess(const char* channel, uid_t uid, int elapsed) { + (void)channel; + (void)uid; + (void)elapsed; + } - /** Occurs when a user rejoins the channel after disconnection due to network problems. + /** Occurs when a user rejoins the channel after disconnection due to network problems. - When a user loses connection with the server because of network problems, the SDK automatically tries to reconnect and triggers this callback upon reconnection. + When a user loses connection with the server because of network problems, the SDK automatically tries to reconnect and triggers this callback upon reconnection. - @param channel Pointer to the channel name. - @param uid User ID of the user rejoining the channel. - @param elapsed Time elapsed (ms) from starting to reconnect until the SDK triggers this callback. - */ - virtual void onRejoinChannelSuccess(const char* channel, uid_t uid, int elapsed) { - (void)channel; - (void)uid; - (void)elapsed; - } + @param channel Pointer to the channel name. + @param uid User ID of the user rejoining the channel. + @param elapsed Time elapsed (ms) from starting to reconnect until the SDK triggers this callback. + */ + virtual void onRejoinChannelSuccess(const char* channel, uid_t uid, int elapsed) { + (void)channel; + (void)uid; + (void)elapsed; + } - /** Occurs when a user leaves the channel. + /** Occurs when a user leaves the channel. - This callback notifies the application that a user leaves the channel when the application calls the \ref IRtcEngine::leaveChannel "leaveChannel" method. + This callback notifies the application that a user leaves the channel when the application calls the \ref IRtcEngine::leaveChannel "leaveChannel" method. - The application retrieves information, such as the call duration and statistics. + The application gets information, such as the call duration and statistics. - @param stats Pointer to the statistics of the call: RtcStats. - */ - virtual void onLeaveChannel(const RtcStats& stats) { - (void)stats; - } + @param stats Pointer to the statistics of the call: RtcStats. + */ + virtual void onLeaveChannel(const RtcStats& stats) { (void)stats; } - /** Occurs when the user role switches in the live interactive streaming. For example, from a host to an audience or vice versa. + /** Occurs when the user role switches in the interactive live streaming. For example, from a host to an audience or vice versa. - This callback notifies the application of a user role switch when the application calls the \ref IRtcEngine::setClientRole "setClientRole" method. + This callback notifies the application of a user role switch when the application calls the \ref IRtcEngine::setClientRole "setClientRole" method. - The SDK triggers this callback when the local user switches the user role by calling the \ref agora::rtc::IRtcEngine::setClientRole "setClientRole" method after joining the channel. - @param oldRole Role that the user switches from: #CLIENT_ROLE_TYPE. - @param newRole Role that the user switches to: #CLIENT_ROLE_TYPE. - */ - virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole) { - } + The SDK triggers this callback when the local user switches the user role by calling the \ref agora::rtc::IRtcEngine::setClientRole "setClientRole" method after joining the channel. + @param oldRole Role that the user switches from: #CLIENT_ROLE_TYPE. + @param newRole Role that the user switches to: #CLIENT_ROLE_TYPE. + */ + virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole) {} - /** Occurs when a remote user (`COMMUNICATION`)/ host (`LIVE_BROADCASTING`) joins the channel. + /** Occurs when a remote user (`COMMUNICATION`)/ host (`LIVE_BROADCASTING`) joins the channel. - - `COMMUNICATION` profile: This callback notifies the application that another user joins the channel. If other users are already in the channel, the SDK also reports to the application on the existing users. - - `LIVE_BROADCASTING` profile: This callback notifies the application that the host joins the channel. If other hosts are already in the channel, the SDK also reports to the application on the existing hosts. We recommend limiting the number of hosts to 17. + - `COMMUNICATION` profile: This callback notifies the application that another user joins the channel. If other users are already in the channel, the SDK also reports to the application on the existing users. + - `LIVE_BROADCASTING` profile: This callback notifies the application that the host joins the channel. If other hosts are already in the channel, the SDK also reports to the application on the existing hosts. We recommend limiting the number of hosts to 17. - The SDK triggers this callback under one of the following circumstances: - - A remote user/host joins the channel by calling the \ref agora::rtc::IRtcEngine::joinChannel "joinChannel" method. - - A remote user switches the user role to the host by calling the \ref agora::rtc::IRtcEngine::setClientRole "setClientRole" method after joining the channel. - - A remote user/host rejoins the channel after a network interruption. - - The host injects an online media stream into the channel by calling the \ref agora::rtc::IRtcEngine::addInjectStreamUrl "addInjectStreamUrl" method. + The SDK triggers this callback under one of the following circumstances: + - A remote user/host joins the channel by calling the \ref agora::rtc::IRtcEngine::joinChannel "joinChannel" method. + - A remote user switches the user role to the host by calling the \ref agora::rtc::IRtcEngine::setClientRole "setClientRole" method after joining the channel. + - A remote user/host rejoins the channel after a network interruption. + - The host injects an online media stream into the channel by calling the \ref agora::rtc::IRtcEngine::addInjectStreamUrl "addInjectStreamUrl" method. - @note In the `LIVE_BROADCASTING` profile: - - The host receives this callback when another host joins the channel. - - The audience in the channel receives this callback when a new host joins the channel. - - When a web application joins the channel, the SDK triggers this callback as long as the web application publishes streams. + @note In the `LIVE_BROADCASTING` profile: + - The host receives this callback when another host joins the channel. + - The audience in the channel receives this callback when a new host joins the channel. + - When a web application joins the channel, the SDK triggers this callback as long as the web application publishes streams. - @param uid User ID of the user or host joining the channel. - @param elapsed Time delay (ms) from the local user calling the \ref IRtcEngine::joinChannel "joinChannel" method until the SDK triggers this callback. - */ - virtual void onUserJoined(uid_t uid, int elapsed) { - (void)uid; - (void)elapsed; - } + @param uid User ID of the user or host joining the channel. + @param elapsed Time delay (ms) from the local user calling the \ref IRtcEngine::joinChannel "joinChannel" method until the SDK triggers this callback. + */ + virtual void onUserJoined(uid_t uid, int elapsed) { + (void)uid; + (void)elapsed; + } - /** Occurs when a remote user (`COMMUNICATION`)/ host (`LIVE_BROADCASTING`) leaves the channel. + /** Occurs when a remote user (`COMMUNICATION`)/ host (`LIVE_BROADCASTING`) leaves the channel. - Reasons why the user is offline: + Reasons why the user is offline: - - Leave the channel: When the user/host leaves the channel, the user/host sends a goodbye message. When the message is received, the SDK assumes that the user/host leaves the channel. - - Drop offline: When no data packet of the user or host is received for a certain period of time, the SDK assumes that the user/host drops offline. Unreliable network connections may lead to false detections, so we recommend using the Agora RTM SDK for more reliable offline detection. + - Leave the channel: When the user/host leaves the channel, the user/host sends a goodbye message. When the message is received, the SDK assumes that the user/host leaves the channel. + - Drop offline: When no data packet of the user or host is received for a certain period of time, the SDK assumes that the user/host drops offline. Unreliable network connections may lead to false detections, so we recommend using the Agora RTM SDK for more reliable offline detection. - @param uid User ID of the user leaving the channel or going offline. - @param reason Reason why the user is offline: #USER_OFFLINE_REASON_TYPE. - */ - virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason) { - (void)uid; - (void)reason; - } + @param uid User ID of the user leaving the channel or going offline. + @param reason Reason why the user is offline: #USER_OFFLINE_REASON_TYPE. + */ + virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason) { + (void)uid; + (void)reason; + } - /** Reports the last mile network quality of the local user once every two seconds before the user joins the channel. + /** Reports the last mile network quality of the local user once every two seconds before the user joins the channel. - Last mile refers to the connection between the local device and Agora's edge server. After the application calls the \ref IRtcEngine::enableLastmileTest "enableLastmileTest" method, this callback reports once every two seconds the uplink and downlink last mile network conditions of the local user before the user joins the channel. + Last mile refers to the connection between the local device and Agora's edge server. After the application calls the \ref IRtcEngine::enableLastmileTest "enableLastmileTest" method, this callback reports once every two seconds the uplink and downlink last mile network conditions of the local user before the user joins the channel. - @param quality The last mile network quality: #QUALITY_TYPE. - */ - virtual void onLastmileQuality(int quality) { - (void)quality; - } + @param quality The last mile network quality: #QUALITY_TYPE. + */ + virtual void onLastmileQuality(int quality) { (void)quality; } - /** Reports the last-mile network probe result. + /** Reports the last-mile network probe result. - The SDK triggers this callback within 30 seconds after the app calls the \ref agora::rtc::IRtcEngine::startLastmileProbeTest "startLastmileProbeTest" method. + The SDK triggers this callback within 30 seconds after the app calls the \ref agora::rtc::IRtcEngine::startLastmileProbeTest "startLastmileProbeTest" method. - @param result The uplink and downlink last-mile network probe test result. See LastmileProbeResult. - */ - virtual void onLastmileProbeResult(const LastmileProbeResult& result) { - (void)result; - } + @param result The uplink and downlink last-mile network probe test result. See LastmileProbeResult. + */ + virtual void onLastmileProbeResult(const LastmileProbeResult& result) { (void)result; } - /** **DEPRECATED** Occurs when the connection between the SDK and the server is interrupted. + /** **DEPRECATED** Occurs when the connection between the SDK and the server is interrupted. - Deprecated as of v2.3.2. Replaced by the \ref agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged(CONNECTION_STATE_RECONNECTING, CONNECTION_CHANGED_INTERRUPTED)" callback. + Deprecated as of v2.3.2. Replaced by the \ref agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged(CONNECTION_STATE_RECONNECTING, CONNECTION_CHANGED_INTERRUPTED)" callback. - The SDK triggers this callback when it loses connection with the server for more than four seconds after the connection is established. + The SDK triggers this callback when it loses connection with the server for more than four seconds after the connection is established. - After triggering this callback, the SDK tries reconnecting to the server. You can use this callback to implement pop-up reminders. + After triggering this callback, the SDK tries reconnecting to the server. You can use this callback to implement pop-up reminders. - This callback is different from \ref agora::rtc::IRtcEngineEventHandler::onConnectionLost "onConnectionLost": - - The SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onConnectionInterrupted "onConnectionInterrupted" callback when it loses connection with the server for more than four seconds after it successfully joins the channel. - - The SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onConnectionLost "onConnectionLost" callback when it loses connection with the server for more than 10 seconds, whether or not it joins the channel. + This callback is different from \ref agora::rtc::IRtcEngineEventHandler::onConnectionLost "onConnectionLost": + - The SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onConnectionInterrupted "onConnectionInterrupted" callback when it loses connection with the server for more than four seconds after it successfully joins the channel. + - The SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onConnectionLost "onConnectionLost" callback when it loses connection with the server for more than 10 seconds, whether or not it joins the channel. - If the SDK fails to rejoin the channel 20 minutes after being disconnected from Agora's edge server, the SDK stops rejoining the channel. + If the SDK fails to rejoin the channel 20 minutes after being disconnected from Agora's edge server, the SDK stops rejoining the channel. - */ - virtual void onConnectionInterrupted() {} + */ + virtual void onConnectionInterrupted() {} - /** Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the server is interrupted. + /** Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the server is interrupted. - The SDK triggers this callback when it cannot connect to the server 10 seconds after calling the \ref IRtcEngine::joinChannel "joinChannel" method, whether or not it is in the channel. + The SDK triggers this callback when it cannot connect to the server 10 seconds after calling the \ref IRtcEngine::joinChannel "joinChannel" method, whether or not it is in the channel. - This callback is different from \ref agora::rtc::IRtcEngineEventHandler::onConnectionInterrupted "onConnectionInterrupted": + This callback is different from \ref agora::rtc::IRtcEngineEventHandler::onConnectionInterrupted "onConnectionInterrupted": - - The SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onConnectionInterrupted "onConnectionInterrupted" callback when it loses connection with the server for more than four seconds after it successfully joins the channel. - - The SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onConnectionLost "onConnectionLost" callback when it loses connection with the server for more than 10 seconds, whether or not it joins the channel. + - The SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onConnectionInterrupted "onConnectionInterrupted" callback when it loses connection with the server for more than four seconds after it successfully joins the channel. + - The SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onConnectionLost "onConnectionLost" callback when it loses connection with the server for more than 10 seconds, whether or not it joins the channel. - If the SDK fails to rejoin the channel 20 minutes after being disconnected from Agora's edge server, the SDK stops rejoining the channel. + If the SDK fails to rejoin the channel 20 minutes after being disconnected from Agora's edge server, the SDK stops rejoining the channel. - */ - virtual void onConnectionLost() {} + */ + virtual void onConnectionLost() {} - /** **DEPRECATED** Deprecated as of v2.3.2. Replaced by the \ref agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged(CONNECTION_STATE_FAILED, CONNECTION_CHANGED_BANNED_BY_SERVER)" callback. + /** **DEPRECATED** Deprecated as of v2.3.2. Replaced by the \ref agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged(CONNECTION_STATE_FAILED, CONNECTION_CHANGED_BANNED_BY_SERVER)" callback. - Occurs when your connection is banned by the Agora Server. - */ - virtual void onConnectionBanned() {} + Occurs when your connection is banned by the Agora Server. + */ + virtual void onConnectionBanned() {} - /** Occurs when a method is executed by the SDK. + /** Occurs when a method is executed by the SDK. - @param err The error code (#ERROR_CODE_TYPE) returned by the SDK when a method call fails. If the SDK returns 0, then the method call is successful. - @param api Pointer to the method executed by the SDK. - @param result Pointer to the result of the method call. - */ - virtual void onApiCallExecuted(int err, const char* api, const char* result) { - (void)err; - (void)api; - (void)result; - } + @param err The error code (#ERROR_CODE_TYPE) returned by the SDK when a method call fails. If the SDK returns 0, then the method call is successful. + @param api Pointer to the method executed by the SDK. + @param result Pointer to the result of the method call. + */ + virtual void onApiCallExecuted(int err, const char* api, const char* result) { + (void)err; + (void)api; + (void)result; + } - /** Occurs when the token expires. + /** Occurs when the token expires. - After a token is specified by calling the \ref IRtcEngine::joinChannel "joinChannel" method, if the SDK losses - connection with the Agora server due to network issues, the token may expire after a certain period of time and a - new token may be required to reconnect to the server. + After a token is specified by calling the \ref IRtcEngine::joinChannel "joinChannel" method, if the SDK losses + connection with the Agora server due to network issues, the token may expire after a certain period of time and a + new token may be required to reconnect to the server. - Once you receive this callback, generate a new token on your app server, and call - \ref agora::rtc::IRtcEngine::renewToken "renewToken" to pass the new token to the SDK. - */ - virtual void onRequestToken() { - } + Once you receive this callback, generate a new token on your app server, and call + \ref agora::rtc::IRtcEngine::renewToken "renewToken" to pass the new token to the SDK. + */ + virtual void onRequestToken() {} - /** Occurs when the token expires in 30 seconds. + /** Occurs when the token expires in 30 seconds. - The user becomes offline if the token used in the \ref IRtcEngine::joinChannel "joinChannel" method expires. The SDK triggers this callback 30 seconds before the token expires to remind the application to get a new token. Upon receiving this callback, generate a new token on the server and call the \ref IRtcEngine::renewToken "renewToken" method to pass the new token to the SDK. + The user becomes offline if the token used in the \ref IRtcEngine::joinChannel "joinChannel" method expires. The SDK triggers this callback 30 seconds before the token expires to remind the application to get a new token. Upon receiving this callback, generate a new token on the server and call the \ref IRtcEngine::renewToken "renewToken" method to pass the new token to the SDK. - @param token Pointer to the token that expires in 30 seconds. - */ - virtual void onTokenPrivilegeWillExpire(const char* token) { - (void)token; - } + @param token Pointer to the token that expires in 30 seconds. + */ + virtual void onTokenPrivilegeWillExpire(const char* token) { (void)token; } - /** **DEPRECATED** Reports the statistics of the audio stream from each remote user/host. + /** **DEPRECATED** Reports the statistics of the audio stream from each remote user/host. - Deprecated as of v2.3.2. Use the \ref agora::rtc::IRtcEngineEventHandler::onRemoteAudioStats "onRemoteAudioStats" callback instead. + Deprecated as of v2.3.2. Use the \ref agora::rtc::IRtcEngineEventHandler::onRemoteAudioStats "onRemoteAudioStats" callback instead. - The SDK triggers this callback once every two seconds to report the audio quality of each remote user/host sending an audio stream. If a channel has multiple users/hosts sending audio streams, the SDK triggers this callback as many times. + The SDK triggers this callback once every two seconds to report the audio quality of each remote user/host sending an audio stream. If a channel has multiple users/hosts sending audio streams, the SDK triggers this callback as many times. - @param uid User ID of the speaker. - @param quality Audio quality of the user: #QUALITY_TYPE. - @param delay Time delay (ms) of sending the audio packet from the sender to the receiver, including the time delay of audio sampling pre-processing, transmission, and the jitter buffer. - @param lost Packet loss rate (%) of the audio packet sent from the sender to the receiver. - */ - virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost) { - (void)uid; - (void)quality; - (void)delay; - (void)lost; - } + @param uid User ID of the speaker. + @param quality Audio quality of the user: #QUALITY_TYPE. + @param delay Time delay (ms) of sending the audio packet from the sender to the receiver, including the time delay of audio sampling pre-processing, transmission, and the jitter buffer. + @param lost Packet loss rate (%) of the audio packet sent from the sender to the receiver. + */ + virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost) { + (void)uid; + (void)quality; + (void)delay; + (void)lost; + } - /** Reports the statistics of the current call. + /** Reports the statistics of the current call. - The SDK triggers this callback once every two seconds after the user joins the channel. + The SDK triggers this callback once every two seconds after the user joins the channel. - @param stats Statistics of the IRtcEngine: RtcStats. - */ - virtual void onRtcStats(const RtcStats& stats) { - (void)stats; - } + @param stats Statistics of the IRtcEngine: RtcStats. + */ + virtual void onRtcStats(const RtcStats& stats) { (void)stats; } - /** Reports the last mile network quality of each user in the channel once every two seconds. + /** Reports the last mile network quality of each user in the channel once every two seconds. - Last mile refers to the connection between the local device and Agora's edge server. This callback reports once every two seconds the last mile network conditions of each user in the channel. If a channel includes multiple users, the SDK triggers this callback as many times. + Last mile refers to the connection between the local device and Agora's edge server. This callback reports once every two seconds the last mile network conditions of each user in the channel. If a channel includes multiple users, the SDK triggers this callback as many times. - @param uid User ID. The network quality of the user with this @p uid is reported. If @p uid is 0, the local network quality is reported. - @param txQuality Uplink transmission quality rating of the user in terms of the transmission bitrate, packet loss rate, average RTT (Round-Trip Time), and jitter of the uplink network. @p txQuality is a quality rating helping you understand how well the current uplink network conditions can support the selected VideoEncoderConfiguration. For example, a 1000 Kbps uplink network may be adequate for video frames with a resolution of 640 * 480 and a frame rate of 15 fps in the `LIVE_BROADCASTING` profile, but may be inadequate for resolutions higher than 1280 * 720. See #QUALITY_TYPE. - @param rxQuality Downlink network quality rating of the user in terms of the packet loss rate, average RTT, and jitter of the downlink network. See #QUALITY_TYPE. - */ - virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality) { + @param uid User ID. The network quality of the user with this @p uid is reported. If @p uid is 0, the local network quality is reported. + @param txQuality Uplink transmission quality rating of the user in terms of the transmission bitrate, packet loss rate, average RTT (Round-Trip Time), and jitter of the uplink network. @p txQuality is a quality rating helping you understand how well the current uplink network conditions can support the selected VideoEncoderConfiguration. For example, a 1000 Kbps uplink network may be adequate for video frames with a resolution of 640 * 480 and a frame rate of 15 fps in the `LIVE_BROADCASTING` profile, but may be inadequate for resolutions higher than 1280 * 720. See #QUALITY_TYPE. + @param rxQuality Downlink network quality rating of the user in terms of the packet loss rate, average RTT, and jitter of the downlink network. See #QUALITY_TYPE. + */ + virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality) { (void)uid; (void)txQuality; (void)rxQuality; - } - - /** Reports the statistics of the local video stream. - * - * The SDK triggers this callback once every two seconds for each - * user/host. If there are multiple users/hosts in the channel, the SDK - * triggers this callback as many times. - * - * @note - * If you have called the - * \ref agora::rtc::IRtcEngine::enableDualStreamMode "enableDualStreamMode" - * method, the \ref onLocalVideoStats() "onLocalVideoStats" callback - * reports the statistics of the high-video - * stream (high bitrate, and high-resolution video stream). - * - * @param stats Statistics of the local video stream. See LocalVideoStats. - */ - virtual void onLocalVideoStats(const LocalVideoStats& stats) { - (void)stats; - } + } - /** Reports the statistics of the video stream from each remote user/host. - * - * The SDK triggers this callback once every two seconds for each remote - * user/host. If a channel includes multiple remote users, the SDK - * triggers this callback as many times. - * - * @param stats Statistics of the remote video stream. See - * RemoteVideoStats. - */ - virtual void onRemoteVideoStats(const RemoteVideoStats& stats) { - (void)stats; - } + /** Reports the statistics of the local video stream. + * + * The SDK triggers this callback once every two seconds for each + * user/host. If there are multiple users/hosts in the channel, the SDK + * triggers this callback as many times. + * + * @note + * If you have called the + * \ref agora::rtc::IRtcEngine::enableDualStreamMode "enableDualStreamMode" + * method, the \ref onLocalVideoStats() "onLocalVideoStats" callback + * reports the statistics of the high-video + * stream (high bitrate, and high-resolution video stream). + * + * @param stats Statistics of the local video stream. See LocalVideoStats. + */ + virtual void onLocalVideoStats(const LocalVideoStats& stats) { (void)stats; } - /** Reports the statistics of the local audio stream. - * - * The SDK triggers this callback once every two seconds. - * - * @param stats The statistics of the local audio stream. - * See LocalAudioStats. - */ - virtual void onLocalAudioStats(const LocalAudioStats& stats) { - (void)stats; - } + /** Reports the statistics of the video stream from each remote user/host. + * + * The SDK triggers this callback once every two seconds for each remote + * user/host. If a channel includes multiple remote users, the SDK + * triggers this callback as many times. + * + * @param stats Statistics of the remote video stream. See + * RemoteVideoStats. + */ + virtual void onRemoteVideoStats(const RemoteVideoStats& stats) { (void)stats; } - /** Reports the statistics of the audio stream from each remote user/host. + /** Reports the statistics of the local audio stream. + * + * The SDK triggers this callback once every two seconds. + * + * @param stats The statistics of the local audio stream. + * See LocalAudioStats. + */ + virtual void onLocalAudioStats(const LocalAudioStats& stats) { (void)stats; } - This callback replaces the \ref agora::rtc::IRtcEngineEventHandler::onAudioQuality "onAudioQuality" callback. + /** Reports the statistics of the audio stream from each remote user/host. - The SDK triggers this callback once every two seconds for each remote user/host. If a channel includes multiple remote users, the SDK triggers this callback as many times. + This callback replaces the \ref agora::rtc::IRtcEngineEventHandler::onAudioQuality "onAudioQuality" callback. - @param stats Pointer to the statistics of the received remote audio streams. See RemoteAudioStats. - */ - virtual void onRemoteAudioStats(const RemoteAudioStats& stats) { - (void)stats; - } + The SDK triggers this callback once every two seconds for each remote user/host. If a channel includes multiple remote users, the SDK triggers this callback as many times. - /** Occurs when the local audio state changes. - * This callback indicates the state change of the local audio stream, - * including the state of the audio recording and encoding, and allows - * you to troubleshoot issues when exceptions occur. - * - * @note - * When the state is #LOCAL_AUDIO_STREAM_STATE_FAILED (3), see the `error` - * parameter for details. - * - * @param state State of the local audio. See #LOCAL_AUDIO_STREAM_STATE. - * @param error The error information of the local audio. - * See #LOCAL_AUDIO_STREAM_ERROR. - */ - virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error) { - (void)state; - (void)error; - } + @param stats Pointer to the statistics of the received remote audio streams. See RemoteAudioStats. + */ + virtual void onRemoteAudioStats(const RemoteAudioStats& stats) { (void)stats; } - /** Occurs when the remote audio state changes. + /** Occurs when the local audio state changes. + * This callback indicates the state change of the local audio stream, + * including the state of the audio capturing and encoding, and allows + * you to troubleshoot issues when exceptions occur. + * + * @note + * When the state is #LOCAL_AUDIO_STREAM_STATE_FAILED (3), see the `error` + * parameter for details. + * + * @param state State of the local audio. See #LOCAL_AUDIO_STREAM_STATE. + * @param error The error information of the local audio. + * See #LOCAL_AUDIO_STREAM_ERROR. + */ + virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error) { + (void)state; + (void)error; + } - This callback indicates the state change of the remote audio stream. - @note This callback does not work properly when the number of users (in the `COMMUNICATION` profile) or hosts (in the `LIVE_BROADCASTING` profile) in the channel exceeds 17. + /** Occurs when the remote audio state changes. - @param uid ID of the remote user whose audio state changes. - @param state State of the remote audio. See #REMOTE_AUDIO_STATE. - @param reason The reason of the remote audio state change. - See #REMOTE_AUDIO_STATE_REASON. - @param elapsed Time elapsed (ms) from the local user calling the - \ref IRtcEngine::joinChannel "joinChannel" method until the SDK - triggers this callback. - */ - virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) { - (void)uid; - (void)state; - (void)reason; - (void)elapsed; - } + This callback indicates the state change of the remote audio stream. + @note This callback does not work properly when the number of users (in the `COMMUNICATION` profile) or hosts (in the `LIVE_BROADCASTING` profile) in the channel exceeds 17. - /** Occurs when the audio publishing state changes. - * - * @since v3.1.0 - * - * This callback indicates the publishing state change of the local audio stream. - * - * @param channel The channel name. - * @param oldState The previous publishing state. For details, see #STREAM_PUBLISH_STATE. - * @param newState The current publishing state. For details, see #STREAM_PUBLISH_STATE. - * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state. - */ - virtual void onAudioPublishStateChanged(const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) { - (void)channel; - (void)oldState; - (void)newState; - (void)elapseSinceLastState; - } + @param uid ID of the remote user whose audio state changes. + @param state State of the remote audio. See #REMOTE_AUDIO_STATE. + @param reason The reason of the remote audio state change. + See #REMOTE_AUDIO_STATE_REASON. + @param elapsed Time elapsed (ms) from the local user calling the + \ref IRtcEngine::joinChannel "joinChannel" method until the SDK + triggers this callback. + */ + virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) { + (void)uid; + (void)state; + (void)reason; + (void)elapsed; + } - /** Occurs when the video publishing state changes. - * - * @since v3.1.0 - * - * This callback indicates the publishing state change of the local video stream. - * - * @param channel The channel name. - * @param oldState The previous publishing state. For details, see #STREAM_PUBLISH_STATE. - * @param newState The current publishing state. For details, see #STREAM_PUBLISH_STATE. - * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state. - */ - virtual void onVideoPublishStateChanged(const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) { - (void)channel; - (void)oldState; - (void)newState; - (void)elapseSinceLastState; - } + /** Occurs when the audio publishing state changes. + * + * @since v3.1.0 + * + * This callback indicates the publishing state change of the local audio stream. + * + * @param channel The channel name. + * @param oldState The previous publishing state. For details, see #STREAM_PUBLISH_STATE. + * @param newState The current publishing state. For details, see #STREAM_PUBLISH_STATE. + * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state. + */ + virtual void onAudioPublishStateChanged(const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) { + (void)channel; + (void)oldState; + (void)newState; + (void)elapseSinceLastState; + } - /** Occurs when the audio subscribing state changes. - * - * @since v3.1.0 - * - * This callback indicates the subscribing state change of a remote audio stream. - * - * @param channel The channel name. - * @param uid The ID of the remote user. - * @param oldState The previous subscribing state. For details, see #STREAM_SUBSCRIBE_STATE. - * @param newState The current subscribing state. For details, see #STREAM_SUBSCRIBE_STATE. - * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state. - */ - virtual void onAudioSubscribeStateChanged(const char* channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) { - (void)channel; - (void)uid; - (void)oldState; - (void)newState; - (void)elapseSinceLastState; - } + /** Occurs when the video publishing state changes. + * + * @since v3.1.0 + * + * This callback indicates the publishing state change of the local video stream. + * + * @param channel The channel name. + * @param oldState The previous publishing state. For details, see #STREAM_PUBLISH_STATE. + * @param newState The current publishing state. For details, see #STREAM_PUBLISH_STATE. + * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state. + */ + virtual void onVideoPublishStateChanged(const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) { + (void)channel; + (void)oldState; + (void)newState; + (void)elapseSinceLastState; + } - /** Occurs when the audio subscribing state changes. - * - * @since v3.1.0 - * - * This callback indicates the subscribing state change of a remote video stream. - * - * @param channel The channel name. - * @param uid The ID of the remote user. - * @param oldState The previous subscribing state. For details, see #STREAM_SUBSCRIBE_STATE. - * @param newState The current subscribing state. For details, see #STREAM_SUBSCRIBE_STATE. - * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state. - */ - virtual void onVideoSubscribeStateChanged(const char* channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) { - (void)channel; - (void)uid; - (void)oldState; - (void)newState; - (void)elapseSinceLastState; - } + /** Occurs when the audio subscribing state changes. + * + * @since v3.1.0 + * + * This callback indicates the subscribing state change of a remote audio stream. + * + * @param channel The channel name. + * @param uid The ID of the remote user. + * @param oldState The previous subscribing state. For details, see #STREAM_SUBSCRIBE_STATE. + * @param newState The current subscribing state. For details, see #STREAM_SUBSCRIBE_STATE. + * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state. + */ + virtual void onAudioSubscribeStateChanged(const char* channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) { + (void)channel; + (void)uid; + (void)oldState; + (void)newState; + (void)elapseSinceLastState; + } - /** Reports which users are speaking, the speakers' volume and whether the local user is speaking. - - This callback reports the IDs and volumes of the loudest speakers (at most 3 users) at the moment in the channel, and whether the local user is speaking. - - By default, this callback is disabled. You can enable it by calling the \ref IRtcEngine::enableAudioVolumeIndication(int, int, bool) "enableAudioVolumeIndication" method. - Once enabled, this callback is triggered at the set interval, regardless of whether a user speaks or not. - - The SDK triggers two independent `onAudioVolumeIndication` callbacks at one time, which separately report the volume information of the local user and all the remote speakers. - For more information, see the detailed parameter descriptions. - - @note - - To enable the voice activity detection of the local user, ensure that you set `report_vad`(true) in the `enableAudioVolumeIndication` method. - - Calling the \ref agora::rtc::IRtcEngine::muteLocalAudioStream "muteLocalAudioStream" method affects the SDK's behavior: - - If the local user calls the \ref agora::rtc::IRtcEngine::muteLocalAudioStream "muteLocalAudioStream" method, the SDK stops triggering the local user's callback. - - 20 seconds after a remote speaker calls the *muteLocalAudioStream* method, the remote speakers' callback excludes this remote user's information; 20 seconds after all remote users call the *muteLocalAudioStream* method, the SDK stops triggering the remote speakers' callback. - - An empty @p speakers array in the *onAudioVolumeIndication* callback suggests that no remote user is speaking at the moment. - - @param speakers A pointer to AudioVolumeInfo: - - In the local user's callback, this struct contains the following members: - - `uid` = 0, - - `volume` = `totalVolume`, which reports the sum of the voice volume and audio-mixing volume of the local user, and - - `vad`, which reports the voice activity status of the local user. - - In the remote speakers' callback, this array contains the following members: - - `uid` of the remote speaker, - - `volume`, which reports the sum of the voice volume and audio-mixing volume of each remote speaker, and - - `vad` = 0. - - An empty speakers array in the callback indicates that no remote user is speaking at the moment. - @param speakerNumber Total number of speakers. The value range is [0, 3]. - - In the local user’s callback, `speakerNumber` = 1, regardless of whether the local user speaks or not. - - In the remote speakers' callback, the callback reports the IDs and volumes of the three loudest speakers when there are more than three remote users in the channel, and `speakerNumber` = 3. - @param totalVolume Total volume after audio mixing. The value ranges between 0 (lowest volume) and 255 (highest volume). - - In the local user’s callback, `totalVolume` is the sum of the voice volume and audio-mixing volume of the local user. - - In the remote speakers' callback, `totalVolume` is the sum of the voice volume and audio-mixing volume of all the remote speakers. - */ - virtual void onAudioVolumeIndication(const AudioVolumeInfo* speakers, unsigned int speakerNumber, int totalVolume) { - (void)speakers; - (void)speakerNumber; - (void)totalVolume; - } + /** Occurs when the audio subscribing state changes. + * + * @since v3.1.0 + * + * This callback indicates the subscribing state change of a remote video stream. + * + * @param channel The channel name. + * @param uid The ID of the remote user. + * @param oldState The previous subscribing state. For details, see #STREAM_SUBSCRIBE_STATE. + * @param newState The current subscribing state. For details, see #STREAM_SUBSCRIBE_STATE. + * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state. + */ + virtual void onVideoSubscribeStateChanged(const char* channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) { + (void)channel; + (void)uid; + (void)oldState; + (void)newState; + (void)elapseSinceLastState; + } - /** Occurs when the most active speaker is detected. + /** Reports the volume information of users. + * + * By default, this callback is disabled. You can enable it by calling \ref IRtcEngine::enableAudioVolumeIndication(int, int, bool) "enableAudioVolumeIndication". + * Once this callback is enabled and users send streams in the channel, the SDK triggers the `onAudioVolumeIndication` callback + * at the time interval set in `enableAudioVolumeIndication`. + * + * The SDK triggers two independent `onAudioVolumeIndication` callbacks simultaneously, which separately report the + * volume information of the local user who sends a stream and the remote users (up to three) whose instantaneous + * volumes are the highest. + * + * @note After you enable this callback, calling \ref agora::rtc::IRtcEngine::muteLocalAudioStream "muteLocalAudioStream" + * affects the SDK's behavior as follows: + * - If the local user calls `muteLocalAudioStream`, the SDK stops triggering the local user's callback. + * - 20 seconds after a remote user whose volume is one of the three highest calls `muteLocalAudioStream`, the + * remote users' callback excludes this remote user's information; 20 seconds after all remote users call + * `muteLocalAudioStream`, the SDK stops triggering the remote users' callback. + * + * @param speakers The volume information of users. See AudioVolumeInfo. + * + * An empty speakers array in the callback indicates that no remote user is in the channel or sending a stream at the moment. + * @param speakerNumber Total number of users. + * - In the local user's callback, when the local user sends a stream, `speakerNumber = 1`. + * - In the remote users' callback, the value ranges between 0 and 3. If the number of remote users who send + * streams is greater than or equal to three, `speakerNumber = 3`. + * @param totalVolume Total volume after audio mixing. The value ranges between 0 (lowest volume) and 255 (highest volume). + * - In the local user's callback, totalVolume is the volume of the local user who sends a stream. + * - In the remote users' callback, totalVolume is the sum of the volume of all remote users (up to three) whose + * instantaneous volumes are the highest. + * + * If the user calls \ref IRtcEngine::startAudioMixing(const char*,bool,bool,int,int) "startAudioMixing", `totalVolume` is the sum of + * the voice volume and audio-mixing volume. + */ + virtual void onAudioVolumeIndication(const AudioVolumeInfo* speakers, unsigned int speakerNumber, int totalVolume) { + (void)speakers; + (void)speakerNumber; + (void)totalVolume; + } - After a successful call of \ref IRtcEngine::enableAudioVolumeIndication(int, int, bool) "enableAudioVolumeIndication", - the SDK continuously detects which remote user has the loudest volume. During the current period, the remote user, - who is detected as the loudest for the most times, is the most active user. + /** Occurs when the most active speaker is detected. - When the number of user is no less than two and an active speaker exists, the SDK triggers this callback and reports the `uid` of the most active speaker. - - If the most active speaker is always the same user, the SDK triggers this callback only once. - - If the most active speaker changes to another user, the SDK triggers this callback again and reports the `uid` of the new active speaker. + After a successful call of \ref IRtcEngine::enableAudioVolumeIndication(int, int, bool) "enableAudioVolumeIndication", + the SDK continuously detects which remote user has the loudest volume. During the current period, the remote user, + who is detected as the loudest for the most times, is the most active user. - @param uid The user ID of the most active speaker. - */ - virtual void onActiveSpeaker(uid_t uid) { - (void)uid; - } + When the number of user is no less than two and an active speaker exists, the SDK triggers this callback and reports the `uid` of the most active speaker. + - If the most active speaker is always the same user, the SDK triggers this callback only once. + - If the most active speaker changes to another user, the SDK triggers this callback again and reports the `uid` of the new active speaker. - /** **DEPRECATED** Occurs when the video stops playing. + @param uid The user ID of the most active speaker. + */ + virtual void onActiveSpeaker(uid_t uid) { (void)uid; } - The application can use this callback to change the configuration of the view (for example, displaying other pictures in the view) after the video stops playing. + /** **DEPRECATED** Occurs when the video stops playing. - Deprecated as of v2.4.1. Use LOCAL_VIDEO_STREAM_STATE_STOPPED(0) in the \ref agora::rtc::IRtcEngineEventHandler::onLocalVideoStateChanged "onLocalVideoStateChanged" callback instead. - */ - virtual void onVideoStopped() {} - - /** Occurs when the first local video frame is displayed/rendered on the local video view. - - @param width Width (px) of the first local video frame. - @param height Height (px) of the first local video frame. - @param elapsed Time elapsed (ms) from the local user calling the \ref IRtcEngine::joinChannel "joinChannel" method until the SDK triggers this callback. - If you call the \ref IRtcEngine::startPreview "startPreview" method before calling the *joinChannel* method, then @p elapsed is the time elapsed from calling the *startPreview* method until the SDK triggers this callback. - */ - virtual void onFirstLocalVideoFrame(int width, int height, int elapsed) { - (void)width; - (void)height; - (void)elapsed; - } + The application can use this callback to change the configuration of the view (for example, displaying other pictures in the view) after the video stops playing. - /** Occurs when the first video frame is published. - * - * @since v3.1.0 - * - * The SDK triggers this callback under one of the following circumstances: - * - The local client enables the video module and calls \ref IRtcEngine::joinChannel "joinChannel" successfully. - * - The local client calls \ref IRtcEngine::muteLocalVideoStream "muteLocalVideoStream(true)" and \ref IRtcEngine::muteLocalVideoStream "muteLocalVideoStream(false)" in sequence. - * - The local client calls \ref IRtcEngine::disableVideo "disableVideo" and \ref IRtcEngine::enableVideo "enableVideo" in sequence. - * - * @param elapsed The time elapsed (ms) from the local client calling \ref IRtcEngine::joinChannel "joinChannel" until the SDK triggers this callback. - */ - virtual void onFirstLocalVideoFramePublished(int elapsed) { - (void)elapsed; - } + Deprecated as of v2.4.1. Use LOCAL_VIDEO_STREAM_STATE_STOPPED(0) in the \ref agora::rtc::IRtcEngineEventHandler::onLocalVideoStateChanged "onLocalVideoStateChanged" callback instead. + */ + virtual void onVideoStopped() {} - /** Occurs when the first remote video frame is received and decoded. - * - * @deprecated v2.9.0 - * - * This callback is deprecated and replaced by the - * \ref onRemoteVideoStateChanged() "onRemoteVideoStateChanged" callback - * with the following parameters: - * - #REMOTE_VIDEO_STATE_STARTING (1) - * - #REMOTE_VIDEO_STATE_DECODING (2) - * - * This callback is triggered in either of the following scenarios: - * - * - The remote user joins the channel and sends the video stream. - * - The remote user stops sending the video stream and re-sends it after - * 15 seconds. Reasons for such an interruption include: - * - The remote user leaves the channel. - * - The remote user drops offline. - * - The remote user calls the - * \ref agora::rtc::IRtcEngine::muteLocalVideoStream "muteLocalVideoStream" - * method to stop sending the video stream. - * - The remote user calls the - * \ref agora::rtc::IRtcEngine::disableVideo "disableVideo" method to - * disable video. - * - * The application can configure the user view settings in this callback. - * - * @param uid User ID of the remote user sending the video stream. - * @param width Width (px) of the video stream. - * @param height Height (px) of the video stream. - * @param elapsed Time elapsed (ms) from the local user calling the - * \ref IRtcEngine::joinChannel "joinChannel" method until the SDK - * triggers this callback. - */ - virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed) { - (void)uid; - (void)width; - (void)height; - (void)elapsed; - } + /** Occurs when the first local video frame is displayed/rendered on the local video view. - /** Occurs when the first remote video frame is rendered. - The SDK triggers this callback when the first frame of the remote video is displayed in the user's video window. The application can retrieve the time elapsed from a user joining the channel until the first video frame is displayed. - - @param uid User ID of the remote user sending the video stream. - @param width Width (px) of the video frame. - @param height Height (px) of the video stream. - @param elapsed Time elapsed (ms) from the local user calling the \ref IRtcEngine::joinChannel "joinChannel" method until the SDK triggers this callback. - */ - virtual void onFirstRemoteVideoFrame(uid_t uid, int width, int height, int elapsed) { - (void)uid; - (void)width; - (void)height; - (void)elapsed; - } + @param width Width (px) of the first local video frame. + @param height Height (px) of the first local video frame. + @param elapsed Time elapsed (ms) from the local user calling the \ref IRtcEngine::joinChannel "joinChannel" method until the SDK triggers this callback. + If you call the \ref IRtcEngine::startPreview "startPreview" method before calling the *joinChannel* method, then @p elapsed is the time elapsed from calling the *startPreview* method until the SDK triggers this callback. + */ + virtual void onFirstLocalVideoFrame(int width, int height, int elapsed) { + (void)width; + (void)height; + (void)elapsed; + } - /** @deprecated This method is deprecated from v3.0.0, use the \ref agora::rtc::IRtcEngineEventHandler::onRemoteAudioStateChanged "onRemoteAudioStateChanged" callback instead. + /** Occurs when the first video frame is published. + * + * @since v3.1.0 + * + * The SDK triggers this callback under one of the following circumstances: + * - The local client enables the video module and calls \ref IRtcEngine::joinChannel "joinChannel" successfully. + * - The local client calls \ref IRtcEngine::muteLocalVideoStream "muteLocalVideoStream(true)" and \ref IRtcEngine::muteLocalVideoStream "muteLocalVideoStream(false)" in sequence. + * - The local client calls \ref IRtcEngine::disableVideo "disableVideo" and \ref IRtcEngine::enableVideo "enableVideo" in sequence. + * - The local client calls \ref agora::media::IMediaEngine::pushVideoFrame "pushVideoFrame" to successfully push the video frame to the SDK. + * + * @param elapsed The time elapsed (ms) from the local client calling \ref IRtcEngine::joinChannel "joinChannel" until the SDK triggers this callback. + */ + virtual void onFirstLocalVideoFramePublished(int elapsed) { (void)elapsed; } - Occurs when a remote user's audio stream playback pauses/resumes. + /** Occurs when the first remote video frame is received and decoded. + * + * @deprecated v2.9.0 + * + * This callback is deprecated and replaced by the + * \ref onRemoteVideoStateChanged() "onRemoteVideoStateChanged" callback + * with the following parameters: + * - #REMOTE_VIDEO_STATE_STARTING (1) + * - #REMOTE_VIDEO_STATE_DECODING (2) + * + * This callback is triggered in either of the following scenarios: + * + * - The remote user joins the channel and sends the video stream. + * - The remote user stops sending the video stream and re-sends it after + * 15 seconds. Reasons for such an interruption include: + * - The remote user leaves the channel. + * - The remote user drops offline. + * - The remote user calls the + * \ref agora::rtc::IRtcEngine::muteLocalVideoStream "muteLocalVideoStream" + * method to stop sending the video stream. + * - The remote user calls the + * \ref agora::rtc::IRtcEngine::disableVideo "disableVideo" method to + * disable video. + * + * The application can configure the user view settings in this callback. + * + * @param uid User ID of the remote user sending the video stream. + * @param width Width (px) of the video stream. + * @param height Height (px) of the video stream. + * @param elapsed Time elapsed (ms) from the local user calling the + * \ref IRtcEngine::joinChannel "joinChannel" method until the SDK + * triggers this callback. + */ + virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed) { + (void)uid; + (void)width; + (void)height; + (void)elapsed; + } - The SDK triggers this callback when the remote user stops or resumes sending the audio stream by calling the \ref agora::rtc::IRtcEngine::muteLocalAudioStream "muteLocalAudioStream" method. + /** Occurs when the first remote video frame is rendered. + The SDK triggers this callback when the first frame of the remote video is displayed in the user's video window. The application can get the time elapsed from a user joining the channel until the first video frame is displayed. - @note This callback does not work properly when the number of users (in the `COMMUNICATION` profile) or hosts (in the `LIVE_BROADCASTING` profile) in the channel exceeds 17. + @param uid User ID of the remote user sending the video stream. + @param width Width (px) of the video frame. + @param height Height (px) of the video stream. + @param elapsed Time elapsed (ms) from the local user calling the \ref IRtcEngine::joinChannel "joinChannel" method until the SDK triggers this callback. + */ + virtual void onFirstRemoteVideoFrame(uid_t uid, int width, int height, int elapsed) { + (void)uid; + (void)width; + (void)height; + (void)elapsed; + } - @param uid User ID of the remote user. - @param muted Whether the remote user's audio stream is muted/unmuted: - - true: Muted. - - false: Unmuted. - */ - virtual void onUserMuteAudio(uid_t uid, bool muted) { - (void)uid; - (void)muted; - } + /** Occurs when a remote user's audio stream playback pauses/resumes. + * + * The SDK triggers this callback when the remote user stops or resumes sending the audio stream by calling the \ref agora::rtc::IRtcEngine::muteLocalAudioStream "muteLocalAudioStream" method. + * + * @note This callback does not work properly when the number of users (in the `COMMUNICATION` profile) or hosts (in the `LIVE_BROADCASTING` profile) in the channel exceeds 17. + * + * @param uid User ID of the remote user. + * @param muted Whether the remote user's audio stream is muted/unmuted: + * - true: Muted. + * - false: Unmuted. + */ + virtual void onUserMuteAudio(uid_t uid, bool muted) { + (void)uid; + (void)muted; + } - /** Occurs when a remote user's video stream playback pauses/resumes. - * - * You can also use the - * \ref onRemoteVideoStateChanged() "onRemoteVideoStateChanged" callback - * with the following parameters: - * - #REMOTE_VIDEO_STATE_STOPPED (0) and - * #REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED (5). - * - #REMOTE_VIDEO_STATE_DECODING (2) and - * #REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED (6). - * - * The SDK triggers this callback when the remote user stops or resumes - * sending the video stream by calling the - * \ref agora::rtc::IRtcEngine::muteLocalVideoStream - * "muteLocalVideoStream" method. - * - * @note This callback does not work properly when the number of users (in the `COMMUNICATION` profile) or hosts (in the `LIVE_BROADCASTING` profile) in the channel exceeds 17. - * - * @param uid User ID of the remote user. - * @param muted Whether the remote user's video stream playback is - * paused/resumed: - * - true: Paused. - * - false: Resumed. - */ - virtual void onUserMuteVideo(uid_t uid, bool muted) { - (void)uid; - (void)muted; - } + /** Occurs when a remote user's video stream playback pauses/resumes. + * + * The SDK triggers this callback when the remote user stops or resumes + * sending the video stream by calling the + * \ref agora::rtc::IRtcEngine::muteLocalVideoStream + * "muteLocalVideoStream" method. + * + * @note This callback does not work properly when the number of users (in the `COMMUNICATION` profile) or hosts (in the `LIVE_BROADCASTING` profile) in the channel exceeds 17. + * + * @param uid User ID of the remote user. + * @param muted Whether the remote user's video stream playback is + * paused/resumed: + * - true: Paused. + * - false: Resumed. + */ + virtual void onUserMuteVideo(uid_t uid, bool muted) { + (void)uid; + (void)muted; + } - /** Occurs when a specific remote user enables/disables the video - * module. - * - * @deprecated v2.9.0 - * - * This callback is deprecated and replaced by the - * \ref onRemoteVideoStateChanged() "onRemoteVideoStateChanged" callback - * with the following parameters: - * - #REMOTE_VIDEO_STATE_STOPPED (0) and - * #REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED (5). - * - #REMOTE_VIDEO_STATE_DECODING (2) and - * #REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED (6). - * - * Once the video module is disabled, the remote user can only use a - * voice call. The remote user cannot send or receive any video from - * other users. - * - * The SDK triggers this callback when the remote user enables or disables - * the video module by calling the - * \ref agora::rtc::IRtcEngine::enableVideo "enableVideo" or - * \ref agora::rtc::IRtcEngine::disableVideo "disableVideo" method. - * - * @note This callback returns invalid when the number of users in a - * channel exceeds 20. - * - * @param uid User ID of the remote user. - * @param enabled Whether the remote user enables/disables the video - * module: - * - true: Enable. The remote user can enter a video session. - * - false: Disable. The remote user can only enter a voice session, and - * cannot send or receive any video stream. - */ - virtual void onUserEnableVideo(uid_t uid, bool enabled) { - (void)uid; - (void)enabled; - } + /** Occurs when a specific remote user enables/disables the video + * module. + * + * Once the video module is disabled, the remote user can only use a + * voice call. The remote user cannot send or receive any video from + * other users. + * + * The SDK triggers this callback when the remote user enables or disables + * the video module by calling the + * \ref agora::rtc::IRtcEngine::enableVideo "enableVideo" or + * \ref agora::rtc::IRtcEngine::disableVideo "disableVideo" method. + * + * @note This callback returns invalid when the number of users in a + * channel exceeds 20. + * + * @param uid User ID of the remote user. + * @param enabled Whether the remote user enables/disables the video + * module: + * - true: Enable. The remote user can enter a video session. + * - false: Disable. The remote user can only enter a voice session, and + * cannot send or receive any video stream. + */ + virtual void onUserEnableVideo(uid_t uid, bool enabled) { + (void)uid; + (void)enabled; + } - /** Occurs when the audio device state changes. + /** Occurs when the audio device state changes. - This callback notifies the application that the system's audio device state is changed. For example, a headset is unplugged from the device. + This callback notifies the application that the system's audio device state is changed. For example, a headset is unplugged from the device. - @param deviceId Pointer to the device ID. - @param deviceType Device type: #MEDIA_DEVICE_TYPE. - @param deviceState Device state: #MEDIA_DEVICE_STATE_TYPE. - */ - virtual void onAudioDeviceStateChanged(const char* deviceId, int deviceType, int deviceState) { - (void)deviceId; - (void)deviceType; - (void)deviceState; - } + @param deviceId Pointer to the device ID. + @param deviceType Device type: #MEDIA_DEVICE_TYPE. + @param deviceState Device state: #MEDIA_DEVICE_STATE_TYPE. + */ + virtual void onAudioDeviceStateChanged(const char* deviceId, int deviceType, int deviceState) { + (void)deviceId; + (void)deviceType; + (void)deviceState; + } - /** Occurs when the volume of the playback device, microphone, or application changes. + /** Occurs when the volume of the playback device, microphone, or application changes. - @param deviceType Device type: #MEDIA_DEVICE_TYPE. - @param volume Volume of the device. The value ranges between 0 and 255. - @param muted - - true: The audio device is muted. - - false: The audio device is not muted. - */ - virtual void onAudioDeviceVolumeChanged(MEDIA_DEVICE_TYPE deviceType, int volume, bool muted) { - (void)deviceType; - (void)volume; - (void)muted; - } + @param deviceType Device type: #MEDIA_DEVICE_TYPE. + @param volume Volume of the device. The value ranges between 0 and 255. + @param muted + - true: The audio device is muted. + - false: The audio device is not muted. + */ + virtual void onAudioDeviceVolumeChanged(MEDIA_DEVICE_TYPE deviceType, int volume, bool muted) { + (void)deviceType; + (void)volume; + (void)muted; + } - /** **DEPRECATED** Occurs when the camera turns on and is ready to capture the video. + /** **DEPRECATED** Occurs when the camera turns on and is ready to capture the video. - If the camera fails to turn on, fix the error reported in the \ref IRtcEngineEventHandler::onError "onError" callback. + If the camera fails to turn on, fix the error reported in the \ref IRtcEngineEventHandler::onError "onError" callback. - Deprecated as of v2.4.1. Use #LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) in the \ref agora::rtc::IRtcEngineEventHandler::onLocalVideoStateChanged "onLocalVideoStateChanged" callback instead. - */ - virtual void onCameraReady() {} + Deprecated as of v2.4.1. Use #LOCAL_VIDEO_STREAM_STATE_CAPTURING (1) in the \ref agora::rtc::IRtcEngineEventHandler::onLocalVideoStateChanged "onLocalVideoStateChanged" callback instead. + */ + virtual void onCameraReady() {} - /** Occurs when the camera focus area changes. + /** Occurs when the camera focus area changes. - The SDK triggers this callback when the local user changes the camera focus position by calling the setCameraFocusPositionInPreview method. + The SDK triggers this callback when the local user changes the camera focus position by calling the setCameraFocusPositionInPreview method. - @note This callback is for Android and iOS only. + @note This callback is for Android and iOS only. - @param x x coordinate of the changed camera focus area. - @param y y coordinate of the changed camera focus area. - @param width Width of the changed camera focus area. - @param height Height of the changed camera focus area. - */ - virtual void onCameraFocusAreaChanged(int x, int y, int width, int height) { - (void)x; - (void)y; - (void)width; - (void)height; - } + @param x x coordinate of the changed camera focus area. + @param y y coordinate of the changed camera focus area. + @param width Width of the changed camera focus area. + @param height Height of the changed camera focus area. + */ + virtual void onCameraFocusAreaChanged(int x, int y, int width, int height) { + (void)x; + (void)y; + (void)width; + (void)height; + } #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) - /** - * Reports the face detection result of the local user. Applies to Android and iOS only. - * @since v3.0.1 - * - * Once you enable face detection by calling \ref IRtcEngine::enableFaceDetection "enableFaceDetection"(true), you can get the following information on the local user in real-time: - * - The width and height of the local video. - * - The position of the human face in the local video. - * - The distance between the human face and the device screen. This value is based on the fitting calculation of the local video size and the position of the human face. - * - * @note - * - If the SDK does not detect a face, it reduces the frequency of this callback to reduce power consumption on the local device. - * - The SDK stops triggering this callback when a human face is in close proximity to the screen. - * - On Android, the `distance` value reported in this callback may be slightly different from the actual distance. Therefore, Agora does not recommend using it for - * accurate calculation. - * @param imageWidth The width (px) of the local video. - * @param imageHeight The height (px) of the local video. - * @param vecRectangle The position and size of the human face on the local video: - * - `x`: The x coordinate (px) of the human face in the local video. Taking the top left corner of the captured video as the origin, - * the x coordinate represents the relative lateral displacement of the top left corner of the human face to the origin. - * - `y`: The y coordinate (px) of the human face in the local video. Taking the top left corner of the captured video as the origin, - * the y coordinate represents the relative longitudinal displacement of the top left corner of the human face to the origin. - * - `width`: The width (px) of the human face in the captured video. - * - `height`: The height (px) of the human face in the captured video. - * @param vecDistance The distance (cm) between the human face and the screen. - * @param numFaces The number of faces detected. If the value is 0, it means that no human face is detected. - */ - virtual void onFacePositionChanged(int imageWidth, int imageHeight, Rectangle* vecRectangle, int* vecDistance, int numFaces){ - (void)imageWidth; - (void)imageHeight; - (void)vecRectangle; - (void)vecDistance; - (void)numFaces; - } + /** + * Reports the face detection result of the local user. Applies to Android and iOS only. + * @since v3.0.1 + * + * Once you enable face detection by calling \ref IRtcEngine::enableFaceDetection "enableFaceDetection"(true), you can get the following information on the local user in real-time: + * - The width and height of the local video. + * - The position of the human face in the local video. + * - The distance between the human face and the device screen. This value is based on the fitting calculation of the local video size and the position of the human face. + * + * @note + * - If the SDK does not detect a face, it reduces the frequency of this callback to reduce power consumption on the local device. + * - The SDK stops triggering this callback when a human face is in close proximity to the screen. + * - On Android, the `distance` value reported in this callback may be slightly different from the actual distance. Therefore, Agora does not recommend using it for + * accurate calculation. + * @param imageWidth The width (px) of the local video. + * @param imageHeight The height (px) of the local video. + * @param vecRectangle The position and size of the human face on the local video: + * - `x`: The x coordinate (px) of the human face in the local video. Taking the top left corner of the captured video as the origin, + * the x coordinate represents the relative lateral displacement of the top left corner of the human face to the origin. + * - `y`: The y coordinate (px) of the human face in the local video. Taking the top left corner of the captured video as the origin, + * the y coordinate represents the relative longitudinal displacement of the top left corner of the human face to the origin. + * - `width`: The width (px) of the human face in the captured video. + * - `height`: The height (px) of the human face in the captured video. + * @param vecDistance The distance (cm) between the human face and the screen. + * @param numFaces The number of faces detected. If the value is 0, it means that no human face is detected. + */ + virtual void onFacePositionChanged(int imageWidth, int imageHeight, Rectangle* vecRectangle, int* vecDistance, int numFaces) { + (void)imageWidth; + (void)imageHeight; + (void)vecRectangle; + (void)vecDistance; + (void)numFaces; + } #endif - /** Occurs when the camera exposure area changes. - - The SDK triggers this callback when the local user changes the camera exposure position by calling the setCameraExposurePosition method. - - @note This callback is for Android and iOS only. - - @param x x coordinate of the changed camera exposure area. - @param y y coordinate of the changed camera exposure area. - @param width Width of the changed camera exposure area. - @param height Height of the changed camera exposure area. - */ - virtual void onCameraExposureAreaChanged(int x, int y, int width, int height) { - (void)x; - (void)y; - (void)width; - (void)height; - } + /** Occurs when the camera exposure area changes. - /** Occurs when the audio mixing file playback finishes. + The SDK triggers this callback when the local user changes the camera exposure position by calling the setCameraExposurePosition method. - **DEPRECATED** use onAudioMixingStateChanged instead. + @note This callback is for Android and iOS only. - You can start an audio mixing file playback by calling the \ref IRtcEngine::startAudioMixing "startAudioMixing" method. The SDK triggers this callback when the audio mixing file playback finishes. - - If the *startAudioMixing* method call fails, an error code returns in the \ref IRtcEngineEventHandler::onError "onError" callback. + @param x x coordinate of the changed camera exposure area. + @param y y coordinate of the changed camera exposure area. + @param width Width of the changed camera exposure area. + @param height Height of the changed camera exposure area. + */ + virtual void onCameraExposureAreaChanged(int x, int y, int width, int height) { + (void)x; + (void)y; + (void)width; + (void)height; + } - */ - virtual void onAudioMixingFinished() { - } + /** Occurs when the audio mixing file playback finishes. - /** Occurs when the state of the local user's audio mixing file changes. + **DEPRECATED** use onAudioMixingStateChanged instead. - When you call the \ref IRtcEngine::startAudioMixing "startAudioMixing" method and the state of audio mixing file changes, the SDK triggers this callback. - - When the audio mixing file plays, pauses playing, or stops playing, this callback returns 710, 711, or 713 in @p state, and 0 in @p errorCode. - - When exceptions occur during playback, this callback returns 714 in @p state and an error in @p errorCode. - - If the local audio mixing file does not exist, or if the SDK does not support the file format or cannot access the music file URL, the SDK returns WARN_AUDIO_MIXING_OPEN_ERROR = 701. + You can start an audio mixing file playback by calling the \ref IRtcEngine::startAudioMixing(const char*,bool,bool,int,int) "startAudioMixing" method. The SDK triggers this callback when the audio mixing file playback finishes. - @param state The state code. See #AUDIO_MIXING_STATE_TYPE. - @param errorCode The error code. See #AUDIO_MIXING_ERROR_TYPE. - */ - virtual void onAudioMixingStateChanged(AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_ERROR_TYPE errorCode){ - } - /** Occurs when a remote user starts audio mixing. + If the *startAudioMixing* method call fails, an error code returns in the \ref IRtcEngineEventHandler::onError "onError" callback. - When a remote user calls \ref IRtcEngine::startAudioMixing "startAudioMixing" to play the background music, the SDK reports this callback. - */ - virtual void onRemoteAudioMixingBegin() { - } - /** Occurs when a remote user finishes audio mixing. - */ - virtual void onRemoteAudioMixingEnd() { - } + */ + virtual void onAudioMixingFinished() {} - /** Occurs when the local audio effect playback finishes. + /** Occurs when the state of the local user's music file changes. + * + * @since v3.4.0 + * + * When the playback state of the local user's music file changes, the SDK triggers this callback and + * reports the current playback state and the reason for the change. + * + * @param state The current music file playback state. See #AUDIO_MIXING_STATE_TYPE. + * @param reason The reason for the change of the music file playback state. See #AUDIO_MIXING_REASON_TYPE. + */ + virtual void onAudioMixingStateChanged(AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_REASON_TYPE reason) {} + /** Occurs when a remote user starts audio mixing. - The SDK triggers this callback when the local audio effect file playback finishes. + When a remote user calls \ref IRtcEngine::startAudioMixing(const char*,bool,bool,int,int) "startAudioMixing" to play the background music, the SDK reports this callback. + */ + virtual void onRemoteAudioMixingBegin() {} + /** Occurs when a remote user finishes audio mixing. + */ + virtual void onRemoteAudioMixingEnd() {} - @param soundId ID of the local audio effect. Each local audio effect has a unique ID. - */ - virtual void onAudioEffectFinished(int soundId) { - } + /** Occurs when the local audio effect playback finishes. + The SDK triggers this callback when the local audio effect file playback finishes. - /** - Occurs when the SDK decodes the first remote audio frame for playback. + @param soundId ID of the local audio effect. Each local audio effect has a unique ID. + */ + virtual void onAudioEffectFinished(int soundId) {} + /// @cond + /** Occurs when AirPlay is connected. + */ + virtual void onAirPlayConnected() {} + /// @endcond - @deprecated v3.0.0 + /** + Occurs when the SDK decodes the first remote audio frame for playback. - This callback is deprecated. Use `onRemoteAudioStateChanged` instead. + @deprecated v3.0.0 - This callback is triggered in either of the following scenarios: + This callback is deprecated. Use `onRemoteAudioStateChanged` instead. - - The remote user joins the channel and sends the audio stream. - - The remote user stops sending the audio stream and re-sends it after 15 seconds. Reasons for such an interruption include: - - The remote user leaves channel. - - The remote user drops offline. - - The remote user calls the \ref agora::rtc::IRtcEngine::muteLocalAudioStream "muteLocalAudioStream" method to stop sending the local audio stream. - - The remote user calls the \ref agora::rtc::IRtcEngine::disableAudio "disableAudio" method to disable audio. + This callback is triggered in either of the following scenarios: - @param uid User ID of the remote user sending the audio stream. - @param elapsed Time elapsed (ms) from the local user calling the \ref IRtcEngine::joinChannel "joinChannel" method until the SDK triggers this callback. - */ - virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed) { - (void)uid; - (void)elapsed; - } + - The remote user joins the channel and sends the audio stream. + - The remote user stops sending the audio stream and re-sends it after 15 seconds. Reasons for such an interruption include: + - The remote user leaves channel. + - The remote user drops offline. + - The remote user calls the \ref agora::rtc::IRtcEngine::muteLocalAudioStream "muteLocalAudioStream" method to stop sending the local audio stream. + - The remote user calls the \ref agora::rtc::IRtcEngine::disableAudio "disableAudio" method to disable audio. - /** Occurs when the video device state changes. + @param uid User ID of the remote user sending the audio stream. + @param elapsed Time elapsed (ms) from the local user calling the \ref IRtcEngine::joinChannel "joinChannel" method until the SDK triggers this callback. + */ + virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed) { + (void)uid; + (void)elapsed; + } - @note On a Windows device with an external camera for video capturing, the video disables once the external camera is unplugged. + /** Occurs when the video device state changes. - @param deviceId Pointer to the device ID of the video device that changes state. - @param deviceType Device type: #MEDIA_DEVICE_TYPE. - @param deviceState Device state: #MEDIA_DEVICE_STATE_TYPE. - */ - virtual void onVideoDeviceStateChanged(const char* deviceId, int deviceType, int deviceState) { - (void)deviceId; - (void)deviceType; - (void)deviceState; - } + @note On a Windows device with an external camera for video capturing, the video disables once the external camera is unplugged. - /** Occurs when the local video stream state changes. + @param deviceId Pointer to the device ID of the video device that changes state. + @param deviceType Device type: #MEDIA_DEVICE_TYPE. + @param deviceState Device state: #MEDIA_DEVICE_STATE_TYPE. + */ + virtual void onVideoDeviceStateChanged(const char* deviceId, int deviceType, int deviceState) { + (void)deviceId; + (void)deviceType; + (void)deviceState; + } - This callback indicates the state of the local video stream, including camera capturing and video encoding, and allows you to troubleshoot issues when exceptions occur. + /** Occurs when the local video stream state changes. + * + * This callback indicates the state of the local video stream, including camera capturing and video encoding, and allows you to troubleshoot issues when exceptions occur. + * + * The SDK triggers the `onLocalVideoStateChanged(LOCAL_VIDEO_STREAM_STATE_FAILED, LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE)` callback in the following situations: + * - The application exits to the background, and the system recycles the camera. + * - The camera starts normally, but the captured video is not output for four seconds. + * + * When the camera outputs the captured video frames, if all the video frames are the same for 15 consecutive frames, the SDK triggers the + * `onLocalVideoStateChanged(LOCAL_VIDEO_STREAM_STATE_CAPTURING, LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE)` callback. Note that the + * video frame duplication detection is only available for video frames with a resolution greater than 200 × 200, a frame rate greater than or equal to 10 fps, + * and a bitrate less than 20 Kbps. + * + * @note For some device models, the SDK will not trigger this callback when the state of the local video changes while the local video capturing device is in use, so you have to make your own timeout judgment. + * + * @param localVideoState State type #LOCAL_VIDEO_STREAM_STATE. + * @param error The detailed error information: #LOCAL_VIDEO_STREAM_ERROR. + */ + virtual void onLocalVideoStateChanged(LOCAL_VIDEO_STREAM_STATE localVideoState, LOCAL_VIDEO_STREAM_ERROR error) { + (void)localVideoState; + (void)error; + } - @note For some device models, the SDK will not trigger this callback when the state of the local video changes while the local video capturing device is in use, so you have to make your own timeout judgment. + /** Occurs when the video size or rotation of a specified user changes. - @param localVideoState State type #LOCAL_VIDEO_STREAM_STATE. When the state is LOCAL_VIDEO_STREAM_STATE_FAILED (3), see the `error` parameter for details. - @param error The detailed error information: #LOCAL_VIDEO_STREAM_ERROR. - */ - virtual void onLocalVideoStateChanged(LOCAL_VIDEO_STREAM_STATE localVideoState, LOCAL_VIDEO_STREAM_ERROR error) { - (void)localVideoState; - (void)error; - } + @param uid User ID of the remote user or local user (0) whose video size or rotation changes. + @param width New width (pixels) of the video. + @param height New height (pixels) of the video. + @param rotation New rotation of the video [0 to 360). + */ + virtual void onVideoSizeChanged(uid_t uid, int width, int height, int rotation) { + (void)uid; + (void)width; + (void)height; + (void)rotation; + } + /** Occurs when the remote video state changes. + @note This callback does not work properly when the number of users (in the `COMMUNICATION` profile) or hosts (in the `LIVE_BROADCASTING` profile) in the channel exceeds 17. + + @param uid ID of the remote user whose video state changes. + @param state State of the remote video. See #REMOTE_VIDEO_STATE. + @param reason The reason of the remote video state change. See + #REMOTE_VIDEO_STATE_REASON. + @param elapsed Time elapsed (ms) from the local user calling the + \ref agora::rtc::IRtcEngine::joinChannel "joinChannel" method until the + SDK triggers this callback. + */ + virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) { + (void)uid; + (void)state; + (void)reason; + (void)elapsed; + } - /** Occurs when the video size or rotation of a specified user changes. + /** Occurs when a specified remote user enables/disables the local video + * capturing function. + * + * This callback is only applicable to the scenario when the user only + * wants to watch the remote video without sending any video stream to the + * other user. + * + * The SDK triggers this callback when the remote user resumes or stops + * capturing the video stream by calling the + * \ref agora::rtc::IRtcEngine::enableLocalVideo "enableLocalVideo" method. + * + * @param uid User ID of the remote user. + * @param enabled Whether the specified remote user enables/disables the + * local video capturing function: + * - true: Enable. Other users in the channel can see the video of this + * remote user. + * - false: Disable. Other users in the channel can no longer receive the + * video stream from this remote user, while this remote user can still + * receive the video streams from other users. + */ + virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) { + (void)uid; + (void)enabled; + } - @param uid User ID of the remote user or local user (0) whose video size or rotation changes. - @param width New width (pixels) of the video. - @param height New height (pixels) of the video. - @param rotation New rotation of the video [0 to 360). - */ - virtual void onVideoSizeChanged(uid_t uid, int width, int height, int rotation) { - (void)uid; - (void)width; - (void)height; - (void)rotation; - } - /** Occurs when the remote video state changes. - @note This callback does not work properly when the number of users (in the `COMMUNICATION` profile) or hosts (in the `LIVE_BROADCASTING` profile) in the channel exceeds 17. - - @param uid ID of the remote user whose video state changes. - @param state State of the remote video. See #REMOTE_VIDEO_STATE. - @param reason The reason of the remote video state change. See - #REMOTE_VIDEO_STATE_REASON. - @param elapsed Time elapsed (ms) from the local user calling the - \ref agora::rtc::IRtcEngine::joinChannel "joinChannel" method until the - SDK triggers this callback. - */ - virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) { - (void)uid; - (void)state; - (void)reason; - (void)elapsed; - } + // virtual void onStreamError(int streamId, int code, int parameter, const char* message, size_t length) {} + /** Occurs when the local user receives the data stream from the remote user within five seconds. - /** Occurs when a specified remote user enables/disables the local video - * capturing function. - * - * @deprecated v2.9.0 - * - * This callback is deprecated and replaced by the - * \ref onRemoteVideoStateChanged() "onRemoteVideoStateChanged" callback - * with the following parameters: - * - #REMOTE_VIDEO_STATE_STOPPED (0) and - * #REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED (5). - * - #REMOTE_VIDEO_STATE_DECODING (2) and - * #REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED (6). - * - * This callback is only applicable to the scenario when the user only - * wants to watch the remote video without sending any video stream to the - * other user. - * - * The SDK triggers this callback when the remote user resumes or stops - * capturing the video stream by calling the - * \ref agora::rtc::IRtcEngine::enableLocalVideo "enableLocalVideo" method. - * - * @param uid User ID of the remote user. - * @param enabled Whether the specified remote user enables/disables the - * local video capturing function: - * - true: Enable. Other users in the channel can see the video of this - * remote user. - * - false: Disable. Other users in the channel can no longer receive the - * video stream from this remote user, while this remote user can still - * receive the video streams from other users. - */ - virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) { - (void)uid; - (void)enabled; - } + The SDK triggers this callback when the local user receives the stream message that the remote user sends by calling the \ref agora::rtc::IRtcEngine::sendStreamMessage "sendStreamMessage" method. + @param uid User ID of the remote user sending the message. + @param streamId Stream ID. + @param data Pointer to the data received by the local user. + @param length Length of the data in bytes. + */ + virtual void onStreamMessage(uid_t uid, int streamId, const char* data, size_t length) { + (void)uid; + (void)streamId; + (void)data; + (void)length; + } -// virtual void onStreamError(int streamId, int code, int parameter, const char* message, size_t length) {} - /** Occurs when the local user receives the data stream from the remote user within five seconds. - - The SDK triggers this callback when the local user receives the stream message that the remote user sends by calling the \ref agora::rtc::IRtcEngine::sendStreamMessage "sendStreamMessage" method. - @param uid User ID of the remote user sending the message. - @param streamId Stream ID. - @param data Pointer to the data received by the local user. - @param length Length of the data in bytes. - */ - virtual void onStreamMessage(uid_t uid, int streamId, const char* data, size_t length) { - (void)uid; - (void)streamId; - (void)data; - (void)length; - } + /** Occurs when the local user does not receive the data stream from the remote user within five seconds. - /** Occurs when the local user does not receive the data stream from the remote user within five seconds. +The SDK triggers this callback when the local user fails to receive the stream message that the remote user sends by calling the \ref agora::rtc::IRtcEngine::sendStreamMessage "sendStreamMessage" method. +@param uid User ID of the remote user sending the message. +@param streamId Stream ID. +@param code Error code: #ERROR_CODE_TYPE. +@param missed Number of lost messages. +@param cached Number of incoming cached messages when the data stream is interrupted. +*/ + virtual void onStreamMessageError(uid_t uid, int streamId, int code, int missed, int cached) { + (void)uid; + (void)streamId; + (void)code; + (void)missed; + (void)cached; + } - The SDK triggers this callback when the local user fails to receive the stream message that the remote user sends by calling the \ref agora::rtc::IRtcEngine::sendStreamMessage "sendStreamMessage" method. - @param uid User ID of the remote user sending the message. - @param streamId Stream ID. - @param code Error code: #ERROR_CODE_TYPE. - @param missed Number of lost messages. - @param cached Number of incoming cached messages when the data stream is interrupted. - */ - virtual void onStreamMessageError(uid_t uid, int streamId, int code, int missed, int cached) { - (void)uid; - (void)streamId; - (void)code; - (void)missed; - (void)cached; - } + /** Occurs when the media engine loads.*/ + virtual void onMediaEngineLoadSuccess() {} + /** Occurs when the media engine call starts.*/ + virtual void onMediaEngineStartCallSuccess() {} + /// @cond + /** Reports whether the super-resolution algorithm is enabled. + * + * @since v3.2.0 + * + * After calling \ref IRtcEngine::enableRemoteSuperResolution "enableRemoteSuperResolution", the SDK triggers this + * callback to report whether the super-resolution algorithm is successfully enabled. If not successfully enabled, + * you can use reason for troubleshooting. + * + * @param uid The ID of the remote user. + * @param enabled Whether the super-resolution algorithm is successfully enabled: + * - true: The super-resolution algorithm is successfully enabled. + * - false: The super-resolution algorithm is not successfully enabled. + * @param reason The reason why the super-resolution algorithm is not successfully enabled. See #SUPER_RESOLUTION_STATE_REASON. + */ + virtual void onUserSuperResolutionEnabled(uid_t uid, bool enabled, SUPER_RESOLUTION_STATE_REASON reason) { + (void)uid; + (void)enabled; + (void)reason; + } + /// @endcond - /** Occurs when the media engine loads.*/ - virtual void onMediaEngineLoadSuccess() { - } - /** Occurs when the media engine call starts.*/ - virtual void onMediaEngineStartCallSuccess() { - } - /// @cond - /** Reports whether the super-resolution algorithm is enabled. - * - * @since v3.2.0 - * - * After calling \ref IRtcEngine::enableRemoteSuperResolution "enableRemoteSuperResolution", the SDK triggers this - * callback to report whether the super-resolution algorithm is successfully enabled. If not successfully enabled, - * you can use reason for troubleshooting. - * - * @param uid The ID of the remote user. - * @param enabled Whether the super-resolution algorithm is successfully enabled: - * - true: The super-resolution algorithm is successfully enabled. - * - false: The super-resolution algorithm is not successfully enabled. - * @param reason The reason why the super-resolution algorithm is not successfully enabled. See #SUPER_RESOLUTION_STATE_REASON. - */ - virtual void onUserSuperResolutionEnabled(uid_t uid, bool enabled, SUPER_RESOLUTION_STATE_REASON reason) { - (void)uid; - (void)enabled; - (void)reason; - } - /// @endcond + /** Occurs when video background substitution success or failed.*/ + virtual void onVirtualBackgroundSourceEnabled(bool enabled, VIRTUAL_BACKGROUND_SOURCE_STATE_REASON reason) { + (void)enabled; + (void)reason; + } - /** Occurs when the state of the media stream relay changes. - * - * The SDK returns the state of the current media relay with any error - * message. - * - * @param state The state code in #CHANNEL_MEDIA_RELAY_STATE. - * @param code The error code in #CHANNEL_MEDIA_RELAY_ERROR. - */ - virtual void onChannelMediaRelayStateChanged(CHANNEL_MEDIA_RELAY_STATE state,CHANNEL_MEDIA_RELAY_ERROR code) { - } + /** Occurs when the state of the media stream relay changes. + * + * The SDK returns the state of the current media relay with any error + * message. + * + * @param state The state code in #CHANNEL_MEDIA_RELAY_STATE. + * @param code The error code in #CHANNEL_MEDIA_RELAY_ERROR. + */ + virtual void onChannelMediaRelayStateChanged(CHANNEL_MEDIA_RELAY_STATE state, CHANNEL_MEDIA_RELAY_ERROR code) {} - /** Reports events during the media stream relay. - * - * @param code The event code in #CHANNEL_MEDIA_RELAY_EVENT. - */ - virtual void onChannelMediaRelayEvent(CHANNEL_MEDIA_RELAY_EVENT code) { - } + /** Reports events during the media stream relay. + * + * @param code The event code in #CHANNEL_MEDIA_RELAY_EVENT. + */ + virtual void onChannelMediaRelayEvent(CHANNEL_MEDIA_RELAY_EVENT code) {} - /** Occurs when the engine sends the first local audio frame. + /** Occurs when the engine sends the first local audio frame. - @deprecated Deprecated as of v3.1.0. Use the \ref IRtcEngineEventHandler::onFirstLocalAudioFramePublished "onFirstLocalAudioFramePublished" callback instead. + @deprecated Deprecated as of v3.1.0. Use the \ref IRtcEngineEventHandler::onFirstLocalAudioFramePublished "onFirstLocalAudioFramePublished" callback instead. - @param elapsed Time elapsed (ms) from the local user calling \ref IRtcEngine::joinChannel "joinChannel" until the SDK triggers this callback. - */ - virtual void onFirstLocalAudioFrame(int elapsed) { - (void)elapsed; - } + @param elapsed Time elapsed (ms) from the local user calling \ref IRtcEngine::joinChannel "joinChannel" until the SDK triggers this callback. + */ + virtual void onFirstLocalAudioFrame(int elapsed) { (void)elapsed; } - /** Occurs when the first audio frame is published. - * - * @since v3.1.0 - * - * The SDK triggers this callback under one of the following circumstances: - * - The local client enables the audio module and calls \ref IRtcEngine::joinChannel "joinChannel" successfully. - * - The local client calls \ref IRtcEngine::muteLocalAudioStream "muteLocalAudioStream(true)" and \ref IRtcEngine::muteLocalAudioStream "muteLocalAudioStream(false)" in sequence. - * - The local client calls \ref IRtcEngine::disableAudio "disableAudio" and \ref IRtcEngine::enableAudio "enableAudio" in sequence. - * - * @param elapsed The time elapsed (ms) from the local client calling \ref IRtcEngine::joinChannel "joinChannel" until the SDK triggers this callback. - */ - virtual void onFirstLocalAudioFramePublished(int elapsed) { - (void)elapsed; - } + /** Occurs when the first audio frame is published. + * + * @since v3.1.0 + * + * The SDK triggers this callback under one of the following circumstances: + * - The local client enables the audio module and calls \ref IRtcEngine::joinChannel "joinChannel" successfully. + * - The local client calls \ref IRtcEngine::muteLocalAudioStream "muteLocalAudioStream(true)" and \ref IRtcEngine::muteLocalAudioStream "muteLocalAudioStream(false)" in sequence. + * - The local client calls \ref IRtcEngine::disableAudio "disableAudio" and \ref IRtcEngine::enableAudio "enableAudio" in sequence. + * - The local client calls \ref agora::media::IMediaEngine::pushAudioFrame "pushAudioFrame" to successfully push the video frame to the SDK. + * + * @param elapsed The time elapsed (ms) from the local client calling \ref IRtcEngine::joinChannel "joinChannel" until the SDK triggers this callback. + */ + virtual void onFirstLocalAudioFramePublished(int elapsed) { (void)elapsed; } - /** Occurs when the engine receives the first audio frame from a specific remote user. + /** Occurs when the engine receives the first audio frame from a specific remote user. - @deprecated v3.0.0 + @deprecated v3.0.0 - This callback is deprecated. Use `onRemoteAudioStateChanged` instead. + This callback is deprecated. Use `onRemoteAudioStateChanged` instead. - @param uid User ID of the remote user. - @param elapsed Time elapsed (ms) from the remote user calling \ref IRtcEngine::joinChannel "joinChannel" until the SDK triggers this callback. - */ - virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed) { - (void)uid; - (void)elapsed; - } + @param uid User ID of the remote user. + @param elapsed Time elapsed (ms) from the remote user calling \ref IRtcEngine::joinChannel "joinChannel" until the SDK triggers this callback. + */ + virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed) { + (void)uid; + (void)elapsed; + } /** - Occurs when the state of the RTMP streaming changes. + Occurs when the state of the RTMP or RTMPS streaming changes. The SDK triggers this callback to report the result of the local user calling the \ref agora::rtc::IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" or \ref agora::rtc::IRtcEngine::removePublishStreamUrl "removePublishStreamUrl" method. - This callback indicates the state of the RTMP streaming. When exceptions occur, you can troubleshoot issues by referring to the detailed error descriptions in the *errCode* parameter. + This callback indicates the state of the RTMP or RTMPS streaming. When exceptions occur, you can troubleshoot issues by referring to the detailed error descriptions in the *errCode* parameter. - @param url The RTMP URL address. - @param state The RTMP streaming state. See: #RTMP_STREAM_PUBLISH_STATE. + @param url The CDN streaming URL. + @param state The RTMP or RTMPS streaming state. See: #RTMP_STREAM_PUBLISH_STATE. @param errCode The detailed error information for streaming. See: #RTMP_STREAM_PUBLISH_ERROR. */ - virtual void onRtmpStreamingStateChanged(const char *url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_ERROR errCode) { - (void) url; - (void) state; - (void) errCode; + virtual void onRtmpStreamingStateChanged(const char* url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_ERROR errCode) { + (void)url; + (void)state; + (void)errCode; } - /** Reports events during the RTMP streaming. - * - * @since v3.1.0 - * - * @param url The RTMP streaming URL. - * @param eventCode The event code. See #RTMP_STREAMING_EVENT - */ + /** Reports events during the RTMP or RTMPS streaming. + * + * @since v3.1.0 + * + * @param url The RTMP or RTMPS streaming URL. + * @param eventCode The event code. See #RTMP_STREAMING_EVENT + */ virtual void onRtmpStreamingEvent(const char* url, RTMP_STREAMING_EVENT eventCode) { - (void) url; - (void) eventCode; + (void)url; + (void)eventCode; } - /** @deprecated This method is deprecated, use the \ref agora::rtc::IRtcEngineEventHandler::onRtmpStreamingStateChanged "onRtmpStreamingStateChanged" callback instead. - - Reports the result of calling the \ref IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" method. (CDN live only.) - - @param url The RTMP URL address. - @param error Error code: #ERROR_CODE_TYPE. Main errors include: - - #ERR_OK (0): The publishing succeeds. - - #ERR_FAILED (1): The publishing fails. - - #ERR_INVALID_ARGUMENT (2): Invalid argument used. If, for example, you did not call \ref agora::rtc::IRtcEngine::setLiveTranscoding "setLiveTranscoding" to configure LiveTranscoding before calling \ref agora::rtc::IRtcEngine::addPublishStreamUrl "addPublishStreamUrl", the SDK reports #ERR_INVALID_ARGUMENT. - - #ERR_TIMEDOUT (10): The publishing timed out. - - #ERR_ALREADY_IN_USE (19): The chosen URL address is already in use for CDN live streaming. - - #ERR_RESOURCE_LIMITED (22): The backend system does not have enough resources for the CDN live streaming. - - #ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH (130): You cannot publish an encrypted stream. - - #ERR_PUBLISH_STREAM_CDN_ERROR (151) - - #ERR_PUBLISH_STREAM_NUM_REACH_LIMIT (152) - - #ERR_PUBLISH_STREAM_NOT_AUTHORIZED (153) - - #ERR_PUBLISH_STREAM_INTERNAL_SERVER_ERROR (154) - - #ERR_PUBLISH_STREAM_FORMAT_NOT_SUPPORTED (156) - */ - virtual void onStreamPublished(const char *url, int error) { - (void)url; - (void)error; - } - /** @deprecated This method is deprecated, use the \ref agora::rtc::IRtcEngineEventHandler::onRtmpStreamingStateChanged "onRtmpStreamingStateChanged" callback instead. + /** @deprecated This method is deprecated, use the \ref agora::rtc::IRtcEngineEventHandler::onRtmpStreamingStateChanged "onRtmpStreamingStateChanged" callback instead. + + Reports the result of calling the \ref IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" method. (CDN live only.) + + @param url The CDN streaming URL. + @param error Error code: #ERROR_CODE_TYPE. Main errors include: + - #ERR_OK (0): The publishing succeeds. + - #ERR_FAILED (1): The publishing fails. + - #ERR_INVALID_ARGUMENT (-2): Invalid argument used. If, for example, you did not call \ref agora::rtc::IRtcEngine::setLiveTranscoding "setLiveTranscoding" to configure LiveTranscoding before calling \ref agora::rtc::IRtcEngine::addPublishStreamUrl "addPublishStreamUrl", the SDK reports #ERR_INVALID_ARGUMENT. + - #ERR_TIMEDOUT (-10): The publishing timed out. + - #ERR_ALREADY_IN_USE (-19): The chosen URL address is already in use for CDN live streaming. + - #ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH (130): You cannot publish an encrypted stream. + - #ERR_PUBLISH_STREAM_CDN_ERROR (151) + - #ERR_PUBLISH_STREAM_NUM_REACH_LIMIT (152) + - #ERR_PUBLISH_STREAM_NOT_AUTHORIZED (153) + - #ERR_PUBLISH_STREAM_INTERNAL_SERVER_ERROR (154) + - #ERR_PUBLISH_STREAM_FORMAT_NOT_SUPPORTED (156) + */ + virtual void onStreamPublished(const char* url, int error) { + (void)url; + (void)error; + } + /** @deprecated This method is deprecated, use the \ref agora::rtc::IRtcEngineEventHandler::onRtmpStreamingStateChanged "onRtmpStreamingStateChanged" callback instead. - Reports the result of calling the \ref agora::rtc::IRtcEngine::removePublishStreamUrl "removePublishStreamUrl" method. (CDN live only.) + Reports the result of calling the \ref agora::rtc::IRtcEngine::removePublishStreamUrl "removePublishStreamUrl" method. (CDN live only.) - This callback indicates whether you have successfully removed an RTMP stream from the CDN. + This callback indicates whether you have successfully removed an RTMP or RTMPS stream from the CDN. - @param url The RTMP URL address. - */ - virtual void onStreamUnpublished(const char *url) { - (void)url; - } -/** Occurs when the publisher's transcoding is updated. - * - * When the `LiveTranscoding` class in the \ref agora::rtc::IRtcEngine::setLiveTranscoding "setLiveTranscoding" method updates, the SDK triggers the `onTranscodingUpdated` callback to report the update information to the local host. - * - * @note If you call the `setLiveTranscoding` method to set the LiveTranscoding class for the first time, the SDK does not trigger the `onTranscodingUpdated` callback. - * - */ - virtual void onTranscodingUpdated() { - } - /** Occurs when a voice or video stream URL address is added to the live interactive streaming. - - @param url Pointer to the URL address of the externally injected stream. - @param uid User ID. - @param status State of the externally injected stream: #INJECT_STREAM_STATUS. - */ - virtual void onStreamInjectedStatus(const char* url, uid_t uid, int status) { - (void)url; - (void)uid; - (void)status; - } + @param url The CDN streaming URL. + */ + virtual void onStreamUnpublished(const char* url) { (void)url; } + /** Occurs when the publisher's transcoding is updated. + * + * When the `LiveTranscoding` class in the \ref agora::rtc::IRtcEngine::setLiveTranscoding "setLiveTranscoding" method updates, the SDK triggers the `onTranscodingUpdated` callback to report the update information to the local host. + * + * @note If you call the `setLiveTranscoding` method to set the LiveTranscoding class for the first time, the SDK does not trigger the `onTranscodingUpdated` callback. + * + */ + virtual void onTranscodingUpdated() {} + /** Occurs when a voice or video stream URL address is added to the interactive live streaming. - /** Occurs when the local audio route changes. - @param routing The current audio routing. See: #AUDIO_ROUTE_TYPE. - */ - virtual void onAudioRouteChanged(AUDIO_ROUTE_TYPE routing) { - (void)routing; - } + @warning Agora will soon stop the service for injecting online media streams on the client. If you have not implemented this service, Agora recommends that you do not use it. - /** Occurs when the published media stream falls back to an audio-only stream due to poor network conditions or switches back to the video after the network conditions improve. + @param url Pointer to the URL address of the externally injected stream. + @param uid User ID. + @param status State of the externally injected stream: #INJECT_STREAM_STATUS. + */ + virtual void onStreamInjectedStatus(const char* url, uid_t uid, int status) { + (void)url; + (void)uid; + (void)status; + } - If you call \ref IRtcEngine::setLocalPublishFallbackOption "setLocalPublishFallbackOption" and set *option* as #STREAM_FALLBACK_OPTION_AUDIO_ONLY, the SDK triggers this callback when the - published stream falls back to audio-only mode due to poor uplink conditions, or when the audio stream switches back to the video after the uplink network condition improves. - @note If the local stream fallbacks to the audio-only stream, the remote user receives the \ref IRtcEngineEventHandler::onUserMuteVideo "onUserMuteVideo" callback. + /** Occurs when the local audio route changes. + * + * @note This callback applies to Android, iOS and macOS only. + * + * @param routing The current audio routing. See: #AUDIO_ROUTE_TYPE. + */ + virtual void onAudioRouteChanged(AUDIO_ROUTE_TYPE routing) { (void)routing; } - @param isFallbackOrRecover Whether the published stream falls back to audio-only or switches back to the video: - - true: The published stream falls back to audio-only due to poor network conditions. - - false: The published stream switches back to the video after the network conditions improve. - */ - virtual void onLocalPublishFallbackToAudioOnly(bool isFallbackOrRecover) { - (void)isFallbackOrRecover; - } + /** Occurs when the published media stream falls back to an audio-only stream due to poor network conditions or switches back to the video after the network conditions improve. - /** Occurs when the remote media stream falls back to audio-only stream - * due to poor network conditions or switches back to the video stream - * after the network conditions improve. - * - * If you call - * \ref IRtcEngine::setRemoteSubscribeFallbackOption - * "setRemoteSubscribeFallbackOption" and set - * @p option as #STREAM_FALLBACK_OPTION_AUDIO_ONLY, the SDK triggers this - * callback when the remote media stream falls back to audio-only mode due - * to poor uplink conditions, or when the remote media stream switches - * back to the video after the uplink network condition improves. - * - * @note Once the remote media stream switches to the low stream due to - * poor network conditions, you can monitor the stream switch between a - * high and low stream in the RemoteVideoStats callback. - * - * @param uid ID of the remote user sending the stream. - * @param isFallbackOrRecover Whether the remotely subscribed media stream - * falls back to audio-only or switches back to the video: - * - true: The remotely subscribed media stream falls back to audio-only - * due to poor network conditions. - * - false: The remotely subscribed media stream switches back to the - * video stream after the network conditions improved. - */ - virtual void onRemoteSubscribeFallbackToAudioOnly(uid_t uid, bool isFallbackOrRecover) { - (void)uid; - (void)isFallbackOrRecover; - } + If you call \ref IRtcEngine::setLocalPublishFallbackOption "setLocalPublishFallbackOption" and set *option* as #STREAM_FALLBACK_OPTION_AUDIO_ONLY, the SDK triggers this callback when the + published stream falls back to audio-only mode due to poor uplink conditions, or when the audio stream switches back to the video after the uplink network condition improves. + @note If the local stream fallbacks to the audio-only stream, the remote user receives the \ref IRtcEngineEventHandler::onUserMuteVideo "onUserMuteVideo" callback. - /** Reports the transport-layer statistics of each remote audio stream. - * - * @deprecated - * This callback is deprecated and replaced by the - * \ref onRemoteAudioStats() "onRemoteAudioStats" callback. - * - * This callback reports the transport-layer statistics, such as the - * packet loss rate and network time delay, once every two seconds after - * the local user receives an audio packet from a remote user. - * - * @param uid User ID of the remote user sending the audio packet. - * @param delay Network time delay (ms) from the remote user sending the - * audio packet to the local user. - * @param lost Packet loss rate (%) of the audio packet sent from the - * remote user. - * @param rxKBitRate Received bitrate (Kbps) of the audio packet sent - * from the remote user. - */ - virtual void onRemoteAudioTransportStats( - uid_t uid, unsigned short delay, unsigned short lost, - unsigned short rxKBitRate) { - (void)uid; - (void)delay; - (void)lost; - (void)rxKBitRate; - } + @param isFallbackOrRecover Whether the published stream falls back to audio-only or switches back to the video: + - true: The published stream falls back to audio-only due to poor network conditions. + - false: The published stream switches back to the video after the network conditions improve. + */ + virtual void onLocalPublishFallbackToAudioOnly(bool isFallbackOrRecover) { (void)isFallbackOrRecover; } - /** Reports the transport-layer statistics of each remote video stream. - * - * @deprecated - * This callback is deprecated and replaced by the - * \ref onRemoteVideoStats() "onRemoteVideoStats" callback. - * - * This callback reports the transport-layer statistics, such as the - * packet loss rate and network time delay, once every two seconds after - * the local user receives a video packet from a remote user. - * - * @param uid User ID of the remote user sending the video packet. - * @param delay Network time delay (ms) from the remote user sending the - * video packet to the local user. - * @param lost Packet loss rate (%) of the video packet sent from the - * remote user. - * @param rxKBitRate Received bitrate (Kbps) of the video packet sent - * from the remote user. - */ - virtual void onRemoteVideoTransportStats( - uid_t uid, unsigned short delay, unsigned short lost, - unsigned short rxKBitRate) { - (void)uid; - (void)delay; - (void)lost; - (void)rxKBitRate; - } + /** Occurs when the remote media stream falls back to audio-only stream + * due to poor network conditions or switches back to the video stream + * after the network conditions improve. + * + * If you call + * \ref IRtcEngine::setRemoteSubscribeFallbackOption + * "setRemoteSubscribeFallbackOption" and set + * @p option as #STREAM_FALLBACK_OPTION_AUDIO_ONLY, the SDK triggers this + * callback when the remote media stream falls back to audio-only mode due + * to poor uplink conditions, or when the remote media stream switches + * back to the video after the uplink network condition improves. + * + * @note Once the remote media stream switches to the low stream due to + * poor network conditions, you can monitor the stream switch between a + * high and low stream in the RemoteVideoStats callback. + * + * @param uid ID of the remote user sending the stream. + * @param isFallbackOrRecover Whether the remotely subscribed media stream + * falls back to audio-only or switches back to the video: + * - true: The remotely subscribed media stream falls back to audio-only + * due to poor network conditions. + * - false: The remotely subscribed media stream switches back to the + * video stream after the network conditions improved. + */ + virtual void onRemoteSubscribeFallbackToAudioOnly(uid_t uid, bool isFallbackOrRecover) { + (void)uid; + (void)isFallbackOrRecover; + } - /** Occurs when the microphone is enabled/disabled. - * - * @deprecated v2.9.0 - * - * The \ref onMicrophoneEnabled() "onMicrophoneEnabled" callback is - * deprecated. Use #LOCAL_AUDIO_STREAM_STATE_STOPPED (0) or - * #LOCAL_AUDIO_STREAM_STATE_RECORDING (1) in the - * \ref onLocalAudioStateChanged() "onLocalAudioStateChanged" callback - * instead. - * - * The SDK triggers this callback when the local user resumes or stops - * capturing the local audio stream by calling the - * \ref agora::rtc::IRtcEngine::enableLocalAudio "enableLocalAudio" method. - * - * @param enabled Whether the microphone is enabled/disabled: - * - true: Enabled. - * - false: Disabled. - */ - virtual void onMicrophoneEnabled(bool enabled) { - (void)enabled; - } - /** Occurs when the connection state between the SDK and the server changes. + /** Reports the transport-layer statistics of each remote audio stream. + * + * @deprecated + * This callback is deprecated and replaced by the + * \ref onRemoteAudioStats() "onRemoteAudioStats" callback. + * + * This callback reports the transport-layer statistics, such as the + * packet loss rate and network time delay, once every two seconds after + * the local user receives an audio packet from a remote user. + * + * @param uid User ID of the remote user sending the audio packet. + * @param delay Network time delay (ms) from the remote user sending the + * audio packet to the local user. + * @param lost Packet loss rate (%) of the audio packet sent from the + * remote user. + * @param rxKBitRate Received bitrate (Kbps) of the audio packet sent + * from the remote user. + */ + virtual void onRemoteAudioTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) { + (void)uid; + (void)delay; + (void)lost; + (void)rxKBitRate; + } - @param state See #CONNECTION_STATE_TYPE. - @param reason See #CONNECTION_CHANGED_REASON_TYPE. - */ - virtual void onConnectionStateChanged( - CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason) { - (void)state; - (void)reason; - } + /** Reports the transport-layer statistics of each remote video stream. + * + * @deprecated + * This callback is deprecated and replaced by the + * \ref onRemoteVideoStats() "onRemoteVideoStats" callback. + * + * This callback reports the transport-layer statistics, such as the + * packet loss rate and network time delay, once every two seconds after + * the local user receives a video packet from a remote user. + * + * @param uid User ID of the remote user sending the video packet. + * @param delay Network time delay (ms) from the remote user sending the + * video packet to the local user. + * @param lost Packet loss rate (%) of the video packet sent from the + * remote user. + * @param rxKBitRate Received bitrate (Kbps) of the video packet sent + * from the remote user. + */ + virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) { + (void)uid; + (void)delay; + (void)lost; + (void)rxKBitRate; + } + + /** Occurs when the microphone is enabled/disabled. + * + * @deprecated v2.9.0 + * + * The \ref onMicrophoneEnabled() "onMicrophoneEnabled" callback is + * deprecated. Use #LOCAL_AUDIO_STREAM_STATE_STOPPED (0) or + * #LOCAL_AUDIO_STREAM_STATE_RECORDING (1) in the + * \ref onLocalAudioStateChanged() "onLocalAudioStateChanged" callback + * instead. + * + * The SDK triggers this callback when the local user resumes or stops + * capturing the local audio stream by calling the + * \ref agora::rtc::IRtcEngine::enableLocalAudio "enableLocalAudio" method. + * + * @param enabled Whether the microphone is enabled/disabled: + * - true: Enabled. + * - false: Disabled. + */ + virtual void onMicrophoneEnabled(bool enabled) { (void)enabled; } + /** Occurs when the connection state between the SDK and the server changes. - /** Occurs when the local network type changes. + @param state See #CONNECTION_STATE_TYPE. + @param reason See #CONNECTION_CHANGED_REASON_TYPE. + */ + virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason) { + (void)state; + (void)reason; + } - When the network connection is interrupted, this callback indicates whether the interruption is caused by a network type change or poor network conditions. + /** Occurs when the local network type changes. - @param type See #NETWORK_TYPE. - */ - virtual void onNetworkTypeChanged(NETWORK_TYPE type) { - (void)type; - } - /** Occurs when the local user successfully registers a user account by calling the \ref agora::rtc::IRtcEngine::registerLocalUserAccount "registerLocalUserAccount" method or joins a channel by calling the \ref agora::rtc::IRtcEngine::joinChannelWithUserAccount "joinChannelWithUserAccount" method.This callback reports the user ID and user account of the local user. + When the network connection is interrupted, this callback indicates whether the interruption is caused by a network type change or poor network conditions. - @param uid The ID of the local user. - @param userAccount The user account of the local user. - */ - virtual void onLocalUserRegistered(uid_t uid, const char* userAccount) { - (void)uid; - (void)userAccount; - } - /** Occurs when the SDK gets the user ID and user account of the remote user. + @param type See #NETWORK_TYPE. + */ + virtual void onNetworkTypeChanged(NETWORK_TYPE type) { (void)type; } + /** Occurs when the local user successfully registers a user account by calling the \ref agora::rtc::IRtcEngine::registerLocalUserAccount "registerLocalUserAccount" method or joins a channel by calling the \ref agora::rtc::IRtcEngine::joinChannelWithUserAccount "joinChannelWithUserAccount" method.This callback reports the user ID and user account of the local user. + + @param uid The ID of the local user. + @param userAccount The user account of the local user. + */ + virtual void onLocalUserRegistered(uid_t uid, const char* userAccount) { + (void)uid; + (void)userAccount; + } + /** Occurs when the SDK gets the user ID and user account of the remote user. - After a remote user joins the channel, the SDK gets the UID and user account of the remote user, - caches them in a mapping table object (`userInfo`), and triggers this callback on the local client. + After a remote user joins the channel, the SDK gets the UID and user account of the remote user, + caches them in a mapping table object (`userInfo`), and triggers this callback on the local client. - @param uid The ID of the remote user. - @param info The `UserInfo` object that contains the user ID and user account of the remote user. - */ - virtual void onUserInfoUpdated(uid_t uid, const UserInfo& info) { - (void)uid; - (void)info; - } + @param uid The ID of the remote user. + @param info The `UserInfo` object that contains the user ID and user account of the remote user. + */ + virtual void onUserInfoUpdated(uid_t uid, const UserInfo& info) { + (void)uid; + (void)info; + } + /// @cond + /** Reports the result of uploading the SDK log files. + * + * @since v3.3.0 + * + * After the method call of \ref IRtcEngine::uploadLogFile "uploadLogFile", the SDK triggers this callback to report the + * result of uploading the log files. If the upload fails, refer to the `reason` parameter to troubleshoot. + * + * @param requestId The request ID. This request ID is the same as `requestId` returned by \ref IRtcEngine::uploadLogFile "uploadLogFile", + * and you can use `requestId` to match a specific upload with a callback. + * @param success Whether the log files are successfully uploaded. + * - true: Successfully uploads the log files. + * - false: Fails to upload the log files. For details, see the `reason` parameter. + * @param reason The reason for the upload failure. See #UPLOAD_ERROR_REASON. + */ + virtual void onUploadLogResult(const char* requestId, bool success, UPLOAD_ERROR_REASON reason) { + (void)requestId; + (void)success; + (void)reason; + } + /// @endcond }; /** * Video device collection methods. - The IVideoDeviceCollection interface class retrieves the video device information. + The IVideoDeviceCollection interface class gets the video device information. */ -class IVideoDeviceCollection -{ -protected: - virtual ~IVideoDeviceCollection(){} -public: - /** Retrieves the total number of the indexed video devices in the system. - - @return Total number of the indexed video devices: - */ - virtual int getCount() = 0; - - /** Retrieves a specified piece of information about an indexed video device. - - @param index The specified index of the video device that must be less than the return value of \ref IVideoDeviceCollection::getCount "getCount". - @param deviceName Pointer to the video device name. - @param deviceId Pointer to the video device ID. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getDevice(int index, char deviceName[MAX_DEVICE_ID_LENGTH], char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; +class IVideoDeviceCollection { + protected: + virtual ~IVideoDeviceCollection() {} - /** Sets the device with the device ID. + public: + /** Gets the total number of the indexed video devices in the system. - @param deviceId Device ID of the device. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; + @return Total number of the indexed video devices: + */ + virtual int getCount() = 0; + + /** Gets a specified piece of information about an indexed video device. + + @param index The specified index of the video device that must be less than the return value of \ref IVideoDeviceCollection::getCount "getCount". + @param deviceName Pointer to the video device name. + @param deviceId Pointer to the video device ID. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getDevice(int index, char deviceName[MAX_DEVICE_ID_LENGTH], char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; + + /** Sets the device with the device ID. + + @param deviceId Device ID of the device. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; - /** Releases all IVideoDeviceCollection resources. - */ - virtual void release() = 0; + /** Releases all IVideoDeviceCollection resources. + */ + virtual void release() = 0; }; /** Video device management methods. - The IVideoDeviceManager interface class tests the video device interfaces. Instantiate an AVideoDeviceManager class to retrieve an IVideoDeviceManager interface. + The IVideoDeviceManager interface class tests the video device interfaces. Instantiate an AVideoDeviceManager class to get an IVideoDeviceManager interface. */ -class IVideoDeviceManager -{ -protected: - virtual ~IVideoDeviceManager(){} -public: +class IVideoDeviceManager { + protected: + virtual ~IVideoDeviceManager() {} - /** Enumerates the video devices. + public: + /** Enumerates the video devices. - This method returns an IVideoDeviceCollection object including all video devices - in the system. With the IVideoDeviceCollection object, the application can enumerate - the video devices. The application must call the \ref IVideoDeviceCollection::release "release" method to release the returned object after using it. + This method returns an IVideoDeviceCollection object including all video devices + in the system. With the IVideoDeviceCollection object, the application can enumerate + the video devices. The application must call the \ref IVideoDeviceCollection::release "release" method to release the returned object after using it. - @return - - An IVideoDeviceCollection object including all video devices in the system: Success. - - NULL: Failure. - */ - virtual IVideoDeviceCollection* enumerateVideoDevices() = 0; + @return + - An IVideoDeviceCollection object including all video devices in the system: Success. + - NULL: Failure. + */ + virtual IVideoDeviceCollection* enumerateVideoDevices() = 0; - /** Starts the video-capture device test. + /** Starts the video-capture device test. - This method tests whether the video-capture device works properly. Before calling this method, ensure that you have already called the \ref IRtcEngine::enableVideo "enableVideo" method, and the window handle (*hwnd*) parameter is valid. + This method tests whether the video-capture device works properly. Before calling this method, ensure that you have already called the \ref IRtcEngine::enableVideo "enableVideo" method, and the window handle (*hwnd*) parameter is valid. - @param hwnd The window handle used to display the screen. + @param hwnd The window handle used to display the screen. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int startDeviceTest(view_t hwnd) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int startDeviceTest(view_t hwnd) = 0; - /** Stops the video-capture device test. + /** Stops the video-capture device test. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int stopDeviceTest() = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int stopDeviceTest() = 0; - /** Sets a device with the device ID. + /** Sets a device with the device ID. - @param deviceId Pointer to the video-capture device ID. Call the \ref IVideoDeviceManager::enumerateVideoDevices "enumerateVideoDevices" method to retrieve it. + @param deviceId Pointer to the video-capture device ID. Call the \ref IVideoDeviceManager::enumerateVideoDevices "enumerateVideoDevices" method to get it. - @note Plugging or unplugging the device does not change the device ID. + @note Plugging or unplugging the device does not change the device ID. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; - /** Retrieves the video-capture device that is in use. + /** Gets the video-capture device that is in use. - @param deviceId Pointer to the video-capture device ID. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getDevice(char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; + @param deviceId Pointer to the video-capture device ID. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getDevice(char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; - /** Releases all IVideoDeviceManager resources. - */ - virtual void release() = 0; + /** Releases all IVideoDeviceManager resources. + */ + virtual void release() = 0; }; /** Audio device collection methods. -The IAudioDeviceCollection interface class retrieves device-related information. +The IAudioDeviceCollection interface class gets device-related information. */ -class IAudioDeviceCollection -{ -protected: - virtual ~IAudioDeviceCollection(){} -public: +class IAudioDeviceCollection { + protected: + virtual ~IAudioDeviceCollection() {} - /** Retrieves the total number of audio playback or audio recording devices. + public: + /** Gets the total number of audio playback or audio capturing devices. - @note You must first call the \ref IAudioDeviceManager::enumeratePlaybackDevices "enumeratePlaybackDevices" or \ref IAudioDeviceManager::enumerateRecordingDevices "enumerateRecordingDevices" method before calling this method to return the number of audio playback or audio recording devices. + @note You must first call the \ref IAudioDeviceManager::enumeratePlaybackDevices "enumeratePlaybackDevices" or \ref IAudioDeviceManager::enumerateRecordingDevices "enumerateRecordingDevices" method before calling this method to return the number of audio playback or audio capturing devices. - @return Number of audio playback or audio recording devices. - */ - virtual int getCount() = 0; + @return Number of audio playback or audio capturing devices. + */ + virtual int getCount() = 0; - /** Retrieves a specified piece of information about an indexed audio device. + /** Gets a specified piece of information about an indexed audio device. - @param index The specified index that must be less than the return value of \ref IAudioDeviceCollection::getCount "getCount". - @param deviceName Pointer to the audio device name. - @param deviceId Pointer to the audio device ID. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getDevice(int index, char deviceName[MAX_DEVICE_ID_LENGTH], char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; + @param index The specified index that must be less than the return value of \ref IAudioDeviceCollection::getCount "getCount". + @param deviceName Pointer to the audio device name. + @param deviceId Pointer to the audio device ID. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getDevice(int index, char deviceName[MAX_DEVICE_ID_LENGTH], char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; - /** Specifies a device with the device ID. + /** Specifies a device with the device ID. - @param deviceId Pointer to the device ID of the device. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; + @param deviceId Pointer to the device ID of the device. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; - /** Sets the volume of the application. + /** Sets the volume of the application. - @param volume Application volume. The value ranges between 0 (lowest volume) and 255 (highest volume). - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setApplicationVolume(int volume) = 0; + @param volume Application volume. The value ranges between 0 (lowest volume) and 255 (highest volume). + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setApplicationVolume(int volume) = 0; - /** Retrieves the volume of the application. + /** Gets the volume of the application. - @param volume Pointer to the application volume. The volume value ranges between 0 (lowest volume) and 255 (highest volume). + @param volume Pointer to the application volume. The volume value ranges between 0 (lowest volume) and 255 (highest volume). - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getApplicationVolume(int& volume) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getApplicationVolume(int& volume) = 0; - /** Mutes the application. + /** Mutes the application. - @param mute Sets whether to mute/unmute the application: - - true: Mute the application. - - false: Unmute the application. + @param mute Sets whether to mute/unmute the application: + - true: Mute the application. + - false: Unmute the application. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setApplicationMute(bool mute) = 0; - /** Gets the mute state of the application. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setApplicationMute(bool mute) = 0; + /** Gets the mute state of the application. - @param mute Pointer to whether the application is muted/unmuted. - - true: The application is muted. - - false: The application is not muted. + @param mute Pointer to whether the application is muted/unmuted. + - true: The application is muted. + - false: The application is not muted. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int isApplicationMute(bool& mute) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int isApplicationMute(bool& mute) = 0; - /** Releases all IAudioDeviceCollection resources. - */ - virtual void release() = 0; + /** Releases all IAudioDeviceCollection resources. + */ + virtual void release() = 0; }; /** Audio device management methods. - The IAudioDeviceManager interface class allows for audio device interface testing. Instantiate an AAudioDeviceManager class to retrieve the IAudioDeviceManager interface. + The IAudioDeviceManager interface class allows for audio device interface testing. Instantiate an AAudioDeviceManager class to get the IAudioDeviceManager interface. */ -class IAudioDeviceManager -{ -protected: - virtual ~IAudioDeviceManager(){} -public: - - /** Enumerates the audio playback devices. - - This method returns an IAudioDeviceCollection object that includes all audio playback devices in the system. With the IAudioDeviceCollection object, the application can enumerate the audio playback devices. - - @note The application must call the \ref IAudioDeviceCollection::release "release" method to release the returned object after using it. - - @return - - Success: Returns an IAudioDeviceCollection object that includes all audio playback devices in the system. For wireless Bluetooth headset devices with master and slave headsets, the master headset is the playback device. - - Returns NULL: Failure. - */ - virtual IAudioDeviceCollection* enumeratePlaybackDevices() = 0; - - /** Enumerates the audio recording devices. - - This method returns an IAudioDeviceCollection object that includes all audio recording devices in the system. With the IAudioDeviceCollection object, the application can enumerate the audio recording devices. +class IAudioDeviceManager { + protected: + virtual ~IAudioDeviceManager() {} - @note The application needs to call the \ref IAudioDeviceCollection::release "release" method to release the returned object after using it. + public: + /** Enumerates the audio playback devices. - @return - - Returns an IAudioDeviceCollection object that includes all audio recording devices in the system: Success. - - Returns NULL: Failure. - */ - virtual IAudioDeviceCollection* enumerateRecordingDevices() = 0; - - /** Sets the audio playback device using the device ID. - - @note Plugging or unplugging the audio device does not change the device ID. - - @param deviceId Device ID of the audio playback device, retrieved by calling the \ref IAudioDeviceManager::enumeratePlaybackDevices "enumeratePlaybackDevices" method. + This method returns an IAudioDeviceCollection object that includes all audio playback devices in the system. With the IAudioDeviceCollection object, the application can enumerate the audio playback devices. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setPlaybackDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; + @note The application must call the \ref IAudioDeviceCollection::release "release" method to release the returned object after using it. - /** Sets the audio recording device using the device ID. + @return + - Success: Returns an IAudioDeviceCollection object that includes all audio playback devices in the system. For wireless Bluetooth headset devices with master and slave headsets, the master headset is the playback device. + - Returns NULL: Failure. + */ + virtual IAudioDeviceCollection* enumeratePlaybackDevices() = 0; - @param deviceId Device ID of the audio recording device, retrieved by calling the \ref IAudioDeviceManager::enumerateRecordingDevices "enumerateRecordingDevices" method. + /** Enumerates the audio capturing devices. - @note Plugging or unplugging the audio device does not change the device ID. + This method returns an IAudioDeviceCollection object that includes all audio capturing devices in the system. With the IAudioDeviceCollection object, the application can enumerate the audio capturing devices. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setRecordingDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; + @note The application needs to call the \ref IAudioDeviceCollection::release "release" method to release the returned object after using it. - /** Starts the audio playback device test. + @return + - Returns an IAudioDeviceCollection object that includes all audio capturing devices in the system: Success. + - Returns NULL: Failure. + */ + virtual IAudioDeviceCollection* enumerateRecordingDevices() = 0; - This method tests if the playback device works properly. In the test, the SDK plays an audio file specified by the user. If the user can hear the audio, the playback device works properly. + /** Sets the audio playback device using the device ID. - @param testAudioFilePath Pointer to the path of the audio file for the audio playback device test in UTF-8: - - Supported file formats: wav, mp3, m4a, and aac. - - Supported file sample rates: 8000, 16000, 32000, 44100, and 48000 Hz. + @note Plugging or unplugging the audio device does not change the device ID. - @return - - 0: Success, and you can hear the sound of the specified audio file. - - < 0: Failure. - */ - virtual int startPlaybackDeviceTest(const char* testAudioFilePath) = 0; + @param deviceId Device ID of the audio playback device, retrieved by calling the \ref IAudioDeviceManager::enumeratePlaybackDevices "enumeratePlaybackDevices" method. - /** Stops the audio playback device test. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setPlaybackDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; - This method stops testing the audio playback device. You must call this method to stop the test after calling the \ref IAudioDeviceManager::startPlaybackDeviceTest "startPlaybackDeviceTest" method. + /** Sets the audio capturing device using the device ID. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int stopPlaybackDeviceTest() = 0; + @param deviceId Device ID of the audio capturing device, retrieved by calling the \ref IAudioDeviceManager::enumerateRecordingDevices "enumerateRecordingDevices" method. - /** Sets the volume of the audio playback device. + @note Plugging or unplugging the audio device does not change the device ID. - @param volume Sets the volume of the audio playback device. The value ranges between 0 (lowest volume) and 255 (highest volume). - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setPlaybackDeviceVolume(int volume) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setRecordingDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; - /** Retrieves the volume of the audio playback device. + /** Starts the audio playback device test. + * + * This method tests if the audio playback device works properly. Once a user starts the test, the SDK plays an + * audio file specified by the user. If the user can hear the audio, the playback device works properly. + * + * After calling this method, the SDK triggers the + * \ref IRtcEngineEventHandler::onAudioVolumeIndication "onAudioVolumeIndication" callback every 100 ms, which + * reports `uid = 1` and the volume of the playback device. + * + * @note + * - Call this method before joining a channel. + * - This method is for Windows and macOS only. + * + * @param testAudioFilePath Pointer to the path of the audio file for the audio playback device test in UTF-8: + * - Supported file formats: wav, mp3, m4a, and aac. + * - Supported file sample rates: 8000, 16000, 32000, 44100, and 48000 Hz. + * + * @return + * - 0: Success, and you can hear the sound of the specified audio file. + * - < 0: Failure. + */ + virtual int startPlaybackDeviceTest(const char* testAudioFilePath) = 0; - @param volume Pointer to the audio playback device volume. The volume value ranges between 0 (lowest volume) and 255 (highest volume). - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getPlaybackDeviceVolume(int *volume) = 0; + /** Stops the audio playback device test. - /** Sets the volume of the microphone. + This method stops testing the audio playback device. You must call this method to stop the test after calling the \ref IAudioDeviceManager::startPlaybackDeviceTest "startPlaybackDeviceTest" method. - @param volume Sets the volume of the microphone. The value ranges between 0 (lowest volume) and 255 (highest volume). - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setRecordingDeviceVolume(int volume) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int stopPlaybackDeviceTest() = 0; - /** Retrieves the volume of the microphone. + /** Sets the volume of the audio playback device. - @param volume Pointer to the microphone volume. The volume value ranges between 0 (lowest volume) and 255 (highest volume). - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getRecordingDeviceVolume(int *volume) = 0; + @param volume Sets the volume of the audio playback device. The value ranges between 0 (lowest volume) and 255 (highest volume). + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setPlaybackDeviceVolume(int volume) = 0; - /** Mutes the audio playback device. + /** Gets the volume of the audio playback device. - @param mute Sets whether to mute/unmute the audio playback device: - - true: Mutes. - - false: Unmutes. + @param volume Pointer to the audio playback device volume. The volume value ranges between 0 (lowest volume) and 255 (highest volume). + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getPlaybackDeviceVolume(int* volume) = 0; - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setPlaybackDeviceMute(bool mute) = 0; - /** Retrieves the mute status of the audio playback device. + /** Sets the volume of the microphone. - @param mute Pointer to whether the audio playback device is muted/unmuted. - - true: Muted. - - false: Unmuted. + @note Ensure that you call this method after joining a channel. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getPlaybackDeviceMute(bool *mute) = 0; - /** Mutes/Unmutes the microphone. + @param volume Sets the volume of the microphone. The value ranges between 0 (lowest volume) and 255 (highest volume). + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setRecordingDeviceVolume(int volume) = 0; - @param mute Sets whether to mute/unmute the microphone: - - true: Mutes. - - false: Unmutes. + /** Gets the volume of the microphone. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setRecordingDeviceMute(bool mute) = 0; + @param volume Pointer to the microphone volume. The volume value ranges between 0 (lowest volume) and 255 (highest volume). + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getRecordingDeviceVolume(int* volume) = 0; - /** Retrieves the microphone's mute status. + /** Mutes the audio playback device. - @param mute Pointer to whether the microphone is muted/unmuted. - - true: Muted. - - false: Unmuted. + @param mute Sets whether to mute/unmute the audio playback device: + - true: Mutes. + - false: Unmutes. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getRecordingDeviceMute(bool *mute) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setPlaybackDeviceMute(bool mute) = 0; + /** Gets the mute status of the audio playback device. - /** Starts the microphone test. + @param mute Pointer to whether the audio playback device is muted/unmuted. + - true: Muted. + - false: Unmuted. - This method tests whether the microphone works properly. Once the test starts, the SDK uses the \ref IRtcEngineEventHandler::onAudioVolumeIndication "onAudioVolumeIndication" callback to notify the application with the volume information. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getPlaybackDeviceMute(bool* mute) = 0; + /** Mutes/Unmutes the microphone. - @param indicationInterval Interval period (ms) of the \ref IRtcEngineEventHandler::onAudioVolumeIndication "onAudioVolumeIndication" callback cycle. + @param mute Sets whether to mute/unmute the microphone: + - true: Mutes. + - false: Unmutes. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int startRecordingDeviceTest(int indicationInterval) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setRecordingDeviceMute(bool mute) = 0; - /** Stops the microphone test. + /** Gets the microphone's mute status. - This method stops the microphone test. You must call this method to stop the test after calling the \ref IAudioDeviceManager::startRecordingDeviceTest "startRecordingDeviceTest" method. + @param mute Pointer to whether the microphone is muted/unmuted. + - true: Muted. + - false: Unmuted. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int stopRecordingDeviceTest() = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getRecordingDeviceMute(bool* mute) = 0; - /** Retrieves the audio playback device associated with the device ID. + /** Starts the audio capturing device test. - @param deviceId Pointer to the ID of the audio playback device. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getPlaybackDevice(char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; + This method tests whether the audio capturing device works properly. - /** Retrieves the audio playback device information associated with the device ID and device name. + After calling this method, the SDK triggers the + \ref IRtcEngineEventHandler::onAudioVolumeIndication "onAudioVolumeIndication" callback at the time interval set + in this method, which reports `uid = 0` and the volume of the capturing device. - @param deviceId Pointer to the device ID of the audio playback device. - @param deviceName Pointer to the device name of the audio playback device. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getPlaybackDeviceInfo(char deviceId[MAX_DEVICE_ID_LENGTH], char deviceName[MAX_DEVICE_ID_LENGTH]) = 0; + @note + - Call this method before joining a channel. + - This method is for Windows and macOS only. - /** Retrieves the audio recording device associated with the device ID. + @param indicationInterval The time interval (ms) at which the `onAudioVolumeIndication` callback returns. We + recommend a setting greater than 200 ms. This value must not be less than 10 ms; otherwise, you can not receive + the `onAudioVolumeIndication` callback. - @param deviceId Pointer to the device ID of the audio recording device. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getRecordingDevice(char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int startRecordingDeviceTest(int indicationInterval) = 0; - /** Retrieves the audio recording device information associated with the device ID and device name. + /** Stops the audio capturing device test. - @param deviceId Pointer to the device ID of the recording audio device. - @param deviceName Pointer to the device name of the recording audio device. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getRecordingDeviceInfo(char deviceId[MAX_DEVICE_ID_LENGTH], char deviceName[MAX_DEVICE_ID_LENGTH]) = 0; + This method stops the audio capturing device test. You must call this method to stop the test after calling the \ref IAudioDeviceManager::startRecordingDeviceTest "startRecordingDeviceTest" method. - /** Starts the audio device loopback test. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int stopRecordingDeviceTest() = 0; - This method tests whether the local audio devices are working properly. After calling this method, the microphone captures the local audio and plays it through the speaker. The \ref IRtcEngineEventHandler::onAudioVolumeIndication "onAudioVolumeIndication" callback returns the local audio volume information at the set interval. + /** Gets the audio playback device associated with the device ID. - @note This method tests the local audio devices and does not report the network conditions. + @param deviceId Pointer to the ID of the audio playback device. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getPlaybackDevice(char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; - @param indicationInterval The time interval (ms) at which the \ref IRtcEngineEventHandler::onAudioVolumeIndication "onAudioVolumeIndication" callback returns. + /** Gets the audio playback device information associated with the device ID and device name. + @param deviceId Pointer to the device ID of the audio playback device. + @param deviceName Pointer to the device name of the audio playback device. @return - 0: Success. - < 0: Failure. */ - virtual int startAudioDeviceLoopbackTest(int indicationInterval) = 0; + virtual int getPlaybackDeviceInfo(char deviceId[MAX_DEVICE_ID_LENGTH], char deviceName[MAX_DEVICE_ID_LENGTH]) = 0; - /** Stops the audio device loopback test. + /** Gets the audio capturing device associated with the device ID. - @note Ensure that you call this method to stop the loopback test after calling the \ref IAudioDeviceManager::startAudioDeviceLoopbackTest "startAudioDeviceLoopbackTest" method. + @param deviceId Pointer to the device ID of the audio capturing device. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getRecordingDevice(char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; + /** Gets the audio capturing device information associated with the device ID and device name. + + @param deviceId Pointer to the device ID of the audio capturing device. + @param deviceName Pointer to the device name of the audio capturing device. @return - 0: Success. - < 0: Failure. */ - virtual int stopAudioDeviceLoopbackTest() = 0; + virtual int getRecordingDeviceInfo(char deviceId[MAX_DEVICE_ID_LENGTH], char deviceName[MAX_DEVICE_ID_LENGTH]) = 0; + + /** Starts the audio device loopback test. + * + * This method tests whether the local audio sampling device and playback device are working properly. After calling + * this method, the audio sampling device samples the local audio, and the audio playback device plays the sampled + * audio. The SDK triggers two independent + * \ref IRtcEngineEventHandler::onAudioVolumeIndication "onAudioVolumeIndication" callbacks at the time interval set + * in this method, which reports the following information: + * - `uid = 0` and the volume information of the sampling device. + * - `uid = 1` and the volume information of the playback device. + * + * @note + * - Call this method before joining a channel. + * - This method tests local audio devices and does not report the network conditions. + * - This method is for Windows and macOS only. + * + * @param indicationInterval The time interval (ms) at which the `onAudioVolumeIndication` callback returns. We + * recommend a setting greater than 200 ms. This value must not be less than 10 ms; otherwise, you can not receive + * the `onAudioVolumeIndication` callback. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int startAudioDeviceLoopbackTest(int indicationInterval) = 0; + + /** Stops the audio device loopback test. + + @note Ensure that you call this method to stop the loopback test after calling the \ref IAudioDeviceManager::startAudioDeviceLoopbackTest "startAudioDeviceLoopbackTest" method. + + @return + - 0: Success. + - < 0: Failure. + */ + virtual int stopAudioDeviceLoopbackTest() = 0; + + /** Releases all IAudioDeviceManager resources. + */ + virtual void release() = 0; +}; - /** Releases all IAudioDeviceManager resources. +/** The configuration of the log files. + * + * @since v3.3.0 + */ +struct LogConfig { + /** The absolute path of log files. + * + * The default file path is: + * - Android: `/storage/emulated/0/Android/data//files/agorasdk.log` + * - iOS: `App Sandbox/Library/caches/agorasdk.log` + * - macOS: + * - Sandbox enabled: `App Sandbox/Library/Logs/agorasdk.log`, such as `/Users//Library/Containers//Data/Library/Logs/agorasdk.log`. + * - Sandbox disabled: `～/Library/Logs/agorasdk.log`. + * - Windows: `C:\Users\\AppData\Local\Agora\\agorasdk.log` + * + * Ensure that the directory for the log files exists and is writable. You can use this parameter to rename the log files. + */ + const char* filePath; + /** The size (KB) of a log file. The default value is 1024 KB. If you set `fileSize` to 1024 KB, the SDK outputs at most 5 MB log files; + * if you set it to less than 1024 KB, the setting is invalid, and the maximum size of a log file is still 1024 KB. + */ + int fileSize; + /** The output log level of the SDK. See #LOG_LEVEL. + * + * For example, if you set the log level to WARN, the SDK outputs the logs within levels FATAL, ERROR, and WARN. */ - virtual void release() = 0; + LOG_LEVEL level; + LogConfig() : filePath(NULL), fileSize(-1), level(LOG_LEVEL::LOG_LEVEL_INFO) {} }; /** Definition of RtcEngineContext. -*/ -struct RtcEngineContext -{ - /** The IRtcEngineEventHandler object. + */ +struct RtcEngineContext { + /** The IRtcEngineEventHandler object. + */ + IRtcEngineEventHandler* eventHandler; + /** + * The App ID issued to you by Agora. See [How to get the App ID](https://docs.agora.io/en/Agora%20Platform/token#get-an-app-id). + * Only users in apps with the same App ID can join the same channel and communicate with each other. Use an App ID to create only + * one `IRtcEngine` instance. To change your App ID, call `release` to destroy the current `IRtcEngine` instance and then call `createAgoraRtcEngine` + * and `initialize` to create an `IRtcEngine` instance with the new App ID. + */ + const char* appId; + // For android, it the context(Activity or Application + // for windows,Video hot plug device + /** The video window handle. Once set, this parameter enables you to plug + * or unplug the video devices while they are powered. + */ + void* context; + /** + * The region for connection. This advanced feature applies to scenarios that have regional restrictions. + * + * For the regions that Agora supports, see #AREA_CODE. The area codes support bitwise operation. + * + * After specifying the region, the SDK connects to the Agora servers within that region. + */ + unsigned int areaCode; + /** The configuration of the log files that the SDK outputs. See LogConfig. + * + * @since v3.3.0 + * + * By default, the SDK outputs five log files, `agorasdk.log`, `agorasdk_1.log`, `agorasdk_2.log`, `agorasdk_3.log`, `agorasdk_4.log`, each with + * a default size of 1024 KB. These log files are encoded in UTF-8. The SDK writes the latest logs in `agorasdk.log`. When `agorasdk.log` is + * full, the SDK deletes the log file with the earliest modification time among the other four, renames `agorasdk.log` to the name of the + * deleted log file, and creates a new `agorasdk.log` to record latest logs. + * + */ + LogConfig logConfig; + RtcEngineContext() : eventHandler(NULL), appId(NULL), context(NULL), areaCode(rtc::AREA_CODE_GLOB) {} +}; + +/** Definition of IMetadataObserver + */ +class IMetadataObserver { + public: + /** Metadata type of the observer. + @note We only support video metadata for now. + */ + enum METADATA_TYPE { + /** -1: the metadata type is unknown. */ - IRtcEngineEventHandler* eventHandler; - /** - * The App ID issued to you by Agora. See [How to get the App ID](https://docs.agora.io/en/Agora%20Platform/token#get-an-app-id). - * Only users in apps with the same App ID can join the same channel and communicate with each other. Use an App ID to create only - * one `IRtcEngine` instance. To change your App ID, call `release` to destroy the current `IRtcEngine` instance and then call `createAgoraRtcEngine` - * and `initialize` to create an `IRtcEngine` instance with the new App ID. + UNKNOWN_METADATA = -1, + /** 0: the metadata type is video. */ - const char* appId; - // For android, it the context(Activity or Application - // for windows,Video hot plug device - /** The video window handle. Once set, this parameter enables you to plug - * or unplug the video devices while they are powered. + VIDEO_METADATA = 0, + }; + + struct Metadata { + /** The User ID. + + - For the receiver: the ID of the user who sent the metadata. + - For the sender: ignore it. */ - void* context; - /** - * The region for connection. This advanced feature applies to scenarios that have regional restrictions. - * - * For the regions that Agora supports, see #AREA_CODE. After specifying the region, the SDK connects to the Agora servers within that region. - * - * @note The SDK supports specify only one region. + unsigned int uid; + /** Buffer size of the sent or received Metadata. */ - unsigned int areaCode; - RtcEngineContext() - :eventHandler(NULL) - ,appId(NULL) - ,context(NULL) - ,areaCode(rtc::AREA_CODE_GLOB) - {} -}; - -/** Definition of IMetadataObserver -*/ -class IMetadataObserver -{ -public: - /** Metadata type of the observer. - @note We only support video metadata for now. + unsigned int size; + /** Buffer address of the sent or received Metadata. */ - enum METADATA_TYPE - { - /** -1: the metadata type is unknown. - */ - UNKNOWN_METADATA = -1, - /** 0: the metadata type is video. - */ - VIDEO_METADATA = 0, - }; - - struct Metadata - { - /** The User ID. - - - For the receiver: the ID of the user who sent the metadata. - - For the sender: ignore it. - */ - unsigned int uid; - /** Buffer size of the sent or received Metadata. - */ - unsigned int size; - /** Buffer address of the sent or received Metadata. - */ - unsigned char *buffer; - /** Timestamp (ms) of the frame following the metadata. - */ - long long timeStampMs; - }; - - virtual ~IMetadataObserver() {}; - - /** Occurs when the SDK requests the maximum size of the Metadata. - - The metadata includes the following parameters: - - `uid`: ID of the user who sends the metadata. - - `size`: The size of the sent or received metadata. - - `buffer`: The sent or received metadata. - - `timeStampMs`: The timestamp (ms) of the metadata. - - The SDK triggers this callback after you successfully call the \ref agora::rtc::IRtcEngine::registerMediaMetadataObserver "registerMediaMetadataObserver" method. You need to specify the maximum size of the metadata in the return value of this callback. - - @return The maximum size of the buffer of the metadata that you want to use. The highest value is 1024 bytes. Ensure that you set the return value. + unsigned char* buffer; + /** Timestamp (ms) of the frame following the metadata. */ - virtual int getMaxMetadataSize() = 0; + long long timeStampMs; + }; - /** Occurs when the SDK is ready to receive and send metadata. + virtual ~IMetadataObserver(){}; - @note Ensure that the size of the metadata does not exceed the value set in the \ref agora::rtc::IMetadataObserver::getMaxMetadataSize "getMaxMetadataSize" callback. + /** Occurs when the SDK requests the maximum size of the Metadata. - @param metadata The Metadata to be sent. - @return - - true: Send. - - false: Do not send. - */ - virtual bool onReadyToSendMetadata(Metadata &metadata) = 0; + The metadata includes the following parameters: + - `uid`: ID of the user who sends the metadata. + - `size`: The size of the sent or received metadata. + - `buffer`: The sent or received metadata. + - `timeStampMs`: The timestamp (ms) of the metadata. - /** Occurs when the local user receives the metadata. + The SDK triggers this callback after you successfully call the \ref agora::rtc::IRtcEngine::registerMediaMetadataObserver "registerMediaMetadataObserver" method. You need to specify the maximum size of the metadata in the return value of this callback. - @param metadata The received Metadata. - */ - virtual void onMetadataReceived(const Metadata &metadata) = 0; + @return The maximum size of the buffer of the metadata that you want to use. The highest value is 1024 bytes. Ensure that you set the return value. + */ + virtual int getMaxMetadataSize() = 0; + + /** Occurs when the SDK is ready to receive and send metadata. + + @note Ensure that the size of the metadata does not exceed the value set in the \ref agora::rtc::IMetadataObserver::getMaxMetadataSize "getMaxMetadataSize" callback. + + @param metadata The Metadata to be sent. + @return + - true: Send. + - false: Do not send. + */ + virtual bool onReadyToSendMetadata(Metadata& metadata) = 0; + + /** Occurs when the local user receives the metadata. + + @param metadata The received Metadata. + */ + virtual void onMetadataReceived(const Metadata& metadata) = 0; }; /** Encryption mode. -*/ -enum ENCRYPTION_MODE -{ - /** 1: (Default) 128-bit AES encryption, XTS mode. - */ - AES_128_XTS = 1, - /** 2: 128-bit AES encryption, ECB mode. - */ - AES_128_ECB = 2, - /** 3: 256-bit AES encryption, XTS mode. - */ - AES_256_XTS = 3, - /** 4: 128-bit SM4 encryption, ECB mode. - */ - SM4_128_ECB = 4, - /** Enumerator boundary. - */ - MODE_END, + */ +enum ENCRYPTION_MODE { + /** 1: 128-bit AES encryption, XTS mode. + */ + AES_128_XTS = 1, + /** 2: 128-bit AES encryption, ECB mode. + */ + AES_128_ECB = 2, + /** 3: 256-bit AES encryption, XTS mode. + */ + AES_256_XTS = 3, + /// @cond + /** 4: 128-bit SM4 encryption, ECB mode. + */ + SM4_128_ECB = 4, + /// @endcond + /** 5: 128-bit AES encryption, GCM mode. + * + * @since v3.3.1 + */ + AES_128_GCM = 5, + /** 6: 256-bit AES encryption, GCM mode. + * + * @since v3.3.1 + */ + AES_256_GCM = 6, + /** 7: (Default) 128-bit AES encryption, GCM mode, with custom KDF salt. + * + * @since v3.4.1 + */ + AES_128_GCM2 = 7, + /** 8: 256-bit AES encryption, GCM mode, with custom KDF salt. + * + * @since v3.4.1 + */ + AES_256_GCM2 = 8, + /** Enumerator boundary. + */ + MODE_END, }; /** Configurations of built-in encryption schemas. */ -struct EncryptionConfig{ - /** - * Encryption mode. The default encryption mode is `AES_128_XTS`. See #ENCRYPTION_MODE. - */ - ENCRYPTION_MODE encryptionMode; - /** - * Encryption key in string type. - * - * @note If you do not set an encryption key or set it as NULL, you cannot use the built-in encryption, and the SDK returns #ERR_INVALID_ARGUMENT (-2). - */ - const char* encryptionKey; +struct EncryptionConfig { + /** + * Encryption mode. The default encryption mode is `AES_128_XTS`. See #ENCRYPTION_MODE. + */ + ENCRYPTION_MODE encryptionMode; + /** + * Encryption key in string type. + * + * @note If you do not set an encryption key or set it as NULL, you cannot use the built-in encryption, and the SDK returns #ERR_INVALID_ARGUMENT (-2). + */ + const char* encryptionKey; + uint8_t encryptionKdfSalt[32]; - EncryptionConfig() { - encryptionMode = AES_128_XTS; - encryptionKey = nullptr; - } + EncryptionConfig() { + encryptionMode = AES_128_GCM2; + encryptionKey = nullptr; + memset(encryptionKdfSalt, 0, sizeof(encryptionKdfSalt)); + } - /// @cond - const char* getEncryptionString() const { - switch(encryptionMode) - { - case AES_128_XTS: - return "aes-128-xts"; - case AES_128_ECB: - return "aes-128-ecb"; - case AES_256_XTS: - return "aes-256-xts"; - case SM4_128_ECB: - return "sm4-128-ecb"; - default: - return "aes-128-xts"; - } + /// @cond + const char* getEncryptionString() const { + switch (encryptionMode) { + case AES_128_XTS: return "aes-128-xts"; - } - /// @endcond + case AES_128_ECB: + return "aes-128-ecb"; + case AES_256_XTS: + return "aes-256-xts"; + case SM4_128_ECB: + return "sm4-128-ecb"; + case AES_128_GCM: + return "aes-128-gcm"; + case AES_256_GCM: + return "aes-256-gcm"; + case AES_128_GCM2: + return "aes-128-gcm-2"; + case AES_256_GCM2: + return "aes-256-gcm-2"; + default: + return "aes-128-gcm-2"; + } + return "aes-128-gcm-2"; + } + /// @endcond +}; + +/** The channel media options. + */ +struct ChannelMediaOptions { + /** Determines whether to automatically subscribe to all remote audio streams when the user joins a channel: + - true: (Default) Subscribe. + - false: Do not subscribe. + + This member serves a similar function to the `muteAllRemoteAudioStreams` method. After joining the channel, + you can call the `muteAllRemoteAudioStreams` method to set whether to subscribe to audio streams in the channel. + */ + bool autoSubscribeAudio; + /** Determines whether to subscribe to video streams when the user joins the channel: + - true: (Default) Subscribe. + - false: Do not subscribe. + + This member serves a similar function to the `muteAllRemoteVideoStreams` method. After joining the channel, + you can call the `muteAllRemoteVideoStreams` method to set whether to subscribe to video streams in the channel. + */ + bool autoSubscribeVideo; + /** Determines whether to publish audio stream when the user joins a channel: + - true: (Default) publish. + - false: Do not publish. + + This member serves a similar function to the `muteLocalAudioStream` method. After joining the channel, + you can call the `muteLocalAudioStream` method to set whether to publish audio stream in the channel. + */ + bool publishLocalAudio; + /** Determines whether to publish video stream when the user joins a channel: + - true: (Default) publish. + - false: Do not publish. + + This member serves a similar function to the `muteLocalVideoStream` method. After joining the channel, + you can call the `muteLocalVideoStream` method to set whether to publish video stream in the channel. + */ + bool publishLocalVideo; + ChannelMediaOptions() : autoSubscribeAudio(true), autoSubscribeVideo(true), publishLocalAudio(true), publishLocalVideo(true) {} }; /** IRtcEngine is the base interface class of the Agora SDK that provides the main Agora SDK methods invoked by your application. Enable the Agora SDK's communication functionality through the creation of an IRtcEngine object, then call the methods of this object. */ -class IRtcEngine -{ -protected: - virtual ~IRtcEngine() {} -public: +class IRtcEngine { + protected: + virtual ~IRtcEngine() {} - /** Initializes the Agora service. - * - * Unless otherwise specified, all the methods provided by the IRtcEngine class are executed asynchronously. Agora recommends calling these methods in the same thread. - * - * @note Ensure that you call the - * \ref agora::rtc::IRtcEngine::createAgoraRtcEngine - * "createAgoraRtcEngine" and \ref agora::rtc::IRtcEngine::initialize - * "initialize" methods before calling any other APIs. - * - * @param context Pointer to the RTC engine context. See RtcEngineContext. - * - * @return - * - 0(ERR_OK): Success. - * - < 0: Failure. - * - -1(ERR_FAILED): A general error occurs (no specified reason). - * - -2(ERR_INALID_ARGUMENT): No `IRtcEngineEventHandler` object is specified. - * - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. Check whether `context` is properly set. - * - -22(ERR_RESOURCE_LIMITED): The resource is limited. The app uses too much of the system resource and fails to allocate any resources. - * - -101(ERR_INVALID_APP_ID): The App ID is invalid. - */ - virtual int initialize(const RtcEngineContext& context) = 0; + public: + /** Initializes the Agora service. + * + * Unless otherwise specified, all the methods provided by the IRtcEngine class are executed asynchronously. Agora recommends calling these methods in the same thread. + * + * @note Ensure that you call the + * \ref agora::rtc::IRtcEngine::createAgoraRtcEngine + * "createAgoraRtcEngine" and \ref agora::rtc::IRtcEngine::initialize + * "initialize" methods before calling any other APIs. + * + * @param context Pointer to the RTC engine context. See RtcEngineContext. + * + * @return + * - 0(ERR_OK): Success. + * - < 0: Failure. + * - -1(ERR_FAILED): A general error occurs (no specified reason). + * - -2(ERR_INALID_ARGUMENT): No `IRtcEngineEventHandler` object is specified. + * - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. Check whether `context` is properly set. + * - -22(ERR_RESOURCE_LIMITED): The resource is limited. The app uses too much of the system resource and fails to allocate any resources. + * - -101(ERR_INVALID_APP_ID): The App ID is invalid. + */ + virtual int initialize(const RtcEngineContext& context) = 0; - /** Releases all IRtcEngine resources. - * - * Use this method for apps in which users occasionally make voice or video calls. When users do not make calls, you - * can free up resources for other operations. Once you call `release` to destroy the created `IRtcEngine` instance, - * you cannot use any method or callback in the SDK any more. If you want to use the real-time communication functions - * again, you must call \ref createAgoraRtcEngine "createAgoraRtcEngine" and \ref agora::rtc::IRtcEngine::initialize "initialize" - * to create a new `IRtcEngine` instance. - * - * @note If you want to create a new `IRtcEngine` instance after destroying the current one, ensure that you wait - * till the `release` method completes executing. - * - * @param sync - * - true: Synchronous call. Agora suggests calling this method in a sub-thread to avoid congestion in the main thread - * because the synchronous call and the app cannot move on to another task until the execution completes. - * Besides, you **cannot** call this method in any method or callback of the SDK. Otherwise, the SDK cannot release the - * resources occupied by the `IRtcEngine` instance until the callbacks return results, which may result in a deadlock. - * The SDK automatically detects the deadlock and converts this method into an asynchronous call, causing the test to - * take additional time. - * - false: Asynchronous call. Do not immediately uninstall the SDK's dynamic library after the call, or it may cause - * a crash due to the SDK clean-up thread not quitting. - */ - AGORA_CPP_API static void release (bool sync = false); + /** Releases all IRtcEngine resources. + * + * Use this method for apps in which users occasionally make voice or video calls. When users do not make calls, you + * can free up resources for other operations. Once you call `release` to destroy the created `IRtcEngine` instance, + * you cannot use any method or callback in the SDK any more. If you want to use the real-time communication functions + * again, you must call \ref createAgoraRtcEngine "createAgoraRtcEngine" and \ref agora::rtc::IRtcEngine::initialize "initialize" + * to create a new `IRtcEngine` instance. + * + * @note If you want to create a new `IRtcEngine` instance after destroying the current one, ensure that you wait + * till the `release` method completes executing. + * + * @param sync + * - true: Synchronous call. Agora suggests calling this method in a sub-thread to avoid congestion in the main thread + * because the synchronous call and the app cannot move on to another task until the execution completes. + * Besides, you **cannot** call this method in any method or callback of the SDK. Otherwise, the SDK cannot release the + * resources occupied by the `IRtcEngine` instance until the callbacks return results, which may result in a deadlock. + * The SDK automatically detects the deadlock and converts this method into an asynchronous call, causing the test to + * take additional time. + * - false: Asynchronous call. Do not immediately uninstall the SDK's dynamic library after the call, or it may cause + * a crash due to the SDK clean-up thread not quitting. + */ + AGORA_CPP_API static void release(bool sync = false); - /** Sets the channel profile of the Agora IRtcEngine. - * - * The Agora IRtcEngine differentiates channel profiles and applies optimization algorithms accordingly. - * For example, it prioritizes smoothness and low latency for a video call, and prioritizes video quality for the live interactive video streaming. - * - * @warning - * - To ensure the quality of real-time communication, we recommend that all users in a channel use the same channel profile. - * - Call this method before calling \ref IRtcEngine::joinChannel "joinChannel" . You cannot set the channel profile once you have joined the channel. - * - The default audio route and video encoding bitrate are different in different channel profiles. For details, see - * \ref IRtcEngine::setDefaultAudioRouteToSpeakerphone "setDefaultAudioRouteToSpeakerphone" and \ref IRtcEngine::setVideoEncoderConfiguration "setVideoEncoderConfiguration". - * - * @param profile The channel profile of the Agora IRtcEngine. See #CHANNEL_PROFILE_TYPE - * @return - * - 0(ERR_OK): Success. - * - < 0: Failure. - * - -2 (ERR_INVALID_ARGUMENT): The parameter is invalid. - * - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. - */ - virtual int setChannelProfile(CHANNEL_PROFILE_TYPE profile) = 0; + /** Sets the channel profile of the Agora IRtcEngine. + * + * The Agora IRtcEngine differentiates channel profiles and applies optimization algorithms accordingly. + * For example, it prioritizes smoothness and low latency for a video call, and prioritizes video quality for the interactive live video streaming. + * + * @warning + * - To ensure the quality of real-time communication, we recommend that all users in a channel use the same channel profile. + * - Call this method before calling \ref IRtcEngine::joinChannel "joinChannel" . You cannot set the channel profile once you have joined the channel. + * - The default audio route and video encoding bitrate are different in different channel profiles. For details, see + * \ref IRtcEngine::setDefaultAudioRouteToSpeakerphone "setDefaultAudioRouteToSpeakerphone" and \ref IRtcEngine::setVideoEncoderConfiguration "setVideoEncoderConfiguration". + * + * @param profile The channel profile of the Agora IRtcEngine. See #CHANNEL_PROFILE_TYPE + * @return + * - 0(ERR_OK): Success. + * - < 0: Failure. + * - -2 (ERR_INVALID_ARGUMENT): The parameter is invalid. + * - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. + */ + virtual int setChannelProfile(CHANNEL_PROFILE_TYPE profile) = 0; - /** Sets the role of the user, such as a host or an audience (default), before joining a channel in the live interactive streaming. - * - * This method can be used to switch the user role in the live interactive streaming after the user joins a channel. - * - * In the `LIVE_BROADCASTING` profile, when a user switches user roles after joining a channel, a successful \ref agora::rtc::IRtcEngine::setClientRole "setClientRole" method call triggers the following callbacks: - * - The local client: \ref agora::rtc::IRtcEngineEventHandler::onClientRoleChanged "onClientRoleChanged" - * - The remote client: \ref agora::rtc::IRtcEngineEventHandler::onUserJoined "onUserJoined" or \ref agora::rtc::IRtcEngineEventHandler::onUserOffline "onUserOffline" (BECOME_AUDIENCE) - * - * @note - * This method applies only to the `LIVE_BROADCASTING` profile. - * - * @param role Sets the role of the user. See #CLIENT_ROLE_TYPE. - * - * @return - * - 0(ERR_OK): Success. - * - < 0: Failure. - * - -1(ERR_FAILED): A general error occurs (no specified reason). - * - -2(ERR_INALID_ARGUMENT): The parameter is invalid. - * - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. - */ - virtual int setClientRole(CLIENT_ROLE_TYPE role) = 0; - /// @cond - /** Sets the role of a user in a live interactive streaming. - * - * @since v3.2.0 - * - * You can call this method either before or after joining the channel to set the user role as audience or host. If - * you call this method to switch the user role after joining the channel, the SDK triggers the following callbacks: - * - The local client: \ref IRtcEngineEventHandler::onClientRoleChanged "onClientRoleChanged". - * - The remote client: \ref IRtcEngineEventHandler::onUserJoined "onUserJoined" - * or \ref IRtcEngineEventHandler::onUserOffline "onUserOffline". - * - * @note - * - This method applies to the `LIVE_BROADCASTING` profile only (when the `profile` parameter in - * \ref IRtcEngine::setChannelProfile "setChannelProfile" is set as `CHANNEL_PROFILE_LIVE_BROADCASTING`). - * - The difference between this method and \ref IRtcEngine::setClientRole(CLIENT_ROLE_TYPE) "setClientRole1" is that - * this method can set the user level in addition to the user role. - * - The user role determines the permissions that the SDK grants to a user, such as permission to send local - * streams, receive remote streams, and push streams to a CDN address. - * - The user level determines the level of services that a user can enjoy within the permissions of the user's - * role. For example, an audience can choose to receive remote streams with low latency or ultra low latency. Levels - * affect prices. - * - * **Example** - * ```cpp - * ClientRoleOptions options; - * options.audienceLatencyLevel = AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY; - * options.audienceLatencyLevel = AUDIENCE_LATENCY_LEVEL_LOW_LATENCY; - * agoraEngine->setClientRole(role, options); - * ``` - * - * @param role The role of a user in a live interactive streaming. See #CLIENT_ROLE_TYPE. - * @param options The detailed options of a user, including user level. See ClientRoleOptions. - * - * @return - * - 0(ERR_OK): Success. - * - < 0: Failure. - * - -1(ERR_FAILED): A general error occurs (no specified reason). - * - -2(ERR_INALID_ARGUMENT): The parameter is invalid. - * - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. - */ - virtual int setClientRole(CLIENT_ROLE_TYPE role, const ClientRoleOptions& options) = 0; - /// @endcond - /** Joins a channel with the user ID. - - Users in the same channel can talk to each other, and multiple users in the same channel can start a group chat. Users with different App IDs cannot call each other. - - - You must call the \ref IRtcEngine::leaveChannel "leaveChannel" method to exit the current call before entering another channel. - - A successful \ref agora::rtc::IRtcEngine::joinChannel "joinChannel" method call triggers the following callbacks: - - The local client: \ref agora::rtc::IRtcEngineEventHandler::onJoinChannelSuccess "onJoinChannelSuccess" - - The remote client: \ref agora::rtc::IRtcEngineEventHandler::onUserJoined "onUserJoined" , if the user joining the channel is in the `COMMUNICATION` profile, or is a host in the `LIVE_BROADCASTING` profile. - - When the connection between the client and Agora's server is interrupted due to poor network conditions, the SDK tries reconnecting to the server. When the local client successfully rejoins the channel, the SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onRejoinChannelSuccess "onRejoinChannelSuccess" callback on the local client. - - @note A channel does not accept duplicate uids, such as two users with the same @p uid. If you set @p uid as 0, the system automatically assigns a @p uid. If you want to join a channel from different devices, ensure that each device has a different uid. - @warning Ensure that the App ID used for creating the token is the same App ID used by the \ref IRtcEngine::initialize "initialize" method for initializing the RTC engine. Otherwise, the CDN live streaming may fail. - - @param token Pointer to the token generated by the application server. In most circumstances, a static App ID suffices. For added security, use a token. - - If the user uses a static App ID, *token* is optional and can be set as NULL. - - If the user uses a token, Agora issues an additional App Certificate for you to generate a user key based on the algorithm and App Certificate for user authentication on the server. - @param channelId Pointer to the unique channel name for the Agora RTC session in the string format smaller than 64 bytes. Supported characters: - - All lowercase English letters: a to z. - - All uppercase English letters: A to Z. - - All numeric characters: 0 to 9. - - The space character. - - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". - @param info (Optional) Pointer to additional information about the channel. This parameter can be set to NULL or contain channel related information. Other users in the channel will not receive this message. - @param uid (Optional) User ID. A 32-bit unsigned integer with a value ranging from 1 to 232-1. The @p uid must be unique. If a @p uid is not assigned (or set to 0), the SDK assigns and returns a @p uid in the \ref IRtcEngineEventHandler::onJoinChannelSuccess "onJoinChannelSuccess" callback. Your application must record and maintain the returned *uid* since the SDK does not do so. - - @return - - 0(ERR_OK): Success. - - < 0: Failure. - - -2(ERR_INALID_ARGUMENT): The parameter is invalid. - - -3(ERR_NOT_READY): The SDK fails to be initialized. You can try re-initializing the SDK. - - -5(ERR_REFUSED): The request is rejected. This may be caused by the following: - - You have created an IChannel object with the same channel name. - - You have joined and published a stream in a channel created by the IChannel object. - */ - virtual int joinChannel(const char* token, const char* channelId, const char* info, uid_t uid) = 0; - /** Switches to a different channel. - * - * This method allows the audience of a `LIVE_BROADCASTING` channel to switch - * to a different channel. - * - * After the user successfully switches to another channel, the - * \ref agora::rtc::IRtcEngineEventHandler::onLeaveChannel "onLeaveChannel" - * and \ref agora::rtc::IRtcEngineEventHandler::onJoinChannelSuccess - * "onJoinChannelSuccess" callbacks are triggered to indicate that the - * user has left the original channel and joined a new one. - * - * @note - * This method applies to the audience role in a `LIVE_BROADCASTING` channel - * only. - * - * @param token The token generated at your server: - * - For low-security requirements: You can use the temporary token - * generated in Console. For details, see - * [Get a temporary token](https://docs.agora.io/en/Agora%20Platform/token?platform=All%20Platforms#generate-a-token). - * - For high-security requirements: Use the token generated at your - * server. For details, see - * [Get a token](https://docs.agora.io/en/Interactive%20Broadcast/token_server?platform=All%20Platforms). - * @param channelId Unique channel name for the AgoraRTC session in the - * string format. The string length must be less than 64 bytes. Supported - * character scopes are: - * - All lowercase English letters: a to z. - * - All uppercase English letters: A to Z. - * - All numeric characters: 0 to 9. - * - The space character. - * - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". - * - * @return - * - 0(ERR_OK): Success. - * - < 0: Failure. - * - -1(ERR_FAILED): A general error occurs (no specified reason). - * - -2(ERR_INALID_ARGUMENT): The parameter is invalid. - * - -5(ERR_REFUSED): The request is rejected, probably because the user is not an audience. - * - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. - * - -102(ERR_INVALID_CHANNEL_NAME): The channel name is invalid. - * - -113(ERR_NOT_IN_CHANNEL): The user is not in the channel. - */ - virtual int switchChannel(const char* token, const char* channelId) = 0; + /** Sets the role of the user, such as a host or an audience (default), before joining a channel in the interactive live streaming. + * + * This method can be used to switch the user role in the interactive live streaming after the user joins a channel. + * + * In the `LIVE_BROADCASTING` profile, when a user switches user roles after joining a channel, a successful \ref agora::rtc::IRtcEngine::setClientRole "setClientRole" method call triggers the following callbacks: + * - The local client: \ref agora::rtc::IRtcEngineEventHandler::onClientRoleChanged "onClientRoleChanged" + * - The remote client: \ref agora::rtc::IRtcEngineEventHandler::onUserJoined "onUserJoined" or \ref agora::rtc::IRtcEngineEventHandler::onUserOffline "onUserOffline" (BECOME_AUDIENCE) + * + * @note + * This method applies only to the `LIVE_BROADCASTING` profile. + * + * @param role Sets the role of the user. See #CLIENT_ROLE_TYPE. + * + * @return + * - 0(ERR_OK): Success. + * - < 0: Failure. + * - -1(ERR_FAILED): A general error occurs (no specified reason). + * - -2(ERR_INALID_ARGUMENT): The parameter is invalid. + * - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. + */ + virtual int setClientRole(CLIENT_ROLE_TYPE role) = 0; + + /** Sets the role of a user in interactive live streaming. + * + * @since v3.2.0 + * + * You can call this method either before or after joining the channel to set the user role as audience or host. If + * you call this method to switch the user role after joining the channel, the SDK triggers the following callbacks: + * - The local client: \ref IRtcEngineEventHandler::onClientRoleChanged "onClientRoleChanged". + * - The remote client: \ref IRtcEngineEventHandler::onUserJoined "onUserJoined" + * or \ref IRtcEngineEventHandler::onUserOffline "onUserOffline". + * + * @note + * - This method applies to the `LIVE_BROADCASTING` profile only (when the `profile` parameter in + * \ref IRtcEngine::setChannelProfile "setChannelProfile" is set as `CHANNEL_PROFILE_LIVE_BROADCASTING`). + * - The difference between this method and \ref IRtcEngine::setClientRole(CLIENT_ROLE_TYPE) "setClientRole" [1/2] is that + * this method can set the user level in addition to the user role. + * - The user role determines the permissions that the SDK grants to a user, such as permission to send local + * streams, receive remote streams, and push streams to a CDN address. + * - The user level determines the level of services that a user can enjoy within the permissions of the user's + * role. For example, an audience can choose to receive remote streams with low latency or ultra low latency. Levels + * affect prices. + * + * @param role The role of a user in interactive live streaming. See #CLIENT_ROLE_TYPE. + * @param options The detailed options of a user, including user level. See ClientRoleOptions. + * + * @return + * - 0(ERR_OK): Success. + * - < 0: Failure. + * - -1(ERR_FAILED): A general error occurs (no specified reason). + * - -2(ERR_INALID_ARGUMENT): The parameter is invalid. + * - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. + */ + virtual int setClientRole(CLIENT_ROLE_TYPE role, const ClientRoleOptions& options) = 0; + + /** Joins a channel with the user ID. + + Users in the same channel can talk to each other, and multiple users in the same channel can start a group chat. Users with different App IDs cannot call each other. + + + You must call the \ref IRtcEngine::leaveChannel "leaveChannel" method to exit the current call before entering another channel. + + A successful \ref agora::rtc::IRtcEngine::joinChannel "joinChannel" method call triggers the following callbacks: + - The local client: \ref agora::rtc::IRtcEngineEventHandler::onJoinChannelSuccess "onJoinChannelSuccess". + - The remote client: \ref agora::rtc::IRtcEngineEventHandler::onUserJoined "onUserJoined" , if the user joining the channel is in the `COMMUNICATION` profile, or is a host in the `LIVE_BROADCASTING` profile. + + When the connection between the client and Agora's server is interrupted due to poor network conditions, the SDK tries reconnecting to the server. When the local client successfully rejoins the channel, the SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onRejoinChannelSuccess "onRejoinChannelSuccess" callback on the local client. + + Once the user joins the channel (switches to another channel), the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. If you do not want to subscribe to a specified stream or all remote streams, call the `mute` methods accordingly. - /** Allows a user to leave a channel, such as hanging up or exiting a call. + @note A channel does not accept duplicate uids, such as two users with the same @p uid. If you set @p uid as 0, the system automatically assigns a @p uid. If you want to join a channel from different devices, ensure that each device has a different uid. + @warning Ensure that the App ID used for creating the token is the same App ID used by the \ref IRtcEngine::initialize "initialize" method for initializing the RTC engine. Otherwise, the CDN live streaming may fail. - After joining a channel, the user must call the *leaveChannel* method to end the call before joining another channel. + @param token The token generated at your server. For details, see [Generate a token](https://docs.agora.io/en/Interactive%20Broadcast/token_server?platform=Windows). + @param channelId Pointer to the unique channel name for the Agora RTC session in the string format smaller than 64 bytes. Supported characters: + - All lowercase English letters: a to z. + - All uppercase English letters: A to Z. + - All numeric characters: 0 to 9. + - The space character. + - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". + @param info (Optional) Pointer to additional information about the channel. This parameter can be set to NULL or contain channel related information. Other users in the channel will not receive this message. + @param uid (Optional) User ID. A 32-bit unsigned integer with a value ranging from 1 to 232-1. The @p uid must be unique. If a @p uid is not assigned (or set to 0), the SDK assigns and returns a @p uid in the \ref IRtcEngineEventHandler::onJoinChannelSuccess "onJoinChannelSuccess" callback. Your application must record and maintain the returned `uid`, because the SDK does not do so. - This method returns 0 if the user leaves the channel and releases all resources related to the call. + @return + - 0(ERR_OK): Success. + - < 0: Failure. + - -2(ERR_INALID_ARGUMENT): The parameter is invalid. + - -3(ERR_NOT_READY): The SDK fails to be initialized. You can try re-initializing the SDK. + - -5(ERR_REFUSED): The request is rejected. This may be caused by the following: + - You have created an IChannel object with the same channel name. + - You have joined and published a stream in a channel created by the IChannel object. When you join a channel created by the IRtcEngine object, the SDK publishes the local audio and video streams to that channel by default. Because the SDK does not support publishing a local stream to more than one channel simultaneously, an error occurs in this occasion. + - -7(ERR_NOT_INITIALIZED): The SDK is not initialized before calling this method. + */ + virtual int joinChannel(const char* token, const char* channelId, const char* info, uid_t uid) = 0; + /** Joins a channel with the user ID, and configures whether to automatically subscribe to the audio or video streams. + * + * @since v3.3.0 + * + * Users in the same channel can talk to each other, and multiple users in the same channel can start a group chat. Users with different App IDs cannot call each other. + * + * You must call the \ref IRtcEngine::leaveChannel "leaveChannel" method to exit the current call before entering another channel. + * + * A successful \ref IRtcEngine::joinChannel "joinChannel" method call triggers the following callbacks: + * - The local client: \ref IRtcEngineEventHandler::onJoinChannelSuccess "onJoinChannelSuccess". + * - The remote client: \ref IRtcEngineEventHandler::onUserJoined "onUserJoined", if the user joining the channel is in the `COMMUNICATION` profile, or is a host in the `LIVE_BROADCASTING` profile. + * + * When the connection between the client and the Agora server is interrupted due to poor network conditions, the SDK tries reconnecting to the server. + * When the local client successfully rejoins the channel, the SDK triggers the \ref IRtcEngineEventHandler::onRejoinChannelSuccess "onRejoinChannelSuccess" callback on the local client. + * + * @note + * - Compared with \ref IRtcEngine::joinChannel(const char* token, const char* channelId, const char* info, uid_t uid) "joinChannel" [1/2], this method + * has the options parameter which configures whether the user automatically subscribes to all remote audio and video streams in the channel when + * joining the channel. By default, the user subscribes to the audio and video streams of all the other users in the channel, thus incurring all + * associated usage costs. To unsubscribe, set the `options` parameter or call the `mute` methods accordingly. + * - Ensure that the App ID used for generating the token is the same App ID used in the \ref IRtcEngine::initialize "initialize" method for + * creating an `IRtcEngine` object. + * + * @param token The token generated at your server. For details, see [Generate a token](https://docs.agora.io/en/Interactive%20Broadcast/token_server?platform=Windows). + * @param channelId Pointer to the unique channel name for the Agora RTC session in the string format smaller than 64 bytes. Supported characters: + * - All lowercase English letters: a to z. + * - All uppercase English letters: A to Z. + * - All numeric characters: 0 to 9. + * - The space character. + * - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". + * @param info (Optional) Reserved for future use. + * @param uid (Optional) User ID. A 32-bit unsigned integer with a value ranging from 1 to 232-1. The @p uid must be unique. If a @p uid is + * not assigned (or set to 0), the SDK assigns and returns a @p uid in the \ref IRtcEngineEventHandler::onJoinChannelSuccess "onJoinChannelSuccess" callback. + * Your application must record and maintain the returned `uid`, because the SDK does not do so. **Note**: The ID of each user in the channel should be unique. + * If you want to join the same channel from different devices, ensure that the user IDs in all devices are different. + * @param options The channel media options: ChannelMediaOptions. + @return + * - 0(ERR_OK): Success. + * - < 0: Failure. + * - -2(ERR_INALID_ARGUMENT): The parameter is invalid. + * - -3(ERR_NOT_READY): The SDK fails to be initialized. You can try re-initializing the SDK. + * - -5(ERR_REFUSED): The request is rejected. This may be caused by the following: + * - You have created an IChannel object with the same channel name. + * - You have joined and published a stream in a channel created by the IChannel object. When you join a channel created by the IRtcEngine object, the SDK publishes the local audio and video streams to that channel by default. Because the SDK does not support publishing a local stream to more than one channel simultaneously, an error occurs in this occasion. + * - -7(ERR_NOT_INITIALIZED): The SDK is not initialized before calling this method. + */ + virtual int joinChannel(const char* token, const char* channelId, const char* info, uid_t uid, const ChannelMediaOptions& options) = 0; + /** Switches to a different channel. + * + * This method allows the audience of a `LIVE_BROADCASTING` channel to switch + * to a different channel. + * + * After the user successfully switches to another channel, the + * \ref agora::rtc::IRtcEngineEventHandler::onLeaveChannel "onLeaveChannel" + * and \ref agora::rtc::IRtcEngineEventHandler::onJoinChannelSuccess + * "onJoinChannelSuccess" callbacks are triggered to indicate that the + * user has left the original channel and joined a new one. + * + * Once the user switches to another channel, the user subscribes to the + * audio and video streams of all the other users in the channel by + * default, giving rise to usage and billing calculation. If you do not + * want to subscribe to a specified stream or all remote streams, call + * the `mute` methods accordingly. + * + * @note + * This method applies to the audience role in a `LIVE_BROADCASTING` channel + * only. + * + * @param token The token generated at your server. For details, see [Generate a token](https://docs.agora.io/en/Interactive%20Broadcast/token_server?platform=Windows). + * @param channelId Unique channel name for the AgoraRTC session in the + * string format. The string length must be less than 64 bytes. Supported + * character scopes are: + * - All lowercase English letters: a to z. + * - All uppercase English letters: A to Z. + * - All numeric characters: 0 to 9. + * - The space character. + * - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". + * + * @return + * - 0(ERR_OK): Success. + * - < 0: Failure. + * - -1(ERR_FAILED): A general error occurs (no specified reason). + * - -2(ERR_INALID_ARGUMENT): The parameter is invalid. + * - -5(ERR_REFUSED): The request is rejected, probably because the user is not an audience. + * - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. + * - -102(ERR_INVALID_CHANNEL_NAME): The channel name is invalid. + * - -113(ERR_NOT_IN_CHANNEL): The user is not in the channel. + */ + virtual int switchChannel(const char* token, const char* channelId) = 0; + /** Switches to a different channel, and configures whether to automatically subscribe to audio or video streams in the target channel. + * + * @since v3.3.0 + * + * This method allows the audience of a `LIVE_BROADCASTING` channel to switch to a different channel. + * + * After the user successfully switches to another channel, the \ref IRtcEngineEventHandler::onLeaveChannel "onLeaveChannel" + * and \ref IRtcEngineEventHandler::onJoinChannelSuccess "onJoinChannelSuccess" callbacks are triggered to indicate that + * the user has left the original channel and joined a new one. + * + * @note + * - This method applies to the audience role in a `LIVE_BROADCASTING` channel only. + * - The difference between this method and \ref IRtcEngine::switchChannel(const char* token, const char* channelId) "switchChannel[1/2]" + * is that the former adds the options parameter to configure whether the user automatically subscribes to all remote audio and video streams in the target channel. + * By default, the user subscribes to the audio and video streams of all the other users in the target channel, thus incurring all associated usage costs. + * To unsubscribe, set the `options` parameter or call the `mute` methods accordingly. + * + * @param token The token generated at your server. For details, see [Generate a token](https://docs.agora.io/en/Interactive%20Broadcast/token_server?platform=Windows). + * @param channelId Unique channel name for the AgoraRTC session in the + * string format. The string length must be less than 64 bytes. Supported + * character scopes are: + * - All lowercase English letters: a to z. + * - All uppercase English letters: A to Z. + * - All numeric characters: 0 to 9. + * - The space character. + * - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". + * @param options The channel media options: ChannelMediaOptions. + * + * @return + * - 0(ERR_OK): Success. + * - < 0: Failure. + * - -1(ERR_FAILED): A general error occurs (no specified reason). + * - -2(ERR_INALID_ARGUMENT): The parameter is invalid. + * - -5(ERR_REFUSED): The request is rejected, probably because the user is not an audience. + * - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. + * - -102(ERR_INVALID_CHANNEL_NAME): The channel name is invalid. + * - -113(ERR_NOT_IN_CHANNEL): The user is not in the channel. + */ + virtual int switchChannel(const char* token, const char* channelId, const ChannelMediaOptions& options) = 0; - This method call is asynchronous, and the user has not left the channel when the method call returns. Once the user leaves the channel, the SDK triggers the \ref IRtcEngineEventHandler::onLeaveChannel "onLeaveChannel" callback. + /** Allows a user to leave a channel, such as hanging up or exiting a call. - A successful \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method call triggers the following callbacks: - - The local client: \ref agora::rtc::IRtcEngineEventHandler::onLeaveChannel "onLeaveChannel" - - The remote client: \ref agora::rtc::IRtcEngineEventHandler::onUserOffline "onUserOffline" , if the user leaving the channel is in the `COMMUNICATION` channel, or is a host in the `LIVE_BROADCASTING` profile. + After joining a channel, the user must call the *leaveChannel* method to end the call before joining another channel. - @note - - If you call the \ref IRtcEngine::release "release" method immediately after the *leaveChannel* method, the *leaveChannel* process interrupts, and the \ref IRtcEngineEventHandler::onLeaveChannel "onLeaveChannel" callback is not triggered. - - If you call the *leaveChannel* method during a CDN live streaming, the SDK triggers the \ref IRtcEngine::removePublishStreamUrl "removePublishStreamUrl" method. + This method returns 0 if the user leaves the channel and releases all resources related to the call. - @return - - 0(ERR_OK): Success. - - < 0: Failure. - - -1(ERR_FAILED): A general error occurs (no specified reason). - - -2(ERR_INALID_ARGUMENT): The parameter is invalid. - - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. - */ - virtual int leaveChannel() = 0; + This method call is asynchronous, and the user has not left the channel when the method call returns. Once the user leaves the channel, the SDK triggers the \ref IRtcEngineEventHandler::onLeaveChannel "onLeaveChannel" callback. - /** Gets a new token when the current token expires after a period of time. + A successful \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method call triggers the following callbacks: + - The local client: \ref agora::rtc::IRtcEngineEventHandler::onLeaveChannel "onLeaveChannel" + - The remote client: \ref agora::rtc::IRtcEngineEventHandler::onUserOffline "onUserOffline" , if the user leaving the channel is in the `COMMUNICATION` channel, or is a host in the `LIVE_BROADCASTING` profile. - The `token` expires after a period of time once the token schema is enabled when: + @note + - If you call the \ref IRtcEngine::release "release" method immediately after the *leaveChannel* method, the *leaveChannel* process interrupts, and the \ref IRtcEngineEventHandler::onLeaveChannel "onLeaveChannel" callback is not triggered. + - If you call the *leaveChannel* method during a CDN live streaming, the SDK triggers the \ref IRtcEngine::removePublishStreamUrl "removePublishStreamUrl" method. - - The SDK triggers the \ref IRtcEngineEventHandler::onTokenPrivilegeWillExpire "onTokenPrivilegeWillExpire" callback, or - - The \ref IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged" reports CONNECTION_CHANGED_TOKEN_EXPIRED(9). + @return + - 0(ERR_OK): Success. + - < 0: Failure. + - -1(ERR_FAILED): A general error occurs (no specified reason). + - -2(ERR_INALID_ARGUMENT): The parameter is invalid. + - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. + */ + virtual int leaveChannel() = 0; - The application should call this method to get the new `token`. Failure to do so will result in the SDK disconnecting from the server. + /** Gets a new token when the current token expires after a period of time. - @param token Pointer to the new token. + The `token` expires after a period of time once the token schema is enabled when: - @return - - 0(ERR_OK): Success. - - < 0: Failure. - - -1(ERR_FAILED): A general error occurs (no specified reason). - - -2(ERR_INALID_ARGUMENT): The parameter is invalid. - - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. - */ - virtual int renewToken(const char* token) = 0; + - The SDK triggers the \ref IRtcEngineEventHandler::onTokenPrivilegeWillExpire "onTokenPrivilegeWillExpire" callback, or + - The \ref IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged" reports CONNECTION_CHANGED_TOKEN_EXPIRED(9). - /** Retrieves the pointer to the device manager object. + The application should call this method to get the new `token`. Failure to do so will result in the SDK disconnecting from the server. - @param iid ID of the interface. - @param inter Pointer to the *DeviceManager* object. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int queryInterface(INTERFACE_ID_TYPE iid, void** inter) = 0; - - /** Registers a user account. - - Once registered, the user account can be used to identify the local user when the user joins the channel. - After the user successfully registers a user account, the SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onLocalUserRegistered "onLocalUserRegistered" callback on the local client, - reporting the user ID and user account of the local user. - - To join a channel with a user account, you can choose either of the following: - - - Call the \ref agora::rtc::IRtcEngine::registerLocalUserAccount "registerLocalUserAccount" method to create a user account, and then the \ref agora::rtc::IRtcEngine::joinChannelWithUserAccount "joinChannelWithUserAccount" method to join the channel. - - Call the \ref agora::rtc::IRtcEngine::joinChannelWithUserAccount "joinChannelWithUserAccount" method to join the channel. - - The difference between the two is that for the former, the time elapsed between calling the \ref agora::rtc::IRtcEngine::joinChannelWithUserAccount "joinChannelWithUserAccount" method - and joining the channel is shorter than the latter. - - @note - - Ensure that you set the `userAccount` parameter. Otherwise, this method does not take effect. - - Ensure that the value of the `userAccount` parameter is unique in the channel. - - To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the uid of the user is set to the same parameter type. - - @param appId The App ID of your project. - @param userAccount The user account. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as null. Supported character scopes are: - - All lowercase English letters: a to z. - - All uppercase English letters: A to Z. - - All numeric characters: 0 to 9. - - The space character. - - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int registerLocalUserAccount( - const char* appId, const char* userAccount) = 0; - /** Joins the channel with a user account. - - After the user successfully joins the channel, the SDK triggers the following callbacks: - - - The local client: \ref agora::rtc::IRtcEngineEventHandler::onLocalUserRegistered "onLocalUserRegistered" and \ref agora::rtc::IRtcEngineEventHandler::onJoinChannelSuccess "onJoinChannelSuccess" . - The remote client: \ref agora::rtc::IRtcEngineEventHandler::onUserJoined "onUserJoined" and \ref agora::rtc::IRtcEngineEventHandler::onUserInfoUpdated "onUserInfoUpdated" , if the user joining the channel is in the `COMMUNICATION` profile, or is a host in the `LIVE_BROADCASTING` profile. - - @note To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. - If a user joins the channel with the Agora Web SDK, ensure that the uid of the user is set to the same parameter type. - - @param token The token generated at your server: - - For low-security requirements: You can use the temporary token generated at Console. For details, see [Get a temporary toke](https://docs.agora.io/en/Voice/token?platform=All%20Platforms#get-a-temporary-token). - - For high-security requirements: Set it as the token generated at your server. For details, see [Get a token](https://docs.agora.io/en/Voice/token?platform=All%20Platforms#get-a-token). - @param channelId The channel name. The maximum length of this parameter is 64 bytes. Supported character scopes are: - - All lowercase English letters: a to z. - - All uppercase English letters: A to Z. - - All numeric characters: 0 to 9. - - The space character. - - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". - @param userAccount The user account. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as null. Supported character scopes are: - - All lowercase English letters: a to z. - - All uppercase English letters: A to Z. - - All numeric characters: 0 to 9. - - The space character. - - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". - - @return - - 0: Success. - - < 0: Failure. - - #ERR_INVALID_ARGUMENT (-2) - - #ERR_NOT_READY (-3) - - #ERR_REFUSED (-5) - */ - virtual int joinChannelWithUserAccount(const char* token, - const char* channelId, - const char* userAccount) = 0; + @param token Pointer to the new token. - /** Gets the user information by passing in the user account. + @return + - 0(ERR_OK): Success. + - < 0: Failure. + - -1(ERR_FAILED): A general error occurs (no specified reason). + - -2(ERR_INALID_ARGUMENT): The parameter is invalid. + - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. + */ + virtual int renewToken(const char* token) = 0; - After a remote user joins the channel, the SDK gets the user ID and user account of the remote user, caches them - in a mapping table object (`userInfo`), and triggers the \ref agora::rtc::IRtcEngineEventHandler::onUserInfoUpdated "onUserInfoUpdated" callback on the local client. + /** Gets the pointer to the device manager object. - After receiving the o\ref agora::rtc::IRtcEngineEventHandler::onUserInfoUpdated "onUserInfoUpdated" callback, you can call this method to get the user ID of the - remote user from the `userInfo` object by passing in the user account. + @param iid ID of the interface. + @param inter Pointer to the *DeviceManager* object. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int queryInterface(INTERFACE_ID_TYPE iid, void** inter) = 0; - @param userAccount The user account of the user. Ensure that you set this parameter. - @param [in,out] userInfo A userInfo object that identifies the user: - - Input: A userInfo object. - - Output: A userInfo object that contains the user account and user ID of the user. + /** Registers a user account. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getUserInfoByUserAccount(const char* userAccount, UserInfo* userInfo) = 0; - /** Gets the user information by passing in the user ID. + Once registered, the user account can be used to identify the local user when the user joins the channel. + After the user successfully registers a user account, the SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onLocalUserRegistered "onLocalUserRegistered" callback on the local client, + reporting the user ID and user account of the local user. - After a remote user joins the channel, the SDK gets the user ID and user account of the remote user, - caches them in a mapping table object (`userInfo`), and triggers the \ref agora::rtc::IRtcEngineEventHandler::onUserInfoUpdated "onUserInfoUpdated" callback on the local client. + To join a channel with a user account, you can choose either of the following: - After receiving the \ref agora::rtc::IRtcEngineEventHandler::onUserInfoUpdated "onUserInfoUpdated" callback, you can call this method to get the user account of the remote user - from the `userInfo` object by passing in the user ID. + - Call the \ref agora::rtc::IRtcEngine::registerLocalUserAccount "registerLocalUserAccount" method to create a user account, and then the \ref agora::rtc::IRtcEngine::joinChannelWithUserAccount "joinChannelWithUserAccount" method to join the channel. + - Call the \ref agora::rtc::IRtcEngine::joinChannelWithUserAccount "joinChannelWithUserAccount" method to join the channel. - @param uid The user ID of the remote user. Ensure that you set this parameter. - @param[in,out] userInfo A userInfo object that identifies the user: - - Input: A userInfo object. - - Output: A userInfo object that contains the user account and user ID of the user. + The difference between the two is that for the former, the time elapsed between calling the \ref agora::rtc::IRtcEngine::joinChannelWithUserAccount "joinChannelWithUserAccount" method + and joining the channel is shorter than the latter. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getUserInfoByUid(uid_t uid, UserInfo* userInfo) = 0; + @note + - Ensure that you set the `userAccount` parameter. Otherwise, this method does not take effect. + - Ensure that the value of the `userAccount` parameter is unique in the channel. + - To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the uid of the user is set to the same parameter type. - /** **DEPRECATED** Starts an audio call test. + @param appId The App ID of your project. + @param userAccount The user account. The maximum length of this parameter is 255 bytes. Ensure that the user account is unique and do not set it as null. Supported character scopes are: + - All lowercase English letters: a to z. + - All uppercase English letters: A to Z. + - All numeric characters: 0 to 9. + - The space character. + - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". - This method is deprecated as of v2.4.0. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int registerLocalUserAccount(const char* appId, const char* userAccount) = 0; + /** Joins the channel with a user account. - This method starts an audio call test to check whether the audio devices (for example, headset and speaker) and the network connection are working properly. + After the user successfully joins the channel, the SDK triggers the following callbacks: - To conduct the test: + - The local client: \ref agora::rtc::IRtcEngineEventHandler::onLocalUserRegistered "onLocalUserRegistered" and \ref agora::rtc::IRtcEngineEventHandler::onJoinChannelSuccess "onJoinChannelSuccess" . + - The remote client: \ref agora::rtc::IRtcEngineEventHandler::onUserJoined "onUserJoined" and \ref agora::rtc::IRtcEngineEventHandler::onUserInfoUpdated "onUserInfoUpdated" , if the user joining the channel is in the `COMMUNICATION` profile, or is a host in the `LIVE_BROADCASTING` profile. - - The user speaks and the recording is played back within 10 seconds. - - If the user can hear the recording within 10 seconds, the audio devices and network connection are working properly. + Once the user joins the channel (switches to another channel), the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. If you do not want to subscribe to a specified stream or all remote streams, call the `mute` methods accordingly. - @note - - After calling this method, always call the \ref IRtcEngine::stopEchoTest "stopEchoTest" method to end the test. Otherwise, the application cannot run the next echo test. - - In the `LIVE_BROADCASTING` profile, only the hosts can call this method. If the user switches from the `COMMUNICATION` to`LIVE_BROADCASTING` profile, the user must call the \ref IRtcEngine::setClientRole "setClientRole" method to change the user role from the audience (default) to the host before calling this method. + @note To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. + If a user joins the channel with the Agora Web SDK, ensure that the uid of the user is set to the same parameter type. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int startEchoTest() = 0; + @param token The token generated at your server. For details, see [Generate a token](https://docs.agora.io/en/Interactive%20Broadcast/token_server?platform=Windows). + @param channelId The channel name. The maximum length of this parameter is 64 bytes. Supported character scopes are: + - All lowercase English letters: a to z. + - All uppercase English letters: A to Z. + - All numeric characters: 0 to 9. + - The space character. + - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". + @param userAccount The user account. The maximum length of this parameter is 255 bytes. Ensure that the user account is unique and do not set it as null. Supported character scopes are: + - All lowercase English letters: a to z. + - All uppercase English letters: A to Z. + - All numeric characters: 0 to 9. + - The space character. + - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". - /** Starts an audio call test. + @return + - 0: Success. + - < 0: Failure. + - #ERR_INVALID_ARGUMENT (-2) + - #ERR_NOT_READY (-3) + - #ERR_REFUSED (-5) + - #ERR_NOT_INITIALIZED (-7) + */ + virtual int joinChannelWithUserAccount(const char* token, const char* channelId, const char* userAccount) = 0; + /** Joins the channel with a user account, and configures whether to automatically subscribe to audio or video streams after joining the channel. + * + * @since v3.3.0 + * + * After the user successfully joins the channel, the SDK triggers the following callbacks: + * - The local client: \ref agora::rtc::IRtcEngineEventHandler::onLocalUserRegistered "onLocalUserRegistered" and \ref agora::rtc::IRtcEngineEventHandler::onJoinChannelSuccess "onJoinChannelSuccess" . + * - The remote client: \ref agora::rtc::IRtcEngineEventHandler::onUserJoined "onUserJoined" and \ref agora::rtc::IRtcEngineEventHandler::onUserInfoUpdated "onUserInfoUpdated" , if the user joining the channel is in the `COMMUNICATION` profile, or is a host in the `LIVE_BROADCASTING` profile. + * + * @note + * - Compared with \ref IRtcEngine::joinChannelWithUserAccount(const char* token, const char* channelId, const char* userAccount) "joinChannelWithUserAccount" [1/2], + * this method has the options parameter to configure whether the end user automatically subscribes to all remote audio and video streams in a + * channel when joining the channel. By default, the user subscribes to the audio and video streams of all the other users in the channel, thus + * incurring all associated usage costs. To unsubscribe, set the `options` parameter or call the `mute` methods accordingly. + * - To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all + * the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the + * uid of the user is set to the same parameter type. + * + * @param token The token generated at your server. For details, see [Generate a token](https://docs.agora.io/en/Interactive%20Broadcast/token_server?platform=Windows). + * @param channelId The channel name. The maximum length of this parameter is 64 bytes. Supported character scopes are: + * - All lowercase English letters: a to z. + * - All uppercase English letters: A to Z. + * - All numeric characters: 0 to 9. + * - The space character. + * - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". + * @param userAccount The user account. The maximum length of this parameter is 255 bytes. Ensure that the user account is unique and do not set it as null. Supported character scopes are: + * - All lowercase English letters: a to z. + * - All uppercase English letters: A to Z. + * - All numeric characters: 0 to 9. + * - The space character. + * - Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",". + * @param options The channel media options: ChannelMediaOptions. + * @return + * - 0: Success. + * - < 0: Failure. + * - #ERR_INVALID_ARGUMENT (-2) + * - #ERR_NOT_READY (-3) + * - #ERR_REFUSED (-5) + */ + virtual int joinChannelWithUserAccount(const char* token, const char* channelId, const char* userAccount, const ChannelMediaOptions& options) = 0; - This method starts an audio call test to determine whether the audio devices (for example, headset and speaker) and the network connection are working properly. + /** Gets the user information by passing in the user account. - In the audio call test, you record your voice. If the recording plays back within the set time interval, the audio devices and the network connection are working properly. + After a remote user joins the channel, the SDK gets the user ID and user account of the remote user, caches them + in a mapping table object (`userInfo`), and triggers the \ref agora::rtc::IRtcEngineEventHandler::onUserInfoUpdated "onUserInfoUpdated" callback on the local client. - @note - - Call this method before joining a channel. - - After calling this method, call the \ref IRtcEngine::stopEchoTest "stopEchoTest" method to end the test. Otherwise, the app cannot run the next echo test, or call the \ref IRtcEngine::joinChannel "joinChannel" method. - - In the `LIVE_BROADCASTING` profile, only a host can call this method. - @param intervalInSeconds The time interval (s) between when you speak and when the recording plays back. + After receiving the o\ref agora::rtc::IRtcEngineEventHandler::onUserInfoUpdated "onUserInfoUpdated" callback, you can call this method to get the user ID of the + remote user from the `userInfo` object by passing in the user account. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int startEchoTest(int intervalInSeconds) = 0; + @param userAccount The user account of the user. Ensure that you set this parameter. + @param [in,out] userInfo A userInfo object that identifies the user: + - Input: A userInfo object. + - Output: A userInfo object that contains the user account and user ID of the user. - /** Stops the audio call test. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getUserInfoByUserAccount(const char* userAccount, UserInfo* userInfo) = 0; + /** Gets the user information by passing in the user ID. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int stopEchoTest() = 0; + After a remote user joins the channel, the SDK gets the user ID and user account of the remote user, + caches them in a mapping table object (`userInfo`), and triggers the \ref agora::rtc::IRtcEngineEventHandler::onUserInfoUpdated "onUserInfoUpdated" callback on the local client. - /** Enables the video module. + After receiving the \ref agora::rtc::IRtcEngineEventHandler::onUserInfoUpdated "onUserInfoUpdated" callback, you can call this method to get the user account of the remote user + from the `userInfo` object by passing in the user ID. - Call this method either before joining a channel or during a call. If this method is called before joining a channel, the call starts in the video mode. If this method is called during an audio call, the audio mode switches to the video mode. To disable the video module, call the \ref IRtcEngine::disableVideo "disableVideo" method. + @param uid The user ID of the remote user. Ensure that you set this parameter. + @param[in,out] userInfo A userInfo object that identifies the user: + - Input: A userInfo object. + - Output: A userInfo object that contains the user account and user ID of the user. - A successful \ref agora::rtc::IRtcEngine::enableVideo "enableVideo" method call triggers the \ref agora::rtc::IRtcEngineEventHandler::onUserEnableVideo "onUserEnableVideo" (true) callback on the remote client. - @note - - This method affects the internal engine and can be called after the \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method. - - This method resets the internal engine and takes some time to take effect. We recommend using the following API methods to control the video engine modules separately: - - \ref IRtcEngine::enableLocalVideo "enableLocalVideo": Whether to enable the camera to create the local video stream. - - \ref IRtcEngine::muteLocalVideoStream "muteLocalVideoStream": Whether to publish the local video stream. - - \ref IRtcEngine::muteRemoteVideoStream "muteRemoteVideoStream": Whether to subscribe to and play the remote video stream. - - \ref IRtcEngine::muteAllRemoteVideoStreams "muteAllRemoteVideoStreams": Whether to subscribe to and play all remote video streams. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getUserInfoByUid(uid_t uid, UserInfo* userInfo) = 0; - @return - - 0: Success. - - < 0: Failure. - */ - virtual int enableVideo() = 0; + /** **DEPRECATED** Starts an audio call test. - /** Disables the video module. + This method is deprecated as of v2.4.0. - This method can be called before joining a channel or during a call. If this method is called before joining a channel, the call starts in audio mode. If this method is called during a video call, the video mode switches to the audio mode. To enable the video module, call the \ref IRtcEngine::enableVideo "enableVideo" method. + This method starts an audio call test to check whether the audio devices (for example, headset and speaker) and the network connection are working properly. - A successful \ref agora::rtc::IRtcEngine::disableVideo "disableVideo" method call triggers the \ref agora::rtc::IRtcEngineEventHandler::onUserEnableVideo "onUserEnableVideo" (false) callback on the remote client. - @note - - This method affects the internal engine and can be called after the \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method. - - This method resets the internal engine and takes some time to take effect. We recommend using the following API methods to control the video engine modules separately: - - \ref IRtcEngine::enableLocalVideo "enableLocalVideo": Whether to enable the camera to create the local video stream. - - \ref IRtcEngine::muteLocalVideoStream "muteLocalVideoStream": Whether to publish the local video stream. - - \ref IRtcEngine::muteRemoteVideoStream "muteRemoteVideoStream": Whether to subscribe to and play the remote video stream. - - \ref IRtcEngine::muteAllRemoteVideoStreams "muteAllRemoteVideoStreams": Whether to subscribe to and play all remote video streams. + To conduct the test: - @return - - 0: Success. - - < 0: Failure. - */ - virtual int disableVideo() = 0; + - The user speaks and the recording is played back within 10 seconds. + - If the user can hear the recording within 10 seconds, the audio devices and network connection are working properly. - /** **DEPRECATED** Sets the video profile. + @note + - After calling this method, always call the \ref IRtcEngine::stopEchoTest "stopEchoTest" method to end the test. Otherwise, the application cannot run the next echo test. + - In the `LIVE_BROADCASTING` profile, only the hosts can call this method. If the user switches from the `COMMUNICATION` to`LIVE_BROADCASTING` profile, the user must call the \ref IRtcEngine::setClientRole "setClientRole" method to change the user role from the audience (default) to the host before calling this method. - This method is deprecated as of v2.3. Use the \ref IRtcEngine::setVideoEncoderConfiguration "setVideoEncoderConfiguration" method instead. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int startEchoTest() = 0; - Each video profile includes a set of parameters, such as the resolution, frame rate, and bitrate. If the camera device does not support the specified resolution, the SDK automatically chooses a suitable camera resolution, keeping the encoder resolution specified by the *setVideoProfile* method. + /** Starts an audio call test. - @note - - You can call this method either before or after joining a channel. - - If you do not need to set the video profile after joining the channel, call this method before the \ref IRtcEngine::enableVideo "enableVideo" method to reduce the render time of the first video frame. - - Always set the video profile before calling the \ref IRtcEngine::joinChannel "joinChannel" or \ref IRtcEngine::startPreview "startPreview" method. + This method starts an audio call test to determine whether the audio devices (for example, headset and speaker) and the network connection are working properly. - @param profile Sets the video profile. See #VIDEO_PROFILE_TYPE. - @param swapWidthAndHeight Sets whether to swap the width and height of the video stream: - - true: Swap the width and height. - - false: (Default) Do not swap the width and height. - The width and height of the output video are consistent with the set video profile. - @note Since the landscape or portrait mode of the output video can be decided directly by the video profile, We recommend setting *swapWidthAndHeight* to *false* (default). + In the audio call test, you record your voice. If the recording plays back within the set time interval, the audio devices and the network connection are working properly. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setVideoProfile(VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight) = 0; + @note + - Call this method before joining a channel. + - After calling this method, call the \ref IRtcEngine::stopEchoTest "stopEchoTest" method to end the test. Otherwise, the app cannot run the next echo test, or call the \ref IRtcEngine::joinChannel "joinChannel" method. + - In the `LIVE_BROADCASTING` profile, only a host can call this method. + @param intervalInSeconds The time interval (s) between when you speak and when the recording plays back. - /** Sets the video encoder configuration. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int startEchoTest(int intervalInSeconds) = 0; - Each video encoder configuration corresponds to a set of video parameters, including the resolution, frame rate, bitrate, and video orientation. + /** Stops the audio call test. - The parameters specified in this method are the maximum values under ideal network conditions. If the video engine cannot render the video using the specified parameters due to poor network conditions, the parameters further down the list are considered until a successful configuration is found. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int stopEchoTest() = 0; + /** Sets the Agora cloud proxy service. + * + * @since v3.3.0 + * + * When the user's firewall restricts the IP address and port, refer to *Use Cloud Proxy* to add the specific + * IP addresses and ports to the firewall whitelist; then, call this method to enable the cloud proxy and set + * the `proxyType` parameter as `UDP_PROXY(1)`, which is the cloud proxy for the UDP protocol. + * + * After a successfully cloud proxy connection, the SDK triggers the \ref IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged" (CONNECTION_STATE_CONNECTING, CONNECTION_CHANGED_SETTING_PROXY_SERVER) callback. + * + * To disable the cloud proxy that has been set, call `setCloudProxy(NONE_PROXY)`. To change the cloud proxy type that has been set, + * call `setCloudProxy(NONE_PROXY)` first, and then call `setCloudProxy`, and pass the value that you expect in `proxyType`. + * + * @note + * - Agora recommends that you call this method before joining the channel or after leaving the channel. + * - When you use the cloud proxy for the UDP protocol, the services for pushing streams to CDN and co-hosting across channels are not available. + * + * @param proxyType The cloud proxy type, see #CLOUD_PROXY_TYPE. This parameter is required, and the SDK reports an error if you do not pass in a value. + * + * @return + * - 0: Success. + * - < 0: Failure. + * - `-2(ERR_INVALID_ARGUMENT)`: The parameter is invalid. + * - `-7(ERR_NOT_INITIALIZED)`: The SDK is not initialized. + */ + virtual int setCloudProxy(CLOUD_PROXY_TYPE proxyType) = 0; + /** Enables the video module. + * + * Call this method either before joining a channel or during a call. If this method is called before joining a channel, the call starts in the video mode. If this method is called during an audio call, the audio mode switches to the video mode. To disable the video module, call the \ref IRtcEngine::disableVideo "disableVideo" method. + * + * A successful \ref agora::rtc::IRtcEngine::enableVideo "enableVideo" method call triggers the \ref agora::rtc::IRtcEngineEventHandler::onUserEnableVideo "onUserEnableVideo" (true) callback on the remote client. + * @note + * - This method affects the internal engine and can be called after the \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method. + * - This method resets the internal engine and takes some time to take effect. We recommend using the following API methods to control the video engine modules separately: + * - \ref IRtcEngine::enableLocalVideo "enableLocalVideo": Whether to enable the camera to create the local video stream. + * - \ref IRtcEngine::muteLocalVideoStream "muteLocalVideoStream": Whether to publish the local video stream. + * - \ref IRtcEngine::muteRemoteVideoStream "muteRemoteVideoStream": Whether to subscribe to and play the remote video stream. + * - \ref IRtcEngine::muteAllRemoteVideoStreams "muteAllRemoteVideoStreams": Whether to subscribe to and play all remote video streams. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int enableVideo() = 0; - @note - - You can call this method either before or after joining a channel. - - If you do not need to set the video encoder configuration after joining the channel, you can call this method before the \ref IRtcEngine::enableVideo "enableVideo" method to reduce the render time of the first video frame. + /** Disables the video module. - @param config Sets the local video encoder configuration. See VideoEncoderConfiguration. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setVideoEncoderConfiguration(const VideoEncoderConfiguration& config) = 0; - /** Sets the camera capture configuration. + This method can be called before joining a channel or during a call. If this method is called before joining a channel, the call starts in audio mode. If this method is called during a video call, the video mode switches to the audio mode. To enable the video module, call the \ref IRtcEngine::enableVideo "enableVideo" method. - For a video call or the live interactive video streaming, generally the SDK controls the camera output parameters. When the default camera capturer settings do not meet special requirements or cause performance problems, we recommend using this method to set the camera capturer configuration: + A successful \ref agora::rtc::IRtcEngine::disableVideo "disableVideo" method call triggers the \ref agora::rtc::IRtcEngineEventHandler::onUserEnableVideo "onUserEnableVideo" (false) callback on the remote client. + @note + - This method affects the internal engine and can be called after the \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method. + - This method resets the internal engine and takes some time to take effect. We recommend using the following API methods to control the video engine modules separately: + - \ref IRtcEngine::enableLocalVideo "enableLocalVideo": Whether to enable the camera to create the local video stream. + - \ref IRtcEngine::muteLocalVideoStream "muteLocalVideoStream": Whether to publish the local video stream. + - \ref IRtcEngine::muteRemoteVideoStream "muteRemoteVideoStream": Whether to subscribe to and play the remote video stream. + - \ref IRtcEngine::muteAllRemoteVideoStreams "muteAllRemoteVideoStreams": Whether to subscribe to and play all remote video streams. - - If the resolution or frame rate of the captured raw video data are higher than those set by \ref IRtcEngine::setVideoEncoderConfiguration "setVideoEncoderConfiguration", processing video frames requires extra CPU and RAM usage and degrades performance. We recommend setting config as CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE = 1 to avoid such problems. - - If you do not need local video preview or are willing to sacrifice preview quality, we recommend setting config as CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE = 1 to optimize CPU and RAM usage. - - If you want better quality for the local video preview, we recommend setting config as CAPTURER_OUTPUT_PREFERENCE_PREVIEW = 2. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int disableVideo() = 0; - @note Call this method before enabling the local camera. That said, you can call this method before calling \ref agora::rtc::IRtcEngine::joinChannel "joinChannel", \ref agora::rtc::IRtcEngine::enableVideo "enableVideo", or \ref IRtcEngine::enableLocalVideo "enableLocalVideo", depending on which method you use to turn on your local camera. + /** **DEPRECATED** Sets the video profile. - @param config Sets the camera capturer configuration. See CameraCapturerConfiguration. + This method is deprecated as of v2.3. Use the \ref IRtcEngine::setVideoEncoderConfiguration "setVideoEncoderConfiguration" method instead. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setCameraCapturerConfiguration(const CameraCapturerConfiguration& config) = 0; + Each video profile includes a set of parameters, such as the resolution, frame rate, and bitrate. If the camera device does not support the specified resolution, the SDK automatically chooses a suitable camera resolution, keeping the encoder resolution specified by the *setVideoProfile* method. - /** Initializes the local video view. + @note + - You can call this method either before or after joining a channel. + - If you do not need to set the video profile after joining the channel, call this method before the \ref IRtcEngine::enableVideo "enableVideo" method to reduce the render time of the first video frame. + - Always set the video profile before calling the \ref IRtcEngine::joinChannel "joinChannel" or \ref IRtcEngine::startPreview "startPreview" method. - This method initializes the video view of a local stream on the local device. It affects only the video view that the local user sees, not the published local video stream. + @param profile Sets the video profile. See #VIDEO_PROFILE_TYPE. + @param swapWidthAndHeight Sets whether to swap the width and height of the video stream: + - true: Swap the width and height. + - false: (Default) Do not swap the width and height. + The width and height of the output video are consistent with the set video profile. + @note Since the landscape or portrait mode of the output video can be decided directly by the video profile, We recommend setting *swapWidthAndHeight* to *false* (default). - Call this method to bind the local video stream to a video view and to set the rendering and mirror modes of the video view. - The binding is still valid after the user leaves the channel, which means that the window still displays. To unbind the view, set the *view* in VideoCanvas to NULL. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setVideoProfile(VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight) = 0; - @note - - You can call this method either before or after joining a channel. - - During a call, you can call this method as many times as necessary to update the display mode of the local video view. + /** Sets the video encoder configuration. - @param canvas Pointer to the local video view and settings. See VideoCanvas. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setupLocalVideo(const VideoCanvas& canvas) = 0; + Each video encoder configuration corresponds to a set of video parameters, including the resolution, frame rate, bitrate, and video orientation. - /** Initializes the video view of a remote user. + The parameters specified in this method are the maximum values under ideal network conditions. If the video engine cannot render the video using the specified parameters due to poor network conditions, the parameters further down the list are considered until a successful configuration is found. - This method initializes the video view of a remote stream on the local device. It affects only the video view that the local user sees. + @note + - You can call this method either before or after joining a channel. + - If you do not need to set the video encoder configuration after joining the channel, you can call this method before the \ref IRtcEngine::enableVideo "enableVideo" method to reduce the render time of the first video frame. - Call this method to bind the remote video stream to a video view and to set the rendering and mirror modes of the video view. + @param config Sets the local video encoder configuration. See VideoEncoderConfiguration. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setVideoEncoderConfiguration(const VideoEncoderConfiguration& config) = 0; + /** Sets the camera capture configuration. - The application specifies the uid of the remote video in this method before the remote user joins the channel. If the remote uid is unknown to the application, set it after the application receives the \ref IRtcEngineEventHandler::onUserJoined "onUserJoined" callback. - If the Video Recording function is enabled, the Video Recording Service joins the channel as a dummy client, causing other clients to also receive the \ref IRtcEngineEventHandler::onUserJoined "onUserJoined" callback. Do not bind the dummy client to the application view because the dummy client does not send any video streams. If your application does not recognize the dummy client, bind the remote user to the view when the SDK triggers the \ref IRtcEngineEventHandler::onFirstRemoteVideoDecoded "onFirstRemoteVideoDecoded" callback. - To unbind the remote user from the view, set the view in VideoCanvas to NULL. Once the remote user leaves the channel, the SDK unbinds the remote user. + For a video call or the interactive live video streaming, generally the SDK controls the camera output parameters. When the default camera capturer settings do not meet special requirements or cause performance problems, we recommend using this method to set the camera capturer configuration: - @note To update the rendering or mirror mode of the remote video view during a call, use the \ref IRtcEngine::setRemoteRenderMode "setRemoteRenderMode" method. + - If the resolution or frame rate of the captured raw video data are higher than those set by \ref IRtcEngine::setVideoEncoderConfiguration "setVideoEncoderConfiguration", processing video frames requires extra CPU and RAM usage and degrades performance. We recommend setting config as #CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE (1) to avoid such problems. + - If you do not need local video preview or are willing to sacrifice preview quality, we recommend setting config as #CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE (1) to optimize CPU and RAM usage. + - If you want better quality for the local video preview, we recommend setting config as #CAPTURER_OUTPUT_PREFERENCE_PREVIEW (2). + - To customize the width and height of the video image captured by the local camera, set the camera capture configuration as #CAPTURER_OUTPUT_PREFERENCE_MANUAL (3). - @param canvas Pointer to the remote video view and settings. See VideoCanvas. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setupRemoteVideo(const VideoCanvas& canvas) = 0; + @note Call this method before enabling the local camera. That said, you can call this method before calling \ref agora::rtc::IRtcEngine::joinChannel "joinChannel", \ref agora::rtc::IRtcEngine::enableVideo "enableVideo", or \ref IRtcEngine::enableLocalVideo "enableLocalVideo", depending on which method you use to turn on your local camera. - /** Starts the local video preview before joining the channel. + @param config Sets the camera capturer configuration. See CameraCapturerConfiguration. - Before calling this method, you must: + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setCameraCapturerConfiguration(const CameraCapturerConfiguration& config) = 0; - - Call the \ref IRtcEngine::setupLocalVideo "setupLocalVideo" method to set up the local preview window and configure the attributes. - - Call the \ref IRtcEngine::enableVideo "enableVideo" method to enable video. + /** Initializes the local video view. - @note Once the startPreview method is called to start the local video preview, if you leave the channel by calling the \ref IRtcEngine::leaveChannel "leaveChannel" method, the local video preview remains until you call the \ref IRtcEngine::stopPreview "stopPreview" method to disable it. + This method initializes the video view of a local stream on the local device. It affects only the video view that the local user sees, not the published local video stream. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int startPreview() = 0; - - /** Prioritizes a remote user's stream. - * - * The SDK ensures the high-priority user gets the best possible stream quality. - * - * @note - * - The Agora SDK supports setting @p userPriority as high for one user only. - * - Ensure that you call this method before joining a channel. - * - * @param uid The ID of the remote user. - * @param userPriority Sets the priority of the remote user. See #PRIORITY_TYPE. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int setRemoteUserPriority(uid_t uid, PRIORITY_TYPE userPriority) = 0; + Call this method to bind the local video stream to a video view and to set the rendering and mirror modes of the video view. + The binding is still valid after the user leaves the channel, which means that the window still displays. To unbind the view, set the *view* in VideoCanvas to NULL. - /** Stops the local video preview and disables video. + @note + - You can call this method either before or after joining a channel. + - During a call, you can call this method as many times as necessary to update the display mode of the local video view. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int stopPreview() = 0; + @param canvas Pointer to the local video view and settings. See VideoCanvas. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setupLocalVideo(const VideoCanvas& canvas) = 0; - /** Enables the audio module. + /** Initializes the video view of a remote user. - The audio mode is enabled by default. + This method initializes the video view of a remote stream on the local device. It affects only the video view that the local user sees. - @note - - This method affects the internal engine and can be called after the \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method. You can call this method either before or after joining a channel. - - This method resets the internal engine and takes some time to take effect. We recommend using the following API methods to control the audio engine modules separately: - - \ref IRtcEngine::enableLocalAudio "enableLocalAudio": Whether to enable the microphone to create the local audio stream. - - \ref IRtcEngine::muteLocalAudioStream "muteLocalAudioStream": Whether to publish the local audio stream. - - \ref IRtcEngine::muteRemoteAudioStream "muteRemoteAudioStream": Whether to subscribe to and play the remote audio stream. - - \ref IRtcEngine::muteAllRemoteAudioStreams "muteAllRemoteAudioStreams": Whether to subscribe to and play all remote audio streams. + Call this method to bind the remote video stream to a video view and to set the rendering and mirror modes of the video view. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int enableAudio() = 0; + The application specifies the uid of the remote video in this method before the remote user joins the channel. If the remote uid is unknown to the application, set it after the application receives the \ref IRtcEngineEventHandler::onUserJoined "onUserJoined" callback. + If the Video Recording function is enabled, the Video Recording Service joins the channel as a dummy client, causing other clients to also receive the \ref IRtcEngineEventHandler::onUserJoined "onUserJoined" callback. Do not bind the dummy client to the application view because the dummy client does not send any video streams. If your application does not recognize the dummy client, bind the remote user to the view when the SDK triggers the \ref IRtcEngineEventHandler::onFirstRemoteVideoDecoded "onFirstRemoteVideoDecoded" callback. + To unbind the remote user from the view, set the view in VideoCanvas to NULL. Once the remote user leaves the channel, the SDK unbinds the remote user. - /** Disables/Re-enables the local audio function. + @note To update the rendering or mirror mode of the remote video view during a call, use the \ref IRtcEngine::setRemoteRenderMode "setRemoteRenderMode" method. - The audio function is enabled by default. This method disables or re-enables the local audio function, that is, to stop or restart local audio capturing. + @param canvas Pointer to the remote video view and settings. See VideoCanvas. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setupRemoteVideo(const VideoCanvas& canvas) = 0; - This method does not affect receiving or playing the remote audio streams,and enableLocalAudio(false) is applicable to scenarios where the user wants to - receive remote audio streams without sending any audio stream to other users in the channel. + /** Starts the local video preview before joining the channel. - Once the local audio function is disabled or re-enabled, the SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onLocalAudioStateChanged "onLocalAudioStateChanged" callback, - which reports `LOCAL_AUDIO_STREAM_STATE_STOPPED(0)` or `LOCAL_AUDIO_STREAM_STATE_RECORDING(1)`. + Before calling this method, you must: - @note - - This method is different from the \ref agora::rtc::IRtcEngine::muteLocalAudioStream "muteLocalAudioStream" method: - - \ref agora::rtc::IRtcEngine::enableLocalAudio "enableLocalAudio": Disables/Re-enables the local audio capturing and processing. - If you disable or re-enable local audio recording using the `enableLocalAudio` method, the local user may hear a pause in the remote audio playback. - - \ref agora::rtc::IRtcEngine::muteLocalAudioStream "muteLocalAudioStream": Sends/Stops sending the local audio streams. - - You can call this method either before or after joining a channel. + - Call the \ref IRtcEngine::setupLocalVideo "setupLocalVideo" method to set up the local preview window and configure the attributes. + - Call the \ref IRtcEngine::enableVideo "enableVideo" method to enable video. - @param enabled Sets whether to disable/re-enable the local audio function: - - true: (Default) Re-enable the local audio function, that is, to start the local audio capturing device (for example, the microphone). - - false: Disable the local audio function, that is, to stop local audio capturing. + @note Once the startPreview method is called to start the local video preview, if you leave the channel by calling the \ref IRtcEngine::leaveChannel "leaveChannel" method, the local video preview remains until you call the \ref IRtcEngine::stopPreview "stopPreview" method to disable it. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int enableLocalAudio(bool enabled) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int startPreview() = 0; - /** Disables the audio module. + /** Prioritizes a remote user's stream. + * + * The SDK ensures the high-priority user gets the best possible stream quality. + * + * @note + * - The Agora SDK supports setting @p userPriority as high for one user only. + * - Ensure that you call this method before joining a channel. + * + * @param uid The ID of the remote user. + * @param userPriority Sets the priority of the remote user. See #PRIORITY_TYPE. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setRemoteUserPriority(uid_t uid, PRIORITY_TYPE userPriority) = 0; - @note - - This method affects the internal engine and can be called after the \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method. You can call this method either before or after joining a channel. - - This method resets the internal engine and takes some time to take effect. We recommend using the \ref agora::rtc::IRtcEngine::enableLocalAudio "enableLocalAudio" and \ref agora::rtc::IRtcEngine::muteLocalAudioStream "muteLocalAudioStream" methods to capture, process, and send the local audio streams. + /** Stops the local video preview and disables video. + * + * @note + * - Call this method before joining a channel. + * - Call this method after calling \ref IRtcEngine::startPreview "startPreview". + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int stopPreview() = 0; - @return - - 0: Success. - - < 0: Failure. - */ - virtual int disableAudio() = 0; + /** Enables the audio module. - /** Sets the audio parameters and application scenarios. + The audio mode is enabled by default. - @note - - The `setAudioProfile` method must be called before the \ref IRtcEngine::joinChannel "joinChannel" method. - - In the `COMMUNICATION` and `LIVE_BROADCASTING` profiles, the bitrate may be different from your settings due to network self-adaptation. - - In scenarios requiring high-quality audio, for example, a music teaching scenario, we recommend setting profile as AUDIO_PROFILE_MUSIC_HIGH_QUALITY (4) and scenario as AUDIO_SCENARIO_GAME_STREAMING (3). + @note + - This method affects the audio module and can be called after the \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method. You can call this method either before or after joining a channel. + - This method enables the audio module and takes some time to take effect. Agora recommends using the following API methods to control the audio module separately: + - \ref IRtcEngine::enableLocalAudio "enableLocalAudio": Whether to enable the microphone to create the local audio stream. + - \ref IRtcEngine::muteLocalAudioStream "muteLocalAudioStream": Whether to publish the local audio stream. + - \ref IRtcEngine::muteRemoteAudioStream "muteRemoteAudioStream": Whether to subscribe to and play the remote audio stream. + - \ref IRtcEngine::muteAllRemoteAudioStreams "muteAllRemoteAudioStreams": Whether to subscribe to and play all remote audio streams. - @param profile Sets the sample rate, bitrate, encoding mode, and the number of channels. See #AUDIO_PROFILE_TYPE. - @param scenario Sets the audio application scenario. See #AUDIO_SCENARIO_TYPE. - Under different audio scenarios, the device uses different volume types. For details, see - [What is the difference between the in-call volume and the media volume?](https://docs.agora.io/en/faq/system_volume). + @return + - 0: Success. + - < 0: Failure. + */ + virtual int enableAudio() = 0; - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario) = 0; - /** Stops/Resumes sending the local audio stream. + /** Disables/Re-enables the local audio function. - A successful \ref agora::rtc::IRtcEngine::muteLocalAudioStream "muteLocalAudioStream" method call triggers the \ref agora::rtc::IRtcEngineEventHandler::onUserMuteAudio "onUserMuteAudio" callback on the remote client. + The audio function is enabled by default. This method disables or re-enables the local audio function, that is, to stop or restart local audio capturing. - @note - - When @p mute is set as @p true, this method does not disable the microphone, which does not affect any ongoing recording. - - You can call this method either before or after joining a channel. If you call \ref agora::rtc::IRtcEngine::setChannelProfile "setChannelProfile" after this method, the SDK resets whether or not to mute the local audio according to the channel profile and user role. Therefore, we recommend calling this method after the `setChannelProfile` method. + This method does not affect receiving or playing the remote audio streams,and enableLocalAudio(false) is applicable to scenarios where the user wants to + receive remote audio streams without sending any audio stream to other users in the channel. - @param mute Sets whether to send/stop sending the local audio stream: - - true: Stops sending the local audio stream. - - false: (Default) Sends the local audio stream. + Once the local audio function is disabled or re-enabled, the SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onLocalAudioStateChanged "onLocalAudioStateChanged" callback, + which reports `LOCAL_AUDIO_STREAM_STATE_STOPPED(0)` or `LOCAL_AUDIO_STREAM_STATE_RECORDING(1)`. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int muteLocalAudioStream(bool mute) = 0; - /** Stops/Resumes receiving all remote users' audio streams. + @note + - This method is different from the \ref agora::rtc::IRtcEngine::muteLocalAudioStream "muteLocalAudioStream" method: + - \ref agora::rtc::IRtcEngine::enableLocalAudio "enableLocalAudio": Disables/Re-enables the local audio capturing and processing. + If you disable or re-enable local audio capturing using the `enableLocalAudio` method, the local user may hear a pause in the remote audio playback. + - \ref agora::rtc::IRtcEngine::muteLocalAudioStream "muteLocalAudioStream": Sends/Stops sending the local audio streams. + - You can call this method either before or after joining a channel. - @note You can call this method either before or after joining a channel. + @param enabled Sets whether to disable/re-enable the local audio function: + - true: (Default) Re-enable the local audio function, that is, to start the local audio capturing device (for example, the microphone). + - false: Disable the local audio function, that is, to stop local audio capturing. - @param mute Sets whether to receive/stop receiving all remote users' audio streams. - - true: Stops receiving all remote users' audio streams. - - false: (Default) Receives all remote users' audio streams. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int enableLocalAudio(bool enabled) = 0; - @return - - 0: Success. - - < 0: Failure. - */ - virtual int muteAllRemoteAudioStreams(bool mute) = 0; - /** Stops/Resumes receiving all remote users' audio streams by default. + /** Disables the audio module. - You can call this method either before or after joining a channel. If you call `setDefaultMuteAllRemoteAudioStreams (true)` after joining a channel, the remote audio streams of all subsequent users are not received. + @note + - This method affects the internal engine and can be called after the \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method. You can call this method either before or after joining a channel. + - This method resets the internal engine and takes some time to take effect. We recommend using the \ref agora::rtc::IRtcEngine::enableLocalAudio "enableLocalAudio" and \ref agora::rtc::IRtcEngine::muteLocalAudioStream "muteLocalAudioStream" methods to capture, process, and send the local audio streams. - @note If you want to resume receiving the audio stream, call \ref agora::rtc::IRtcEngine::muteRemoteAudioStream "muteRemoteAudioStream (false)", - and specify the ID of the remote user whose audio stream you want to receive. - To receive the audio streams of multiple remote users, call `muteRemoteAudioStream (false)` as many times. - Calling `setDefaultMuteAllRemoteAudioStreams (false)` resumes receiving the audio streams of subsequent users only. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int disableAudio() = 0; - @param mute Sets whether to receive/stop receiving all remote users' audio streams by default: - - true: Stops receiving all remote users' audio streams by default. - - false: (Default) Receives all remote users' audio streams by default. + /** Sets the audio parameters and application scenarios. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setDefaultMuteAllRemoteAudioStreams(bool mute) = 0; + @note + - The `setAudioProfile` method must be called before the \ref IRtcEngine::joinChannel "joinChannel" method. + - In the `COMMUNICATION` and `LIVE_BROADCASTING` profiles, the bitrate may be different from your settings due to network self-adaptation. + - In scenarios requiring high-quality audio, for example, a music teaching scenario, we recommend setting profile as AUDIO_PROFILE_MUSIC_HIGH_QUALITY (4) and scenario as AUDIO_SCENARIO_GAME_STREAMING (3). - /** Adjusts the playback volume of a specified remote user. + @param profile Sets the sample rate, bitrate, encoding mode, and the number of channels. See #AUDIO_PROFILE_TYPE. + @param scenario Sets the audio application scenario. See #AUDIO_SCENARIO_TYPE. + Under different audio scenarios, the device uses different volume types. For details, see + [What is the difference between the in-call volume and the media volume?](https://docs.agora.io/en/faq/system_volume). - You can call this method as many times as necessary to adjust the playback volume of different remote users, or to repeatedly adjust the playback volume of the same remote user. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario) = 0; + /** + * Stops or resumes publishing the local audio stream. + * + * A successful \ref agora::rtc::IRtcEngine::muteLocalAudioStream "muteLocalAudioStream" method call + * triggers the \ref agora::rtc::IRtcEngineEventHandler::onUserMuteAudio "onUserMuteAudio" callback on the remote client. + * + * @note + * - When @p mute is set as @p true, this method does not affect any ongoing audio recording, because it does not disable the microphone. + * - You can call this method either before or after joining a channel. + * If you call \ref IRtcEngine::setChannelProfile "setChannelProfile" and + * \ref IRtcEngine::setClientRole "setClientRole" + * after this method, the SDK resets whether to stop publishing the local video according to the + * channel profile and user role. + * Therefore, Agora recommends calling this method after the `setChannelProfile` and `setClientRole` methods. + * + * @param mute Sets whether to stop publishing the local audio stream. + * - true: Stop publishing the local audio stream. + * - false: (Default) Resume publishing the local audio stream. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int muteLocalAudioStream(bool mute) = 0; + /** + * Stops or resumes subscribing to the audio streams of all remote users. + * + * As of v3.3.0, after successfully calling this method, the local user stops or resumes + * subscribing to the audio streams of all remote users, including all subsequent users. + * + * @note + * - Call this method after joining a channel. + * - See recommended settings in *Set the Subscribing State*. + * + * @param mute Sets whether to stop subscribing to the audio streams of all remote users. + * - true: Stop subscribing to the audio streams of all remote users. + * - false: (Default) Resume subscribing to the audio streams of all remote users. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int muteAllRemoteAudioStreams(bool mute) = 0; + /** Stops or resumes subscribing to the audio streams of all remote users by default. + * + * @deprecated This method is deprecated from v3.3.0. + * + * + * Call this method after joining a channel. After successfully calling this method, the + * local user stops or resumes subscribing to the audio streams of all subsequent users. + * + * @note If you need to resume subscribing to the audio streams of remote users in the + * channel after calling \ref IRtcEngine::setDefaultMuteAllRemoteAudioStreams "setDefaultMuteAllRemoteAudioStreams" (true), do the following: + * - If you need to resume subscribing to the audio stream of a specified user, call \ref IRtcEngine::muteRemoteAudioStream "muteRemoteAudioStream" (false), and specify the user ID. + * - If you need to resume subscribing to the audio streams of multiple remote users, call \ref IRtcEngine::muteRemoteAudioStream "muteRemoteAudioStream" (false) multiple times. + * + * @param mute Sets whether to stop subscribing to the audio streams of all remote users by default. + * - true: Stop subscribing to the audio streams of all remote users by default. + * - false: (Default) Resume subscribing to the audio streams of all remote users by default. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setDefaultMuteAllRemoteAudioStreams(bool mute) = 0; - @note - - Call this method after joining a channel. - - The playback volume here refers to the mixed volume of a specified remote user. - - This method can only adjust the playback volume of one specified remote user at a time. To adjust the playback volume of different remote users, call the method as many times, once for each remote user. + /** Adjusts the playback signal volume of a specified remote user. - @param uid The ID of the remote user. - @param volume The playback volume of the specified remote user. The value ranges from 0 to 100: - - 0: Mute. - - 100: Original volume. + You can call this method as many times as necessary to adjust the playback volume of different remote users, or to repeatedly adjust the playback volume of the same remote user. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int adjustUserPlaybackSignalVolume(unsigned int uid, int volume) = 0; - /** Stops/Resumes receiving a specified remote user's audio stream. + @note + - Call this method after joining a channel. + - The playback volume here refers to the mixed volume of a specified remote user. + - This method can only adjust the playback volume of one specified remote user at a time. To adjust the playback volume of different remote users, call the method as many times, once for each remote user. - @note - - You can call this method either before or after joining a channel. If you call it before joining a channel, - you need to maintain the `uid` of the remote user on your app level. - - If you called the \ref agora::rtc::IRtcEngine::muteAllRemoteAudioStreams "muteAllRemoteAudioStreams" method and set @p mute as @p true to stop receiving all remote users' audio streams, call the *muteAllRemoteAudioStreams* method and set @p mute as @p false before calling this method. The *muteAllRemoteAudioStreams* method sets all remote audio streams, while the *muteRemoteAudioStream* method sets a specified remote audio stream. + @param uid The ID of the remote user. + @param volume The playback volume of the specified remote user. The value ranges from 0 to 100: + - 0: Mute. + - 100: Original volume. - @param userId User ID of the specified remote user sending the audio. - @param mute Sets whether to receive/stop receiving a specified remote user's audio stream: - - true: Stops receiving the specified remote user's audio stream. - - false: (Default) Receives the specified remote user's audio stream. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int adjustUserPlaybackSignalVolume(unsigned int uid, int volume) = 0; + /** + * Stops or resumes subscribing to the audio stream of a specified user. + * + * @note + * - Call this method after joining a channel. + * - See recommended settings in *Set the Subscribing State*. + * + * @param userId The user ID of the specified remote user. + * @param mute Sets whether to stop subscribing to the audio stream of a specified user. + * - true: Stop subscribing to the audio stream of a specified user. + * - false: (Default) Resume subscribing to the audio stream of a specified user. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int muteRemoteAudioStream(uid_t userId, bool mute) = 0; + /** Stops or resumes publishing the local video stream. + * + * A successful \ref agora::rtc::IRtcEngine::muteLocalVideoStream "muteLocalVideoStream" method call + * triggers the \ref agora::rtc::IRtcEngineEventHandler::onUserMuteVideo "onUserMuteVideo" callback on + * the remote client. + * + * @note + * - This method executes faster than the \ref IRtcEngine::enableLocalVideo "enableLocalVideo" method, + * which controls the sending of the local video stream. + * - When `mute` is set as `true`, this method does not affect any ongoing video recording, because it does not disable the camera. + * - You can call this method either before or after joining a channel. + * If you call \ref IRtcEngine::setChannelProfile "setChannelProfile" and \ref IRtcEngine::setClientRole "setClientRole" + * after this method, the SDK resets whether to stop publishing the local video according to the + * channel profile and user role. + * Therefore, Agora recommends calling this method after the `setChannelProfile` and `setClientRole` methods. + * + * @param mute Sets whether to stop publishing the local video stream. + * - true: Stop publishing the local video stream. + * - false: (Default) Resume publishing the local video stream. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int muteLocalVideoStream(bool mute) = 0; + /** Enables/Disables the local video capture. - @return - - 0: Success. - - < 0: Failure. + This method disables or re-enables the local video capturer, and does not affect receiving the remote video stream. - */ - virtual int muteRemoteAudioStream(uid_t userId, bool mute) = 0; - /** Stops/Resumes sending the local video stream. + After you call the \ref agora::rtc::IRtcEngine::enableVideo "enableVideo" method, the local video capturer is enabled by default. You can call \ref agora::rtc::IRtcEngine::enableLocalVideo "enableLocalVideo(false)" to disable the local video capturer. If you want to re-enable it, call \ref agora::rtc::IRtcEngine::enableLocalVideo "enableLocalVideo(true)". - A successful \ref agora::rtc::IRtcEngine::muteLocalVideoStream "muteLocalVideoStream" method call triggers the \ref agora::rtc::IRtcEngineEventHandler::onUserMuteVideo "onUserMuteVideo" callback on the remote client. + After the local video capturer is successfully disabled or re-enabled, the SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onUserEnableLocalVideo "onUserEnableLocalVideo" callback on the remote client. - @note - - When set to *true*, this method does not disable the camera which does not affect the retrieval of the local video streams. This method executes faster than the \ref agora::rtc::IRtcEngine::enableLocalVideo "enableLocalVideo" method which controls the sending of the local video stream. - - You can call this method either before or after joining a channel. If you call \ref agora::rtc::IRtcEngine::setChannelProfile "setChannelProfile" after this method, the SDK resets whether or not to mute the local video according to the channel profile and user role. Therefore, we recommend calling this method after the `setChannelProfile` method. + @note + - You can call this method either before or after joining a channel. + - This method affects the internal engine and can be called after the \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method. - @param mute Sets whether to send/stop sending the local video stream: - - true: Stop sending the local video stream. - - false: (Default) Send the local video stream. + @param enabled Sets whether to disable/re-enable the local video, including the capturer, renderer, and sender: + - true: (Default) Re-enable the local video. + - false: Disable the local video. Once the local video is disabled, the remote users can no longer receive the video stream of this user, while this user can still receive the video streams of the other remote users. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int muteLocalVideoStream(bool mute) = 0; - /** Enables/Disables the local video capture. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int enableLocalVideo(bool enabled) = 0; + /** + * Stops or resumes subscribing to the video streams of all remote users. + * + * As of v3.3.0, after successfully calling this method, the local user stops or resumes + * subscribing to the video streams of all remote users, including all subsequent users. + * + * @note + * - Call this method after joining a channel. + * - See recommended settings in *Set the Subscribing State*. + * + * @param mute Sets whether to stop subscribing to the video streams of all remote users. + * - true: Stop subscribing to the video streams of all remote users. + * - false: (Default) Resume subscribing to the video streams of all remote users. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int muteAllRemoteVideoStreams(bool mute) = 0; + /** Stops or resumes subscribing to the video streams of all remote users by default. + * + * @deprecated This method is deprecated from v3.3.0. + * + * Call this method after joining a channel. After successfully calling this method, the + * local user stops or resumes subscribing to the video streams of all subsequent users. + * + * @note If you need to resume subscribing to the video streams of remote users in the + * channel after calling \ref IRtcEngine::setDefaultMuteAllRemoteVideoStreams "setDefaultMuteAllRemoteVideoStreams" (true), do the following: + * - If you need to resume subscribing to the video stream of a specified user, call \ref IRtcEngine::muteRemoteVideoStream "muteRemoteVideoStream" (false), and specify the user ID. + * - If you need to resume subscribing to the video streams of multiple remote users, call \ref IRtcEngine::muteRemoteVideoStream "muteRemoteVideoStream" (false) multiple times. + * + * @param mute Sets whether to stop subscribing to the video streams of all remote users by default. + * - true: Stop subscribing to the video streams of all remote users by default. + * - false: (Default) Resume subscribing to the video streams of all remote users by default. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setDefaultMuteAllRemoteVideoStreams(bool mute) = 0; + /** + * Stops or resumes subscribing to the video stream of a specified user. + * + * @note + * - Call this method after joining a channel. + * - See recommended settings in *Set the Subscribing State*. + * + * @param userId The user ID of the specified remote user. + * @param mute Sets whether to stop subscribing to the video stream of a specified user. + * - true: Stop subscribing to the video stream of a specified user. + * - false: (Default) Resume subscribing to the video stream of a specified user. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int muteRemoteVideoStream(uid_t userId, bool mute) = 0; + /** Sets the stream type of the remote video. - This method disables or re-enables the local video capturer, and does not affect receiving the remote video stream. + Under limited network conditions, if the publisher has not disabled the dual-stream mode using `enableDualStreamMode(false)`, + the receiver can choose to receive either the high-quality video stream (the high resolution, and high bitrate video stream) or + the low-video stream (the low resolution, and low bitrate video stream). - After you call the \ref agora::rtc::IRtcEngine::enableVideo "enableVideo" method, the local video capturer is enabled by default. You can call \ref agora::rtc::IRtcEngine::enableLocalVideo "enableLocalVideo(false)" to disable the local video capturer. If you want to re-enable it, call \ref agora::rtc::IRtcEngine::enableLocalVideo "enableLocalVideo(true)". + By default, users receive the high-quality video stream. Call this method if you want to switch to the low-video stream. + This method allows the app to adjust the corresponding video stream type based on the size of the video window to + reduce the bandwidth and resources. - After the local video capturer is successfully disabled or re-enabled, the SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onUserEnableLocalVideo "onUserEnableLocalVideo" callback on the remote client. + The aspect ratio of the low-video stream is the same as the high-quality video stream. Once the resolution of the high-quality video + stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-video stream. - @note - - You can call this method either before or after joining a channel. - - This method affects the internal engine and can be called after the \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method. + The method result returns in the \ref agora::rtc::IRtcEngineEventHandler::onApiCallExecuted "onApiCallExecuted" callback. - @param enabled Sets whether to disable/re-enable the local video, including the capturer, renderer, and sender: - - true: (Default) Re-enable the local video. - - false: Disable the local video. Once the local video is disabled, the remote users can no longer receive the video stream of this user, while this user can still receive the video streams of the other remote users. + @note You can call this method either before or after joining a channel. If you call both + \ref IRtcEngine::setRemoteVideoStreamType "setRemoteVideoStreamType" and + \ref IRtcEngine::setRemoteDefaultVideoStreamType "setRemoteDefaultVideoStreamType", the SDK applies the settings in + the \ref IRtcEngine::setRemoteVideoStreamType "setRemoteVideoStreamType" method. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int enableLocalVideo(bool enabled) = 0; - /** Stops/Resumes receiving all video stream from a specified remote user. + @param userId ID of the remote user sending the video stream. + @param streamType Sets the video-stream type. See #REMOTE_VIDEO_STREAM_TYPE. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setRemoteVideoStreamType(uid_t userId, REMOTE_VIDEO_STREAM_TYPE streamType) = 0; + /** Sets the default stream type of remote videos. - @note You can call this method either before or after joining a channel. + Under limited network conditions, if the publisher has not disabled the dual-stream mode using `enableDualStreamMode(false)`, + the receiver can choose to receive either the high-quality video stream (the high resolution, and high bitrate video stream) or + the low-video stream (the low resolution, and low bitrate video stream). - @param mute Sets whether to receive/stop receiving all remote users' video streams: - - true: Stop receiving all remote users' video streams. - - false: (Default) Receive all remote users' video streams. + By default, users receive the high-quality video stream. Call this method if you want to switch to the low-video stream. + This method allows the app to adjust the corresponding video stream type based on the size of the video window to + reduce the bandwidth and resources. The aspect ratio of the low-video stream is the same as the high-quality video stream. + Once the resolution of the high-quality video + stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-video stream. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int muteAllRemoteVideoStreams(bool mute) = 0; - /** Stops/Resumes receiving all remote users' video streams by default. + The method result returns in the \ref agora::rtc::IRtcEngineEventHandler::onApiCallExecuted "onApiCallExecuted" callback. + + @note You can call this method either before or after joining a channel. If you call both + \ref IRtcEngine::setRemoteVideoStreamType "setRemoteVideoStreamType" and + \ref IRtcEngine::setRemoteDefaultVideoStreamType "setRemoteDefaultVideoStreamType", the SDK applies the settings in + the \ref IRtcEngine::setRemoteVideoStreamType "setRemoteVideoStreamType" method. - You can call this method either before or after joining a channel. If you call `setDefaultMuteAllRemoteVideoStreams (true)` after joining a channel, the remote video streams of all subsequent users are not received. + @param streamType Sets the default video-stream type. See #REMOTE_VIDEO_STREAM_TYPE. - @note If you want to resume receiving the video stream, call \ref agora::rtc::IRtcEngine::muteRemoteVideoStream "muteRemoteVideoStream (false)", and specify the ID of the remote user whose video stream you want to receive. To receive the video streams of multiple remote users, call `muteRemoteVideoStream (false)` as many times. Calling `setDefaultMuteAllRemoteVideoStreams (false)` resumes receiving the video streams of subsequent users only. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setRemoteDefaultVideoStreamType(REMOTE_VIDEO_STREAM_TYPE streamType) = 0; - @param mute Sets whether to receive/stop receiving all remote users' video streams by default: - - true: Stop receiving all remote users' video streams by default. - - false: (Default) Receive all remote users' video streams by default. + /** Enables the reporting of users' volume indication. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setDefaultMuteAllRemoteVideoStreams(bool mute) = 0; - /** Stops/Resumes receiving the video stream from a specified remote user. - - @note - - You can call this method either before or after joining a channel. If you call it before joining a channel, you - need to maintain the `uid` of the remote user on your app level. - - If you called the \ref agora::rtc::IRtcEngine::muteAllRemoteVideoStreams "muteAllRemoteVideoStreams" method and set @p mute as @p true to stop receiving all remote video streams, call the *muteAllRemoteVideoStreams* method and set @p mute as @p false before calling this method. - - @param userId User ID of the specified remote user. - @param mute Sets whether to stop/resume receiving the video stream from a specified remote user: - - true: Stop receiving the specified remote user's video stream. - - false: (Default) Receive the specified remote user's video stream. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int muteRemoteVideoStream(uid_t userId, bool mute) = 0; - /** Sets the stream type of the remote video. + This method enables the SDK to regularly report the volume information of the local user who sends a stream and + remote users (up to three) whose instantaneous volumes are the highest to the app. Once you call this method and + users send streams in the channel, the SDK triggers the + \ref IRtcEngineEventHandler::onAudioVolumeIndication "onAudioVolumeIndication" callback at the time interval set + in this method. - Under limited network conditions, if the publisher has not disabled the dual-stream mode using `enableDualStreamMode(false)`, - the receiver can choose to receive either the high-quality video stream (the high resolution, and high bitrate video stream) or - the low-video stream (the low resolution, and low bitrate video stream). + @note You can call this method either before or after joining a channel. - By default, users receive the high-quality video stream. Call this method if you want to switch to the low-video stream. - This method allows the app to adjust the corresponding video stream type based on the size of the video window to - reduce the bandwidth and resources. + @param interval Sets the time interval between two consecutive volume indications: + - ≤ 0: Disables the volume indication. + - > 0: Time interval (ms) between two consecutive volume indications. We recommend setting @p interval > 200 ms. Do not set @p interval < 10 ms, or the *onAudioVolumeIndication* callback will not be triggered. + @param smooth Smoothing factor sets the sensitivity of the audio volume indicator. The value ranges between 0 and 10. The greater the value, the more sensitive the indicator. The recommended value is 3. + @param report_vad + - true: Enable the voice activity detection of the local user. Once it is enabled, the `vad` parameter of the `onAudioVolumeIndication` callback reports the voice activity status of the local user. + - false: (Default) Disable the voice activity detection of the local user. Once it is disabled, the `vad` parameter of the `onAudioVolumeIndication` callback does not report the voice activity status of the local user, except for the scenario where the engine automatically detects the voice activity of the local user. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int enableAudioVolumeIndication(int interval, int smooth, bool report_vad) = 0; + /** Starts an audio recording. - The aspect ratio of the low-video stream is the same as the high-quality video stream. Once the resolution of the high-quality video - stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-video stream. + @deprecated Deprecated from v2.9.1. + Use \ref IRtcEngine::startAudioRecording(const AudioRecordingConfiguration&) "startAudioRecording" [3/3] instead. - The method result returns in the \ref agora::rtc::IRtcEngineEventHandler::onApiCallExecuted "onApiCallExecuted" callback. + The SDK allows recording during a call. Supported formats: - @note You can call this method either before or after joining a channel. If you call both - \ref IRtcEngine::setRemoteVideoStreamType "setRemoteVideoStreamType" and - \ref IRtcEngine::setRemoteDefaultVideoStreamType "setRemoteDefaultVideoStreamType", the SDK applies the settings in - the \ref IRtcEngine::setRemoteVideoStreamType "setRemoteVideoStreamType" method. + - .wav: Large file size with high fidelity. + - .aac: Small file size with low fidelity. - @param userId ID of the remote user sending the video stream. - @param streamType Sets the video-stream type. See #REMOTE_VIDEO_STREAM_TYPE. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setRemoteVideoStreamType(uid_t userId, REMOTE_VIDEO_STREAM_TYPE streamType) = 0; - /** Sets the default stream type of remote videos. + This method has a fixed sample rate of 32 kHz. + + Ensure that the directory to save the recording file exists and is writable. + This method is usually called after the \ref agora::rtc::IRtcEngine::joinChannel "joinChannel" method. + The recording automatically stops when the \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method is called. - Under limited network conditions, if the publisher has not disabled the dual-stream mode using `enableDualStreamMode(false)`, - the receiver can choose to receive either the high-quality video stream (the high resolution, and high bitrate video stream) or - the low-video stream (the low resolution, and low bitrate video stream). + @param filePath Pointer to the absolute file path of the recording file. The string of the file name is in UTF-8. + @param quality Sets the audio recording quality. See #AUDIO_RECORDING_QUALITY_TYPE. - By default, users receive the high-quality video stream. Call this method if you want to switch to the low-video stream. - This method allows the app to adjust the corresponding video stream type based on the size of the video window to - reduce the bandwidth and resources. The aspect ratio of the low-video stream is the same as the high-quality video stream. - Once the resolution of the high-quality video - stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-video stream. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int startAudioRecording(const char* filePath, AUDIO_RECORDING_QUALITY_TYPE quality) = 0; - The method result returns in the \ref agora::rtc::IRtcEngineEventHandler::onApiCallExecuted "onApiCallExecuted" callback. + /** Starts an audio recording on the client. + * + * @deprecated Deprecated from v3.4.0. Use + * \ref IRtcEngine::startAudioRecording(const AudioRecordingConfiguration&) "startAudioRecording" [3/3] instead. + * + * The SDK allows recording during a call. After successfully calling this method, you can record the audio of all the users in the channel and get an audio recording file. + * Supported formats of the recording file are as follows: + * - .wav: Large file size with high fidelity. + * - .aac: Small file size with low fidelity. + * + * @note + * - Ensure that the directory you use to save the recording file exists and is writable. + * - This method is usually called after the `joinChannel` method. The recording automatically stops when you call the `leaveChannel` method. + * - For better recording effects, set quality as #AUDIO_RECORDING_QUALITY_MEDIUM or #AUDIO_RECORDING_QUALITY_HIGH when `sampleRate` is 44.1 kHz or 48 kHz. + * + * @param filePath Pointer to the absolute file path of the recording file. The string of the file name is in UTF-8, such as c:/music/audio.aac. + * @param sampleRate Sample rate (Hz) of the recording file. Supported values are as follows: + * - 16000 + * - (Default) 32000 + * - 44100 + * - 48000 + * @param quality Sets the audio recording quality. See #AUDIO_RECORDING_QUALITY_TYPE. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int startAudioRecording(const char* filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality) = 0; + /** + * Starts an audio recording on the client. + * + * @since v3.4.0 + * + * The SDK allows recording audio during a call. After successfully calling + * this method, you can record the audio of users in the channel and get + * an audio recording file. Supported file formats are as follows: + * - WAV: High-fidelity files with typically larger file sizes. For example, + * if the sample rate is 32,000 Hz, the file size for a 10-minute recording + * is approximately 73 MB. + * - AAC: Low-fidelity files with typically smaller file sizes. For example, + * if the sample rate is 32,000 Hz and the recording quality is + * #AUDIO_RECORDING_QUALITY_MEDIUM, the file size for a 10-minute recording + * is approximately 2 MB. + * + * Once the user leaves the channel, the recording automatically stops. + * + * @note Call this method after joining a channel. + * + * @param config Recording configuration. See AudioRecordingConfiguration. + * + * @return + * - 0: Success. + * - < 0: Failure. + * - `-160(ERR_ALREADY_IN_RECORDING)`: The client is already recording + * audio. To start a new recording, + * call \ref IRtcEngine::stopAudioRecording "stopAudioRecording" to stop the + * current recording first, and then + * call \ref IRtcEngine::startAudioRecording(const AudioRecordingConfiguration&) "startAudioRecording". + */ + virtual int startAudioRecording(const AudioRecordingConfiguration& config) = 0; + /** Stops an audio recording on the client. - @note You can call this method either before or after joining a channel. If you call both - \ref IRtcEngine::setRemoteVideoStreamType "setRemoteVideoStreamType" and - \ref IRtcEngine::setRemoteDefaultVideoStreamType "setRemoteDefaultVideoStreamType", the SDK applies the settings in - the \ref IRtcEngine::setRemoteVideoStreamType "setRemoteVideoStreamType" method. + You can call this method before calling the \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method else, the recording automatically stops when the \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method is called. - @param streamType Sets the default video-stream type. See #REMOTE_VIDEO_STREAM_TYPE. + @return + - 0: Success + - < 0: Failure. + */ + virtual int stopAudioRecording() = 0; - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setRemoteDefaultVideoStreamType(REMOTE_VIDEO_STREAM_TYPE streamType) = 0; + /** Starts playing and mixing the music file. + * + * @deprecated Deprecated from v3.4.0. Use + * \ref IRtcEngine::startAudioMixing(const char*,bool,bool,int,int) "startAudioMixing" [2/2] instead. + * + * This method mixes the specified local audio file with the audio stream from the microphone, or replaces the microphone's audio stream with the specified local audio file. You can choose whether the other user can hear the local audio playback and specify the number of playback loops. This method also supports online music playback. + * + * When the audio mixing file playback finishes after calling this method, the SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onAudioMixingFinished "onAudioMixingFinished" callback. + * + * A successful \ref IRtcEngine::startAudioMixing(const char*,bool,bool,int,int) "startAudioMixing" method call triggers the \ref agora::rtc::IRtcEngineEventHandler::onAudioMixingStateChanged "onAudioMixingStateChanged" (PLAY) callback on the local client. + * + * When the audio mixing file playback finishes, the SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onAudioMixingStateChanged "onAudioMixingStateChanged" (STOPPED) callback on the local client. + * + * @note + * - If the local audio mixing file does not exist, or if the SDK does not support the file format or cannot access the music file URL, the SDK returns #WARN_AUDIO_MIXING_OPEN_ERROR (701). + * - If you want to play an online music file, ensure that the time interval between calling this method is more than 100 ms, or the #AUDIO_MIXING_ERROR_TOO_FREQUENT_CALL (702) error code occurs. + * + * @param filePath The absolute path or URL address (including the filename extensions) + * of the music file. For example: `C:\music\audio.mp4`. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. + * For more information, see + * [Supported Media Formats in Media Foundation](https://docs.microsoft.com/en-us/windows/desktop/medfound/supported-media-formats-in-media-foundation). + * When you access a local file on Android, Agora recommends passing a URI address or the path starts + * with `/assets/` in this parameter. + * @param loopback Sets which user can hear the audio mixing: + * - true: Only the local user can hear the audio mixing. + * - false: Both users can hear the audio mixing. + * @param replace Sets the audio mixing content: + * - true: Only publish the specified audio file. The audio stream from the microphone is not published. + * - false: The local audio file is mixed with the audio stream from the microphone. + * @param cycle Sets the number of playback loops: + * - Positive integer: Number of playback loops. + * - `-1`: Infinite playback loops. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int startAudioMixing(const char* filePath, bool loopback, bool replace, int cycle) = 0; + /** + * Starts playing and mixing the music file. + * + * @since v3.4.0 + * + * This method supports mixing or replacing local or online music file and + * audio collected by a microphone. After successfully playing the music + * file, the SDK triggers + * \ref IRtcEngineEventHandler::onAudioMixingStateChanged "onAudioMixingStateChanged" (AUDIO_MIXING_STATE_PLAYING,AUDIO_MIXING_REASON_STARTED_BY_USER). + * After completing playing the music file, the SDK triggers + * `onAudioMixingStateChanged(AUDIO_MIXING_STATE_STOPPED,AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED)`. + * + * @note + * - If you need to call + * \ref IRtcEngine::startAudioMixing(const char*,bool,bool,int,int) "startAudioMixing" multiple times, + * ensure that the call interval is longer than 500 ms. + * - If the local music file does not exist, or if the SDK does not support + * the file format or cannot access the music file URL, the SDK returns + * #WARN_AUDIO_MIXING_OPEN_ERROR (701). + * - On Android: + * - To use this method, ensure that the Android device is v4.2 or later + * and the API version is v16 or later. + * - If you need to play an online music file, Agora does not recommend + * using the redirected URL address. Some Android devices may fail to open a redirected URL address. + * - If you call this method on an emulator, ensure that the music file is + * in the `/sdcard/` directory and the format is MP3. + * + * @param filePath The absolute path or URL address (including the filename extensions) + * of the music file. For example: `C:\music\audio.mp4`. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. + * For more information, see + * [Supported Media Formats in Media Foundation](https://docs.microsoft.com/en-us/windows/desktop/medfound/supported-media-formats-in-media-foundation). + * When you access a local file on Android, Agora recommends passing a URI address or the path starts + * with `/assets/` in this parameter. + * @param loopback Whether to only play the music file on the local client: + * - true: Only play the music file on the local client so that only the local + * user can hear the music. + * - false: Publish the music file to remote clients so that both the local + * user and remote users can hear the music. + * @param replace Whether to replace the audio collected by the microphone + * with a music file: + * - true: Replace. Users can only hear music. + * - false: Do not replace. Users can hear both music and audio collected by + * the microphone. + * @param cycle The number of times the music file plays. + * - ≥ 0: The number of playback times. For example, `0` means that the + * SDK does not play the music file, while `1` means that the SDK plays the + * music file once. + * - `-1`: Play the music in an indefinite loop. + * @param startPos The playback position (ms) of the music file. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int startAudioMixing(const char* filePath, bool loopback, bool replace, int cycle, int startPos) = 0; + /** Stops playing and mixing the music file. - /** Enables the \ref agora::rtc::IRtcEngineEventHandler::onAudioVolumeIndication "onAudioVolumeIndication" callback at a set time interval to report on which users are speaking and the speakers' volume. + Call this method when you are in a channel. - Once this method is enabled, the SDK returns the volume indication in the \ref agora::rtc::IRtcEngineEventHandler::onAudioVolumeIndication "onAudioVolumeIndication" callback at the set time interval, whether or not any user is speaking in the channel. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int stopAudioMixing() = 0; + /** Pauses playing and mixing the music file. - @note You can call this method either before or after joining a channel. + Call this method when you are in a channel. - @param interval Sets the time interval between two consecutive volume indications: - - ≤ 0: Disables the volume indication. - - > 0: Time interval (ms) between two consecutive volume indications. We recommend setting @p interval > 200 ms. Do not set @p interval < 10 ms, or the *onAudioVolumeIndication* callback will not be triggered. - @param smooth Smoothing factor sets the sensitivity of the audio volume indicator. The value ranges between 0 and 10. The greater the value, the more sensitive the indicator. The recommended value is 3. - @param report_vad + @return + - 0: Success. + - < 0: Failure. + */ + virtual int pauseAudioMixing() = 0; + /** Resumes playing and mixing the music file. - - true: Enable the voice activity detection of the local user. Once it is enabled, the `vad` parameter of the `onAudioVolumeIndication` callback reports the voice activity status of the local user. - - false: (Default) Disable the voice activity detection of the local user. Once it is disabled, the `vad` parameter of the `onAudioVolumeIndication` callback does not report the voice activity status of the local user, except for the scenario where the engine automatically detects the voice activity of the local user. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int enableAudioVolumeIndication(int interval, int smooth, bool report_vad) = 0; - /** @deprecated Starts an audio recording. + Call this method when you are in a channel. - Use \ref IRtcEngine::startAudioRecording(const char* filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality) "startAudioRecording"2 instead. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int resumeAudioMixing() = 0; + /** **DEPRECATED** Agora does not recommend using this method. - The SDK allows recording during a call. Supported formats: + Sets the high-quality audio preferences. Call this method and set all parameters before joining a channel. - - .wav: Large file size with high fidelity. - - .aac: Small file size with low fidelity. + Do not call this method again after joining a channel. - This method has a fixed sample rate of 32 kHz. + @param fullband Sets whether to enable/disable full-band codec (48-kHz sample rate). Not compatible with SDK versions before v1.7.4: + - true: Enable full-band codec. + - false: Disable full-band codec. + @param stereo Sets whether to enable/disable stereo codec. Not compatible with SDK versions before v1.7.4: + - true: Enable stereo codec. + - false: Disable stereo codec. + @param fullBitrate Sets whether to enable/disable high-bitrate mode. Recommended in voice-only mode: + - true: Enable high-bitrate mode. + - false: Disable high-bitrate mode. - Ensure that the directory to save the recording file exists and is writable. - This method is usually called after the \ref agora::rtc::IRtcEngine::joinChannel "joinChannel" method. - The recording automatically stops when the \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method is called. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setHighQualityAudioParameters(bool fullband, bool stereo, bool fullBitrate) = 0; + /** Adjusts the volume during audio mixing. - @param filePath Pointer to the absolute file path of the recording file. The string of the file name is in UTF-8. - @param quality Sets the audio recording quality. See #AUDIO_RECORDING_QUALITY_TYPE. + @note + - Calling this method does not affect the volume of audio effect file playback invoked by the \ref IRtcEngine::playEffect(int,const char*,int,double,double,int,bool,int) "playEffect" method. + - Call this method after calling \ref IRtcEngine::startAudioMixing(const char*,bool,bool,int,int) "startAudioMixing" and receiving the \ref IRtcEngineEventHandler::onAudioMixingStateChanged "onAudioMixingStateChanged" (AUDIO_MIXING_STATE_PLAYING) callback. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int startAudioRecording(const char* filePath, AUDIO_RECORDING_QUALITY_TYPE quality) = 0; + @param volume Audio mixing volume. The value ranges between 0 and 100 (default). - /** Starts an audio recording on the client. - * - * The SDK allows recording during a call. After successfully calling this method, you can record the audio of all the users in the channel and get an audio recording file. - * Supported formats of the recording file are as follows: - * - .wav: Large file size with high fidelity. - * - .aac: Small file size with low fidelity. - * - * @note - * - Ensure that the directory you use to save the recording file exists and is writable. - * - This method is usually called after the `joinChannel` method. The recording automatically stops when you call the `leaveChannel` method. - * - For better recording effects, set quality as #AUDIO_RECORDING_QUALITY_MEDIUM or #AUDIO_RECORDING_QUALITY_HIGH when `sampleRate` is 44.1 kHz or 48 kHz. - * - * @param filePath Pointer to the absolute file path of the recording file. The string of the file name is in UTF-8, such as c:/music/audio.aac. - * @param sampleRate Sample rate (kHz) of the recording file. Supported values are as follows: - * - 16 - * - (Default) 32 - * - 44.1 - * - 48 - * @param quality Sets the audio recording quality. See #AUDIO_RECORDING_QUALITY_TYPE. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int startAudioRecording(const char* filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality) = 0; - /** Stops an audio recording on the client. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int adjustAudioMixingVolume(int volume) = 0; + /** Adjusts the audio mixing volume for local playback. - You can call this method before calling the \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method else, the recording automatically stops when the \ref agora::rtc::IRtcEngine::leaveChannel "leaveChannel" method is called. + @note Call this method after calling \ref IRtcEngine::startAudioMixing(const char*,bool,bool,int,int) "startAudioMixing" and receiving the \ref IRtcEngineEventHandler::onAudioMixingStateChanged "onAudioMixingStateChanged" (AUDIO_MIXING_STATE_PLAYING) callback. - @return - - 0: Success - - < 0: Failure. - */ - virtual int stopAudioRecording() = 0; - /** Starts playing and mixing the music file. - - This method mixes the specified local audio file with the audio stream from the microphone, or replaces the microphone's audio stream with the specified local audio file. You can choose whether the other user can hear the local audio playback and specify the number of playback loops. This method also supports online music playback. - - When the audio mixing file playback finishes after calling this method, the SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onAudioMixingFinished "onAudioMixingFinished" callback. - - A successful \ref agora::rtc::IRtcEngine::startAudioMixing "startAudioMixing" method call triggers the \ref agora::rtc::IRtcEngineEventHandler::onAudioMixingStateChanged "onAudioMixingStateChanged" (PLAY) callback on the local client. - - When the audio mixing file playback finishes, the SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onAudioMixingStateChanged "onAudioMixingStateChanged" (STOPPED) callback on the local client. - @note - - Call this method after joining a channel, otherwise issues may occur. - - If the local audio mixing file does not exist, or if the SDK does not support the file format or cannot access the music file URL, the SDK returns WARN_AUDIO_MIXING_OPEN_ERROR = 701. - - If you want to play an online music file, ensure that the time interval between calling this method is more than 100 ms, or the AUDIO_MIXING_ERROR_TOO_FREQUENT_CALL(702) error code occurs. - @param filePath Pointer to the absolute path (including the suffixes of the filename) of the local or online audio file to mix, for example, c:/music/audio.mp4. Supported audio formats: 3GP, ASF, ADTS, AVI, MP3, MP4, MPEG-4, SAMI, and WAVE. For more information, see [Supported Media Formats in Media Foundation](https://docs.microsoft.com/en-us/windows/desktop/medfound/supported-media-formats-in-media-foundation). - @param loopback Sets which user can hear the audio mixing: - - true: Only the local user can hear the audio mixing. - - false: Both users can hear the audio mixing. - @param replace Sets the audio mixing content: - - true: Only publish the specified audio file. The audio stream from the microphone is not published. - - false: The local audio file is mixed with the audio stream from the microphone. - @param cycle Sets the number of playback loops: - - Positive integer: Number of playback loops. - - `-1`: Infinite playback loops. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int startAudioMixing(const char* filePath, bool loopback, bool replace, int cycle) = 0; - /** Stops playing and mixing the music file. + @param volume Audio mixing volume for local playback. The value ranges between 0 and 100 (default). - Call this method when you are in a channel. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int adjustAudioMixingPlayoutVolume(int volume) = 0; + /** Gets the audio mixing volume for local playback. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int stopAudioMixing() = 0; - /** Pauses playing and mixing the music file. + This method helps troubleshoot audio volume related issues. - Call this method when you are in a channel. + @note + - Call this method when you are in a channel. + - Call this method after calling \ref IRtcEngine::startAudioMixing(const char*,bool,bool,int,int) "startAudioMixing" and receiving the \ref IRtcEngineEventHandler::onAudioMixingStateChanged "onAudioMixingStateChanged" (AUDIO_MIXING_STATE_PLAYING) callback. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int pauseAudioMixing() = 0; - /** Resumes playing and mixing the music file. + @return + - ≥ 0: The audio mixing volume, if this method call succeeds. The value range is [0,100]. + - < 0: Failure. + */ + virtual int getAudioMixingPlayoutVolume() = 0; + /** Adjusts the audio mixing volume for publishing (for remote users). - Call this method when you are in a channel. + @note Call this method after calling \ref IRtcEngine::startAudioMixing(const char*,bool,bool,int,int) "startAudioMixing" and receiving the \ref IRtcEngineEventHandler::onAudioMixingStateChanged "onAudioMixingStateChanged" (AUDIO_MIXING_STATE_PLAYING) callback. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int resumeAudioMixing() = 0; - /** **DEPRECATED** Agora does not recommend using this method. - - Sets the high-quality audio preferences. Call this method and set all parameters before joining a channel. - - Do not call this method again after joining a channel. - - @param fullband Sets whether to enable/disable full-band codec (48-kHz sample rate). Not compatible with SDK versions before v1.7.4: - - true: Enable full-band codec. - - false: Disable full-band codec. - @param stereo Sets whether to enable/disable stereo codec. Not compatible with SDK versions before v1.7.4: - - true: Enable stereo codec. - - false: Disable stereo codec. - @param fullBitrate Sets whether to enable/disable high-bitrate mode. Recommended in voice-only mode: - - true: Enable high-bitrate mode. - - false: Disable high-bitrate mode. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setHighQualityAudioParameters(bool fullband, bool stereo, bool fullBitrate) = 0; - /** Adjusts the volume during audio mixing. + @param volume Audio mixing volume for publishing. The value ranges between 0 and 100 (default). - @note - - Calling this method does not affect the volume of audio effect file playback invoked by the \ref agora::rtc::IRtcEngine::playEffect "playEffect" method. - - Ensure that this method is called after \ref IRtcEngine::startAudioMixing "startAudioMixing". + @return + - 0: Success. + - < 0: Failure. + */ + virtual int adjustAudioMixingPublishVolume(int volume) = 0; + /** Gets the audio mixing volume for publishing. - @param volume Audio mixing volume. The value ranges between 0 and 100 (default). + This method helps troubleshoot audio volume related issues. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int adjustAudioMixingVolume(int volume) = 0; - /** Adjusts the audio mixing volume for local playback. + @note + - Call this method when you are in a channel. + - Call this method after calling \ref IRtcEngine::startAudioMixing(const char*,bool,bool,int,int) "startAudioMixing" and receiving the \ref IRtcEngineEventHandler::onAudioMixingStateChanged "onAudioMixingStateChanged" (AUDIO_MIXING_STATE_PLAYING) callback. - @note Ensure that this method is called after \ref IRtcEngine::startAudioMixing "startAudioMixing". + @return + - ≥ 0: The audio mixing volume for publishing, if this method call succeeds. The value range is [0,100]. + - < 0: Failure. + */ + virtual int getAudioMixingPublishVolume() = 0; - @param volume Audio mixing volume for local playback. The value ranges between 0 and 100 (default). + /** Gets the duration (ms) of the music file. + * + * @deprecated Deprecated from v3.4.0. Use \ref IRtcEngine::getAudioMixingDuration(const char* filePath) "getAudioMixingDuration" [2/2] instead. + * + * @note + * - Call this method when you are in a channel. + * - Call this method after calling \ref IRtcEngine::startAudioMixing(const char*,bool,bool,int,int) "startAudioMixing" + * and receiving the \ref IRtcEngineEventHandler::onAudioMixingStateChanged "onAudioMixingStateChanged" (AUDIO_MIXING_STATE_PLAYING) callback. + * + * @return + * - ≥ 0: The audio mixing duration, if this method call succeeds. + * - < 0: Failure. + */ + virtual int getAudioMixingDuration() = 0; + /** + * Gets the total duration of the music file. + * + * @since v3.4.0 + * + * @note Call this method after joining a channel. + * + * @param filePath The absolute path or URL address (including the filename extensions) + * of the music file. For example: `C:\music\audio.mp4`. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. + * For more information, see + * [Supported Media Formats in Media Foundation](https://docs.microsoft.com/en-us/windows/desktop/medfound/supported-media-formats-in-media-foundation). + * When you access a local file on Android, Agora recommends passing a URI address or the path starts + * with `/assets/` in this parameter. + * + * @return + * - ≥ 0: A successful method call. Returns the total duration (ms) of the specified music file. + * - < 0: Failure. + */ + virtual int getAudioMixingDuration(const char* filePath) = 0; + /** Gets the playback position (ms) of the music file. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int adjustAudioMixingPlayoutVolume(int volume) = 0; - /** Retrieves the audio mixing volume for local playback. + @note + - Call this method when you are in a channel. + - Call this method after calling \ref IRtcEngine::startAudioMixing(const char*,bool,bool,int,int) "startAudioMixing" and receiving the \ref IRtcEngineEventHandler::onAudioMixingStateChanged "onAudioMixingStateChanged" (AUDIO_MIXING_STATE_PLAYING) callback. - This method helps troubleshoot audio volume related issues. + @return + - ≥ 0: The current playback position of the audio mixing, if this method call succeeds. + - < 0: Failure. + */ + virtual int getAudioMixingCurrentPosition() = 0; + /** Sets the playback position of the music file to a different starting position (the default plays from the beginning). - @note Call this method when you are in a channel. + @note Call this method after calling \ref IRtcEngine::startAudioMixing(const char*,bool,bool,int,int) "startAudioMixing" and receiving the \ref IRtcEngineEventHandler::onAudioMixingStateChanged "onAudioMixingStateChanged" (AUDIO_MIXING_STATE_PLAYING) callback. - @return - - ≥ 0: The audio mixing volume, if this method call succeeds. The value range is [0,100]. - - < 0: Failure. - */ - virtual int getAudioMixingPlayoutVolume() = 0; - /** Adjusts the audio mixing volume for publishing (for remote users). + @param pos The playback starting position (ms) of the music file. - @note Ensure that this method is called after \ref IRtcEngine::startAudioMixing "startAudioMixing". + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setAudioMixingPosition(int pos /*in ms*/) = 0; + /** Sets the pitch of the local music file. + * @since v3.0.1 + * + * When a local music file is mixed with a local human voice, call this method to set the pitch of the local music file only. + * + * @note Call this method after calling \ref IRtcEngine::startAudioMixing(const char*,bool,bool,int,int) "startAudioMixing" and receiving the \ref IRtcEngineEventHandler::onAudioMixingStateChanged "onAudioMixingStateChanged" (AUDIO_MIXING_STATE_PLAYING) callback. + * + * @param pitch Sets the pitch of the local music file by chromatic scale. The default value is 0, + * which means keeping the original pitch. The value ranges from -12 to 12, and the pitch value between + * consecutive values is a chromatic value. The greater the absolute value of this parameter, the + * higher or lower the pitch of the local music file. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setAudioMixingPitch(int pitch) = 0; + /** Gets the volume of the audio effects. - @param volume Audio mixing volume for publishing. The value ranges between 0 and 100 (default). + The value ranges between 0.0 and 100.0. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int adjustAudioMixingPublishVolume(int volume) = 0; - /** Retrieves the audio mixing volume for publishing. + @note Ensure that this method is called after \ref IRtcEngine::playEffect(int,const char*,int,double,double,int,bool,int) "playEffect" . - This method helps troubleshoot audio volume related issues. + @return + - ≥ 0: Volume of the audio effects, if this method call succeeds. - @note Call this method when you are in a channel. + - < 0: Failure. + */ + virtual int getEffectsVolume() = 0; + /** Sets the volume of the audio effects. - @return - - ≥ 0: The audio mixing volume for publishing, if this method call succeeds. The value range is [0,100]. - - < 0: Failure. - */ - virtual int getAudioMixingPublishVolume() = 0; + @note Ensure that this method is called after \ref IRtcEngine::playEffect(int,const char*,int,double,double,int,bool,int) "playEffect" . - /** Retrieves the duration (ms) of the music file. + @param volume Sets the volume of the audio effects. The value ranges between 0 and 100 (default). - Call this method when you are in a channel. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setEffectsVolume(int volume) = 0; + /** Sets the volume of a specified audio effect. - @return - - ≥ 0: The audio mixing duration, if this method call succeeds. - - < 0: Failure. - */ - virtual int getAudioMixingDuration() = 0; - /** Retrieves the playback position (ms) of the music file. + @note Ensure that this method is called after \ref IRtcEngine::playEffect(int,const char*,int,double,double,int,bool,int) "playEffect" . - Call this method when you are in a channel. + @param soundId ID of the audio effect. Each audio effect has a unique ID. + @param volume Sets the volume of the specified audio effect. The value ranges between 0 and 100 (default). - @return - - ≥ 0: The current playback position of the audio mixing, if this method call succeeds. - - < 0: Failure. - */ - virtual int getAudioMixingCurrentPosition() = 0; - /** Sets the playback position of the music file to a different starting position (the default plays from the beginning). + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setVolumeOfEffect(int soundId, int volume) = 0; - @note Ensure that this method is called after \ref IRtcEngine::startAudioMixing "startAudioMixing". +#if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) + /** + * Enables/Disables face detection for the local user. + * + * @since v3.0.1 + * + * @note + * - Applies to Android and iOS only. + * - You can call this method either before or after joining a channel. + * + * Once face detection is enabled, the SDK triggers the \ref IRtcEngineEventHandler::onFacePositionChanged "onFacePositionChanged" callback + * to report the face information of the local user, which includes the following aspects: + * - The width and height of the local video. + * - The position of the human face in the local video. + * - The distance between the human face and the device screen. + * + * @param enable Determines whether to enable the face detection function for the local user: + * - true: Enable face detection. + * - false: (Default) Disable face detection. + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int enableFaceDetection(bool enable) = 0; +#endif - @param pos The playback starting position (ms) of the music file. + /** Plays a specified local or online audio effect file. + * + * @deprecated Deprecated from v3.4.0. Use + * \ref IRtcEngine::playEffect(int,const char*,int,double,double,int,bool,int) "playEffect" [2/2] instead. + * + * This method allows you to set the loop count, pitch, pan, and gain of the audio effect file, as well as whether the remote user can hear the audio effect. + * + * To play multiple audio effect files simultaneously, call this method multiple times with different soundIds and filePaths. We recommend playing no more than three audio effect files at the same time. + * + * @note + * - If the audio effect is preloaded into the memory through the \ref IRtcEngine::preloadEffect "preloadEffect" method, the value of @p soundID must be the same as that in the *preloadEffect* method. + * - Playing multiple online audio effect files simultaneously is not supported on macOS and Windows. + * - Ensure that you call this method after joining a channel. + * + * @param soundId ID of the specified audio effect. Each audio effect has a unique ID. + * @param filePath The absolute path or URL address (including the filename extensions) + * of the music file. For example: `C:\music\audio.mp4`. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. + * For more information, see + * [Supported Media Formats in Media Foundation](https://docs.microsoft.com/en-us/windows/desktop/medfound/supported-media-formats-in-media-foundation). + * When you access a local file on Android, Agora recommends passing a URI address or the path starts + * with `/assets/` in this parameter. + * @param loopCount Sets the number of times the audio effect loops: + * - 0: Play the audio effect once. + * - 1: Play the audio effect twice. + * - -1: Play the audio effect in an indefinite loop until the \ref IRtcEngine::stopEffect "stopEffect" or \ref IRtcEngine::stopAllEffects "stopAllEffects" method is called. + * @param pitch Sets the pitch of the audio effect. The value ranges between 0.5 and 2. The default value is 1 (no change to the pitch). The lower the value, the lower the pitch. + * @param pan Sets the spatial position of the audio effect. The value ranges between -1.0 and 1.0: + * - 0.0: The audio effect displays ahead. + * - 1.0: The audio effect displays to the right. + * - -1.0: The audio effect displays to the left. + * @param gain Sets the volume of the audio effect. The value ranges between 0 and 100 (default). The lower the value, the lower the volume of the audio effect. + * @param publish Sets whether to publish the specified audio effect to the remote stream: + * - true: The locally played audio effect is published to the Agora Cloud and the remote users can hear it. + * - false: The locally played audio effect is not published to the Agora Cloud and the remote users cannot hear it. + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int playEffect(int soundId, const char* filePath, int loopCount, double pitch, double pan, int gain, bool publish = false) = 0; + /** + * Plays a specified local or online audio effect file. + * + * @since v3.4.0 + * + * To play multiple audio effect files at the same time, call this method + * multiple times with different `soundId` and `filePath` values. For the + * best user experience, Agora recommends playing no more than three audio + * effect files at the same time. + * + * After completing playing an audio effect file, the SDK triggers the + * \ref IRtcEngineEventHandler::onAudioEffectFinished "onAudioEffectFinished" + * callback. + * + * @note Call this method after joining a channel. + * + * @param soundId Audio effect ID. The ID of each audio effect file is + * unique. If you preloaded an audio effect into memory by calling + * \ref IRtcEngine::preloadEffect "preloadEffect", ensure that this + * parameter is set to the same value as in `preloadEffect`. + * @param filePath The absolute path or URL address (including the filename extensions) + * of the music file. For example: `C:\music\audio.mp4`. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. + * For more information, see + * [Supported Media Formats in Media Foundation](https://docs.microsoft.com/en-us/windows/desktop/medfound/supported-media-formats-in-media-foundation). + * If you preloaded an audio effect into memory by calling + * \ref IRtcEngine::preloadEffect "preloadEffect", ensure that this + * parameter is set to the same value as in `preloadEffect`. + * When you access a local file on Android, Agora recommends passing a URI address or the path starts + * with `/assets/` in this parameter. + * + * @param loopCount The number of times the audio effect loops: + * - ≥ 0: The number of loops. For example, `1` means loop one time, + * which means play the audio effect two times in total. + * - `-1`: Play the audio effect in an indefinite loop. + * @param pitch The pitch of the audio effect. The range is 0.5 to 2.0. + * The default value is 1.0, which means the original pitch. The lower the + * value, the lower the pitch. + * @param pan The spatial position of the audio effect. The range is `-1.0` + * to `1.0`. For example: + * - `-1.0`: The audio effect occurs on the left. + * - `0.0`: The audio effect occurs in the front. + * - `1.0`: The audio effect occurs on the right. + * @param gain The volume of the audio effect. The range is 0.0 to 100.0. + * The default value is 100.0, which means the original volume. The smaller + * the value, the less the gain. + * @param publish Whether to publish the audio effect to the remote users: + * - true: Publish. Both the local user and remote users can hear the audio + * effect. + * - false: Do not publish. Only the local user can hear the audio effect. + * @param startPos The playback position (ms) of the audio effect file. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int playEffect(int soundId, const char* filePath, int loopCount, double pitch, double pan, int gain, bool publish, int startPos) = 0; + /** Stops playing a specified audio effect. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setAudioMixingPosition(int pos /*in ms*/) = 0; - /** Sets the pitch of the local music file. - * @since v3.0.1 - * - * When a local music file is mixed with a local human voice, call this method to set the pitch of the local music file only. - * - * @note - * Call this method after calling `startAudioMixing`. - * - * @param pitch Sets the pitch of the local music file by chromatic scale. The default value is 0, - * which means keeping the original pitch. The value ranges from -12 to 12, and the pitch value between - * consecutive values is a chromatic value. The greater the absolute value of this parameter, the - * higher or lower the pitch of the local music file. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int setAudioMixingPitch(int pitch) = 0; - /** Retrieves the volume of the audio effects. + @param soundId ID of the audio effect to stop playing. Each audio effect has a unique ID. - The value ranges between 0.0 and 100.0. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int stopEffect(int soundId) = 0; + /** Stops playing all audio effects. - @note Ensure that this method is called after \ref IRtcEngine::playEffect "playEffect". + @return + - 0: Success. + - < 0: Failure. + */ + virtual int stopAllEffects() = 0; - @return - - ≥ 0: Volume of the audio effects, if this method call succeeds. + /** Preloads a specified audio effect file into the memory. + * + * @note This method does not support online audio effect files. + * + * To ensure smooth communication, limit the size of the audio effect file. We recommend using this method to preload the audio effect before calling the \ref IRtcEngine::joinChannel "joinChannel" method. + * + * Supported audio formats: mp3, aac, m4a, 3gp, and wav. + * + * @param soundId ID of the audio effect. Each audio effect has a unique ID. + * @param filePath The absolute path or URL address (including the filename extensions) + * of the music file. For example: `C:\music\audio.mp4`. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. + * For more information, see + * [Supported Media Formats in Media Foundation](https://docs.microsoft.com/en-us/windows/desktop/medfound/supported-media-formats-in-media-foundation). + * When you access a local file on Android, Agora recommends passing a URI address or the path starts + * with `/assets/` in this parameter. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int preloadEffect(int soundId, const char* filePath) = 0; + /** Releases a specified preloaded audio effect from the memory. - - < 0: Failure. - */ - virtual int getEffectsVolume() = 0; - /** Sets the volume of the audio effects. + @param soundId ID of the audio effect. Each audio effect has a unique ID. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int unloadEffect(int soundId) = 0; + /** Pauses a specified audio effect. - @note Ensure that this method is called after \ref IRtcEngine::playEffect "playEffect". + @param soundId ID of the audio effect. Each audio effect has a unique ID. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int pauseEffect(int soundId) = 0; + /** Pauses all audio effects. - @param volume Sets the volume of the audio effects. The value ranges between 0 and 100 (default). + @return + - 0: Success. + - < 0: Failure. + */ + virtual int pauseAllEffects() = 0; + /** Resumes playing a specified audio effect. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setEffectsVolume(int volume) = 0; - /** Sets the volume of a specified audio effect. + @param soundId ID of the audio effect. Each audio effect has a unique ID. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int resumeEffect(int soundId) = 0; + /** Resumes playing all audio effects. - @note Ensure that this method is called after \ref IRtcEngine::playEffect "playEffect". + @return + - 0: Success. + - < 0: Failure. + */ + virtual int resumeAllEffects() = 0; + /** + * Gets the duration of the audio effect file. + * + * @since v3.4.0 + * + * @note Call this method after joining a channel. + * + * @param filePath The absolute path or URL address (including the filename extensions) + * of the music file. For example: `C:\music\audio.mp4`. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. + * For more information, see + * [Supported Media Formats in Media Foundation](https://docs.microsoft.com/en-us/windows/desktop/medfound/supported-media-formats-in-media-foundation). + * When you access a local file on Android, Agora recommends passing a URI address or the path starts + * with `/assets/` in this parameter. + * + * @return + * - ≥ 0: A successful method call. Returns the total duration (ms) of + * the specified audio effect file. + * - < 0: Failure. + * - `-22(ERR_RESOURCE_LIMITED)`: Cannot find the audio effect file. Please + * set a correct `filePath`. + */ + virtual int getEffectDuration(const char* filePath) = 0; + /** + * Sets the playback position of an audio effect file. + * + * @since v3.4.0 + * + * After a successful setting, the local audio effect file starts playing at the specified position. + * + * @note Call this method after \ref IRtcEngine::playEffect(int,const char*,int,double,double,int,bool,int) "playEffect" . + * + * @param soundId Audio effect ID. Ensure that this parameter is set to the + * same value as in \ref IRtcEngine::playEffect(int,const char*,int,double,double,int,bool,int) "playEffect" . + * @param pos The playback position (ms) of the audio effect file. + * + * @return + * - 0: Success. + * - < 0: Failure. + * - `-22(ERR_RESOURCE_LIMITED)`: Cannot find the audio effect file. Please + * set a correct `soundId`. + */ + virtual int setEffectPosition(int soundId, int pos) = 0; + /** + * Gets the playback position of the audio effect file. + * + * @since v3.4.0 + * + * @note Call this method after \ref IRtcEngine::playEffect(int,const char*,int,double,double,int,bool,int) "playEffect" . + * + * @param soundId Audio effect ID. Ensure that this parameter is set to the + * same value as in \ref IRtcEngine::playEffect(int,const char*,int,double,double,int,bool,int) "playEffect" . + * + * @return + * - ≥ 0: A successful method call. Returns the playback position (ms) of + * the specified audio effect file. + * - < 0: Failure. + * - `-22(ERR_RESOURCE_LIMITED)`: Cannot find the audio effect file. Please + * set a correct `soundId`. + */ + virtual int getEffectCurrentPosition(int soundId) = 0; - @param soundId ID of the audio effect. Each audio effect has a unique ID. - @param volume Sets the volume of the specified audio effect. The value ranges between 0 and 100 (default). + /** Enables or disables deep-learning noise reduction. + * + * @since v3.3.0 + * + * The SDK enables traditional noise reduction mode by default to reduce most of the stationary background noise. + * If you need to reduce most of the non-stationary background noise, Agora recommends enabling deep-learning + * noise reduction as follows: + * + * 1. Integrate the dynamical library under the libs folder to your project: + * - Android: `libagora_ai_denoise_extension.so` + * - iOS: `AgoraAIDenoiseExtension.xcframework` + * - macOS: `AgoraAIDenoiseExtension.framework` + * - Windows: `libagora_ai_denoise_extension.dll` + * 2. Call `enableDeepLearningDenoise(true)`. + * + * Deep-learning noise reduction requires high-performance devices. For example, the following devices and later + * models are known to support deep-learning noise reduction: + * - iPhone 6S + * - MacBook Pro 2015 + * - iPad Pro (2nd generation) + * - iPad mini (5th generation) + * - iPad Air (3rd generation) + * + * After successfully enabling deep-learning noise reduction, if the SDK detects that the device performance + * is not sufficient, it automatically disables deep-learning noise reduction and enables traditional noise reduction. + * + * If you call `enableDeepLearningDenoise(false)` or the SDK automatically disables deep-learning noise reduction + * in the channel, when you need to re-enable deep-learning noise reduction, you need to call \ref IRtcEngine::leaveChannel "leaveChannel" + * first, and then call `enableDeepLearningDenoise(true)`. + * + * @note + * - This method dynamically loads the library, so Agora recommends calling this method before joining a channel. + * - This method works best with the human voice. Agora does not recommend using this method for audio containing music. + * + * @param enable Sets whether to enable deep-learning noise reduction. + * - true: (Default) Enables deep-learning noise reduction. + * - false: Disables deep-learning noise reduction. + * + * @return + * - 0: Success. + * - < 0: Failure. + * - -157 (ERR_MODULE_NOT_FOUND): The dynamical library for enabling deep-learning noise reduction is not integrated. + */ + virtual int enableDeepLearningDenoise(bool enable) = 0; + /** Enables/Disables stereo panning for remote users. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setVolumeOfEffect(int soundId, int volume) = 0; + Ensure that you call this method before joinChannel to enable stereo panning for remote users so that the local user can track the position of a remote user by calling \ref agora::rtc::IRtcEngine::setRemoteVoicePosition "setRemoteVoicePosition". -#if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) - /** - * Enables/Disables face detection for the local user. - * - * @since v3.0.1 - * - * @note - * - Applies to Android and iOS only. - * - You can call this method either before or after joining a channel. - * - * Once face detection is enabled, the SDK triggers the \ref IRtcEngineEventHandler::onFacePositionChanged "onFacePositionChanged" callback - * to report the face information of the local user, which includes the following aspects: - * - The width and height of the local video. - * - The position of the human face in the local video. - * - The distance between the human face and the device screen. - * - * @param enable Determines whether to enable the face detection function for the local user: - * - true: Enable face detection. - * - false: (Default) Disable face detection. - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int enableFaceDetection(bool enable) = 0; -#endif - /** Plays a specified local or online audio effect file. - - This method allows you to set the loop count, pitch, pan, and gain of the audio effect file, as well as whether the remote user can hear the audio effect. - - To play multiple audio effect files simultaneously, call this method multiple times with different soundIds and filePaths. We recommend playing no more than three audio effect files at the same time. - - @param soundId ID of the specified audio effect. Each audio effect has a unique ID. - - @note - - If the audio effect is preloaded into the memory through the \ref IRtcEngine::preloadEffect "preloadEffect" method, the value of @p soundID must be the same as that in the *preloadEffect* method. - - Playing multiple online audio effect files simultaneously is not supported on macOS and Windows. - - Ensure that you call this method after joining a channel. - - @param filePath Specifies the absolute path (including the suffixes of the filename) to the local audio effect file or the URL of the online audio effect file, for example, c:/music/audio.mp4. Supported audio formats: mp3, mp4, m4a, aac, 3gp, mkv and wav. - @param loopCount Sets the number of times the audio effect loops: - - 0: Play the audio effect once. - - 1: Play the audio effect twice. - - -1: Play the audio effect in an indefinite loop until the \ref IRtcEngine::stopEffect "stopEffect" or \ref IRtcEngine::stopAllEffects "stopAllEffects" method is called. - @param pitch Sets the pitch of the audio effect. The value ranges between 0.5 and 2. The default value is 1 (no change to the pitch). The lower the value, the lower the pitch. - @param pan Sets the spatial position of the audio effect. The value ranges between -1.0 and 1.0: - - 0.0: The audio effect displays ahead. - - 1.0: The audio effect displays to the right. - - -1.0: The audio effect displays to the left. - @param gain Sets the volume of the audio effect. The value ranges between 0 and 100 (default). The lower the value, the lower the volume of the audio effect. - @param publish Sets whether or not to publish the specified audio effect to the remote stream: - - true: The locally played audio effect is published to the Agora Cloud and the remote users can hear it. - - false: The locally played audio effect is not published to the Agora Cloud and the remote users cannot hear it. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int playEffect(int soundId, const char* filePath, int loopCount, double pitch, double pan, int gain, bool publish = false) = 0; - /** Stops playing a specified audio effect. + @param enabled Sets whether to enable stereo panning for remote users: + - true: enables stereo panning. + - false: disables stereo panning. - @param soundId ID of the audio effect to stop playing. Each audio effect has a unique ID. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int enableSoundPositionIndication(bool enabled) = 0; + /** Sets the sound position and gain of a remote user. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int stopEffect(int soundId) = 0; - /** Stops playing all audio effects. + When the local user calls this method to set the sound position of a remote user, the sound difference between the left and right channels allows the local user to track the real-time position of the remote user, creating a real sense of space. This method applies to massively multiplayer online games, such as Battle Royale games. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int stopAllEffects() = 0; + @note + - For this method to work, enable stereo panning for remote users by calling the \ref agora::rtc::IRtcEngine::enableSoundPositionIndication "enableSoundPositionIndication" method before joining a channel. + - This method requires hardware support. For the best sound positioning, we recommend using a wired headset. + - Ensure that you call this method after joining a channel. - /** Preloads a specified audio effect file into the memory. + @param uid The ID of the remote user. + @param pan The sound position of the remote user. The value ranges from -1.0 to 1.0: + - 0.0: the remote sound comes from the front. + - -1.0: the remote sound comes from the left. + - 1.0: the remote sound comes from the right. + @param gain Gain of the remote user. The value ranges from 0.0 to 100.0. The default value is 100.0 (the original gain of the remote user). The smaller the value, the less the gain. - @note This method does not support online audio effect files. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setRemoteVoicePosition(uid_t uid, double pan, double gain) = 0; - To ensure smooth communication, limit the size of the audio effect file. We recommend using this method to preload the audio effect before calling the \ref IRtcEngine::joinChannel "joinChannel" method. + /** Changes the voice pitch of the local speaker. - Supported audio formats: mp3, aac, m4a, 3gp, and wav. + @note You can call this method either before or after joining a channel. - @param soundId ID of the audio effect. Each audio effect has a unique ID. - @param filePath Pointer to the absolute path of the audio effect file. + @param pitch Sets the voice pitch. The value ranges between 0.5 and 2.0. The lower the value, the lower the voice pitch. The default value is 1.0 (no change to the local voice pitch). + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setLocalVoicePitch(double pitch) = 0; + /** Sets the local voice equalization effect. + @note You can call this method either before or after joining a channel. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int preloadEffect(int soundId, const char* filePath) = 0; - /** Releases a specified preloaded audio effect from the memory. + @param bandFrequency Sets the band frequency. The value ranges between 0 and 9, representing the respective 10-band center frequencies of the voice effects, including 31, 62, 125, 250, 500, 1k, 2k, 4k, 8k, and 16k Hz. See #AUDIO_EQUALIZATION_BAND_FREQUENCY. - @param soundId ID of the audio effect. Each audio effect has a unique ID. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int unloadEffect(int soundId) = 0; - /** Pauses a specified audio effect. + @param bandGain Sets the gain of each band in dB. The value ranges between -15 and 15. - @param soundId ID of the audio effect. Each audio effect has a unique ID. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int pauseEffect(int soundId) = 0; - /** Pauses all audio effects. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setLocalVoiceEqualization(AUDIO_EQUALIZATION_BAND_FREQUENCY bandFrequency, int bandGain) = 0; + /** Sets the local voice reverberation. + * + * As of v3.2.0, the SDK provides a more convenient method + * \ref IRtcEngine::setAudioEffectPreset "setAudioEffectPreset", which + * directly implements the popular music, R&B music, KTV and other preset + * reverb effects. + * + * @note You can call this method either before or after joining a channel. + * + * @param reverbKey Sets the reverberation key. See #AUDIO_REVERB_TYPE. + * @param value Sets the value of the reverberation key. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setLocalVoiceReverb(AUDIO_REVERB_TYPE reverbKey, int value) = 0; + /** Sets the local voice changer option. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int pauseAllEffects() = 0; - /** Resumes playing a specified audio effect. + @deprecated Deprecated from v3.2.0. Use the following methods instead: + - \ref IRtcEngine::setAudioEffectPreset "setAudioEffectPreset": Audio effects. + - \ref IRtcEngine::setVoiceBeautifierPreset "setVoiceBeautifierPreset": Voice beautifier effects. + - \ref IRtcEngine::setVoiceConversionPreset "setVoiceConversionPreset": Voice conversion effects. - @param soundId ID of the audio effect. Each audio effect has a unique ID. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int resumeEffect(int soundId) = 0; - /** Resumes playing all audio effects. + This method can be used to set the local voice effect for users in a `COMMUNICATION` channel or hosts in a `LIVE_BROADCASTING` channel. + Voice changer options include the following voice effects: - @return - - 0: Success. - - < 0: Failure. - */ - virtual int resumeAllEffects() = 0; - /** Enables/Disables stereo panning for remote users. + - `VOICE_CHANGER_XXX`: Changes the local voice to an old man, a little boy, or the Hulk. Applies to the voice talk scenario. + - `VOICE_BEAUTY_XXX`: Beautifies the local voice by making it sound more vigorous, resounding, or adding spacial resonance. Applies to the voice talk and singing scenario. + - `GENERAL_VOICE_BEAUTY_XXX`: Adds gender-based beautification effect to the local voice. Applies to the voice talk scenario. + - For a male voice: Adds magnetism to the voice. + - For a female voice: Adds freshness or vitality to the voice. - Ensure that you call this method before joinChannel to enable stereo panning for remote users so that the local user can track the position of a remote user by calling \ref agora::rtc::IRtcEngine::setRemoteVoicePosition "setRemoteVoicePosition". + @note + - To achieve better voice effect quality, Agora recommends setting the profile parameter in \ref IRtcEngine::setAudioProfile "setAudioProfile" as #AUDIO_PROFILE_MUSIC_HIGH_QUALITY (4) or #AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO (5) + - This method works best with the human voice, and Agora does not recommend using it for audio containing music and a human voice. + - Do not use this method with \ref IRtcEngine::setLocalVoiceReverbPreset "setLocalVoiceReverbPreset" , because the method called later overrides the one called earlier. For detailed considerations, see the advanced guide *Set the Voice Effect*. + - You can call this method either before or after joining a channel. - @param enabled Sets whether or not to enable stereo panning for remote users: - - true: enables stereo panning. - - false: disables stereo panning. + @param voiceChanger Sets the local voice changer option. The default value is #VOICE_CHANGER_OFF, + which means the original voice. See details in #VOICE_CHANGER_PRESET. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int enableSoundPositionIndication(bool enabled) = 0; - /** Sets the sound position and gain of a remote user. - - When the local user calls this method to set the sound position of a remote user, the sound difference between the left and right channels allows the local user to track the real-time position of the remote user, creating a real sense of space. This method applies to massively multiplayer online games, such as Battle Royale games. - - @note - - For this method to work, enable stereo panning for remote users by calling the \ref agora::rtc::IRtcEngine::enableSoundPositionIndication "enableSoundPositionIndication" method before joining a channel. - - This method requires hardware support. For the best sound positioning, we recommend using a stereo speaker. - - Ensure that you call this method after joining a channel. - - @param uid The ID of the remote user. - @param pan The sound position of the remote user. The value ranges from -1.0 to 1.0: - - 0.0: the remote sound comes from the front. - - -1.0: the remote sound comes from the left. - - 1.0: the remote sound comes from the right. - @param gain Gain of the remote user. The value ranges from 0.0 to 100.0. The default value is 100.0 (the original gain of the remote user). The smaller the value, the less the gain. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setRemoteVoicePosition(uid_t uid, double pan, double gain) = 0; + @return + - 0: Success. + - < 0: Failure. Check if the enumeration is properly set. + */ + virtual int setLocalVoiceChanger(VOICE_CHANGER_PRESET voiceChanger) = 0; + /** Sets the local voice reverberation option, including the virtual stereo. + * + * @deprecated Deprecated from v3.2.0. Use \ref IRtcEngine::setAudioEffectPreset "setAudioEffectPreset" or + * \ref IRtcEngine::setVoiceBeautifierPreset "setVoiceBeautifierPreset" instead. + * + * This method sets the local voice reverberation for users in a `COMMUNICATION` channel or hosts in a `LIVE_BROADCASTING` channel. + * After successfully calling this method, all users in the channel can hear the voice with reverberation. + * + * @note + * - When calling this method with enumerations that begin with `AUDIO_REVERB_FX`, ensure that you set profile in `setAudioProfile` as + * `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`; otherwise, this methods cannot set the corresponding voice reverberation option. + * - When calling this method with `AUDIO_VIRTUAL_STEREO`, Agora recommends setting the `profile` parameter in `setAudioProfile` as `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`. + * - This method works best with the human voice, and Agora does not recommend using it for audio containing music and a human voice. + * - Do not use this method with `setLocalVoiceChanger`, because the method called later overrides the one called earlier. + * For detailed considerations, see the advanced guide *Set the Voice Effect*. + * - You can call this method either before or after joining a channel. + * + * @param reverbPreset The local voice reverberation option. The default value is `AUDIO_REVERB_OFF`, + * which means the original voice. See #AUDIO_REVERB_PRESET. + * To achieve better voice effects, Agora recommends the enumeration whose name begins with `AUDIO_REVERB_FX`. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setLocalVoiceReverbPreset(AUDIO_REVERB_PRESET reverbPreset) = 0; + /** Sets an SDK preset voice beautifier effect. + * + * @since v3.2.0 + * + * Call this method to set an SDK preset voice beautifier effect for the local user who sends an audio stream. After + * setting a voice beautifier effect, all users in the channel can hear the effect. + * + * You can set different voice beautifier effects for different scenarios. See *Set the Voice Effect*. + * + * To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and + * setting the `scenario` parameter to `AUDIO_SCENARIO_GAME_STREAMING(3)` and the `profile` parameter to + * `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before calling this method. + * + * @note + * - You can call this method either before or after joining a channel. + * - Do not set the `profile` parameter of \ref IRtcEngine::setAudioProfile "setAudioProfile" to `AUDIO_PROFILE_SPEECH_STANDARD(1)` + * or `AUDIO_PROFILE_IOT(6)`; otherwise, this method call does not take effect. + * - This method works best with the human voice. Agora does not recommend using this method for audio containing music. + * - After calling this method, Agora recommends not calling the following methods, because they can override \ref IRtcEngine::setAudioEffectParameters "setAudioEffectParameters": + * - \ref IRtcEngine::setAudioEffectPreset "setAudioEffectPreset" + * - \ref IRtcEngine::setVoiceBeautifierPreset "setVoiceBeautifierPreset" + * - \ref IRtcEngine::setLocalVoiceReverbPreset "setLocalVoiceReverbPreset" + * - \ref IRtcEngine::setLocalVoiceChanger "setLocalVoiceChanger" + * - \ref IRtcEngine::setLocalVoicePitch "setLocalVoicePitch" + * - \ref IRtcEngine::setLocalVoiceEqualization "setLocalVoiceEqualization" + * - \ref IRtcEngine::setLocalVoiceReverb "setLocalVoiceReverb" + * - \ref IRtcEngine::setVoiceBeautifierParameters "setVoiceBeautifierParameters" + * - \ref IRtcEngine::setVoiceConversionPreset "setVoiceConversionPreset" + * + * @param preset The options for SDK preset voice beautifier effects: #VOICE_BEAUTIFIER_PRESET. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setVoiceBeautifierPreset(VOICE_BEAUTIFIER_PRESET preset) = 0; + /** Sets an SDK preset audio effect. + * + * @since v3.2.0 + * + * Call this method to set an SDK preset audio effect for the local user who sends an audio stream. This audio effect + * does not change the gender characteristics of the original voice. After setting an audio effect, all users in the + * channel can hear the effect. + * + * You can set different audio effects for different scenarios. See *Set the Voice Effect*. + * + * To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" + * and setting the `scenario` parameter to `AUDIO_SCENARIO_GAME_STREAMING(3)` before calling this method. + * + * @note + * - You can call this method either before or after joining a channel. + * - Do not set the profile `parameter` of `setAudioProfile` to `AUDIO_PROFILE_SPEECH_STANDARD(1)` or `AUDIO_PROFILE_IOT(6)`; + * otherwise, this method call does not take effect. + * - This method works best with the human voice. Agora does not recommend using this method for audio containing music. + * - If you call this method and set the `preset` parameter to enumerators except `ROOM_ACOUSTICS_3D_VOICE` or `PITCH_CORRECTION`, + * do not call \ref IRtcEngine::setAudioEffectParameters "setAudioEffectParameters"; otherwise, `setAudioEffectParameters` + * overrides this method. + * - After calling this method, Agora recommends not calling the following methods, because they can override `setAudioEffectPreset`: + * - \ref IRtcEngine::setVoiceBeautifierPreset "setVoiceBeautifierPreset" + * - \ref IRtcEngine::setLocalVoiceReverbPreset "setLocalVoiceReverbPreset" + * - \ref IRtcEngine::setLocalVoiceChanger "setLocalVoiceChanger" + * - \ref IRtcEngine::setLocalVoicePitch "setLocalVoicePitch" + * - \ref IRtcEngine::setLocalVoiceEqualization "setLocalVoiceEqualization" + * - \ref IRtcEngine::setLocalVoiceReverb "setLocalVoiceReverb" + * - \ref IRtcEngine::setVoiceBeautifierParameters "setVoiceBeautifierParameters" + * - \ref IRtcEngine::setVoiceConversionPreset "setVoiceConversionPreset" + * + * @param preset The options for SDK preset audio effects. See #AUDIO_EFFECT_PRESET. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setAudioEffectPreset(AUDIO_EFFECT_PRESET preset) = 0; + /** Sets an SDK preset voice conversion effect. + * + * @since v3.3.1 + * + * Call this method to set an SDK preset voice conversion effect for the + * local user who sends an audio stream. After setting a voice conversion + * effect, all users in the channel can hear the effect. + * + * You can set different voice conversion effects for different scenarios. + * See *Set the Voice Effect*. + * + * To achieve better voice effect quality, Agora recommends calling + * \ref IRtcEngine::setAudioProfile "setAudioProfile" and setting the + * `profile` parameter to #AUDIO_PROFILE_MUSIC_HIGH_QUALITY (4) or + * #AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO (5) and the `scenario` + * parameter to #AUDIO_SCENARIO_GAME_STREAMING (3) before calling this + * method. + * + * @note + * - You can call this method either before or after joining a channel. + * - Do not set the `profile` parameter of `setAudioProfile` to + * #AUDIO_PROFILE_SPEECH_STANDARD (1) or + * #AUDIO_PROFILE_IOT (6); otherwise, this method call does not take effect. + * - This method works best with the human voice. Agora does not recommend + * using this method for audio containing music. + * - After calling this method, Agora recommends not calling the following + * methods, because they can override `setVoiceConversionPreset`: + * - \ref IRtcEngine::setAudioEffectPreset "setAudioEffectPreset" + * - \ref IRtcEngine::setAudioEffectParameters "setAudioEffectParameters" + * - \ref IRtcEngine::setVoiceBeautifierPreset "setVoiceBeautifierPreset" + * - \ref IRtcEngine::setVoiceBeautifierParameters "setVoiceBeautifierParameters" + * - \ref IRtcEngine::setLocalVoiceReverbPreset "setLocalVoiceReverbPreset" + * - \ref IRtcEngine::setLocalVoiceChanger "setLocalVoiceChanger" + * - \ref IRtcEngine::setLocalVoicePitch "setLocalVoicePitch" + * - \ref IRtcEngine::setLocalVoiceEqualization "setLocalVoiceEqualization" + * - \ref IRtcEngine::setLocalVoiceReverb "setLocalVoiceReverb" + * + * @param preset The options for SDK preset voice conversion effects: #VOICE_CONVERSION_PRESET. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setVoiceConversionPreset(VOICE_CONVERSION_PRESET preset) = 0; + /** Sets parameters for SDK preset audio effects. + * + * @since v3.2.0 + * + * Call this method to set the following parameters for the local user who sends an audio stream: + * - 3D voice effect: Sets the cycle period of the 3D voice effect. + * - Pitch correction effect: Sets the basic mode and tonic pitch of the pitch correction effect. Different songs + * have different modes and tonic pitches. Agora recommends bounding this method with interface elements to enable + * users to adjust the pitch correction interactively. + * + * After setting parameters, all users in the channel can hear the relevant effect. + * + * + * @note + * - You can call this method either before or after joining a channel. + * - To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" + * and setting the `scenario` parameter to `AUDIO_SCENARIO_GAME_STREAMING(3)` before calling this method. + * - Do not set the `profile` parameter of \ref IRtcEngine::setAudioProfile "setAudioProfile" to `AUDIO_PROFILE_SPEECH_STANDARD(1)` or + * `AUDIO_PROFILE_IOT(6)`; otherwise, this method call does not take effect. + * - This method works best with the human voice. Agora does not recommend using this method for audio containing music. + * - After calling this method, Agora recommends not calling the following methods, because they can override `setAudioEffectParameters`: + * - \ref IRtcEngine::setAudioEffectPreset "setAudioEffectPreset" + * - \ref IRtcEngine::setVoiceBeautifierPreset "setVoiceBeautifierPreset" + * - \ref IRtcEngine::setLocalVoiceReverbPreset "setLocalVoiceReverbPreset" + * - \ref IRtcEngine::setLocalVoiceChanger "setLocalVoiceChanger" + * - \ref IRtcEngine::setLocalVoicePitch "setLocalVoicePitch" + * - \ref IRtcEngine::setLocalVoiceEqualization "setLocalVoiceEqualization" + * - \ref IRtcEngine::setLocalVoiceReverb "setLocalVoiceReverb" + * - \ref IRtcEngine::setVoiceBeautifierParameters "setVoiceBeautifierParameters" + * - \ref IRtcEngine::setVoiceConversionPreset "setVoiceConversionPreset" + * @param preset The options for SDK preset audio effects: + * - 3D voice effect: `ROOM_ACOUSTICS_3D_VOICE`. + * - Call \ref IRtcEngine::setAudioProfile "setAudioProfile" and set the `profile` parameter to `AUDIO_PROFILE_MUSIC_STANDARD_STEREO(3)` + * or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before setting this enumerator; otherwise, the enumerator setting does not take effect. + * - If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect. + * - Pitch correction effect: `PITCH_CORRECTION`. To achieve better audio effect quality, Agora recommends calling + * \ref IRtcEngine::setAudioProfile "setAudioProfile" and setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or + * `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before setting this enumerator. + * @param param1 + * - If you set `preset` to `ROOM_ACOUSTICS_3D_VOICE`, the `param1` sets the cycle period of the 3D voice effect. + * The value range is [1,60] and the unit is a second. The default value is 10 seconds, indicating that the voice moves + * around you every 10 seconds. + * - If you set `preset` to `PITCH_CORRECTION`, `param1` sets the basic mode of the pitch correction effect: + * - `1`: (Default) Natural major scale. + * - `2`: Natural minor scale. + * - `3`: Japanese pentatonic scale. + * @param param2 + * - If you set `preset` to `ROOM_ACOUSTICS_3D_VOICE`, you need to set `param2` to `0`. + * - If you set `preset` to `PITCH_CORRECTION`, `param2` sets the tonic pitch of the pitch correction effect: + * - `1`: A + * - `2`: A# + * - `3`: B + * - `4`: (Default) C + * - `5`: C# + * - `6`: D + * - `7`: D# + * - `8`: E + * - `9`: F + * - `10`: F# + * - `11`: G + * - `12`: G# + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setAudioEffectParameters(AUDIO_EFFECT_PRESET preset, int param1, int param2) = 0; + /** Sets parameters for SDK preset voice beautifier effects. + * + * @since v3.3.0 + * + * Call this method to set a gender characteristic and a reverberation effect for the singing beautifier effect. This method sets parameters for the local user who sends an audio stream. + * + * After you call this method successfully, all users in the channel can hear the relevant effect. + * + * To achieve better audio effect quality, before you call this method, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile", and setting the `scenario` parameter + * as `AUDIO_SCENARIO_GAME_STREAMING(3)` and the `profile` parameter as `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`. + * + * @note + * - You can call this method either before or after joining a channel. + * - Do not set the `profile` parameter of \ref IRtcEngine::setAudioProfile "setAudioProfile" as `AUDIO_PROFILE_SPEECH_STANDARD(1)` or `AUDIO_PROFILE_IOT(6)`; otherwise, this method call does not take effect. + * - This method works best with the human voice. Agora does not recommend using this method for audio containing music. + * - After you call this method, Agora recommends not calling the following methods, because they can override `setVoiceBeautifierParameters`: + * - \ref IRtcEngine::setAudioEffectPreset "setAudioEffectPreset" + * - \ref IRtcEngine::setAudioEffectParameters "setAudioEffectParameters" + * - \ref IRtcEngine::setVoiceBeautifierPreset "setVoiceBeautifierPreset" + * - \ref IRtcEngine::setLocalVoiceReverbPreset "setLocalVoiceReverbPreset" + * - \ref IRtcEngine::setLocalVoiceChanger "setLocalVoiceChanger" + * - \ref IRtcEngine::setLocalVoicePitch "setLocalVoicePitch" + * - \ref IRtcEngine::setLocalVoiceEqualization "setLocalVoiceEqualization" + * - \ref IRtcEngine::setLocalVoiceReverb "setLocalVoiceReverb" + * - \ref IRtcEngine::setVoiceConversionPreset "setVoiceConversionPreset" + * + * @param preset The options for SDK preset voice beautifier effects: + * - `SINGING_BEAUTIFIER`: Singing beautifier effect. + * @param param1 The gender characteristics options for the singing voice: + * - `1`: A male-sounding voice. + * - `2`: A female-sounding voice. + * @param param2 The reverberation effects options: + * - `1`: The reverberation effect sounds like singing in a small room. + * - `2`: The reverberation effect sounds like singing in a large room. + * - `3`: The reverberation effect sounds like singing in a hall. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setVoiceBeautifierParameters(VOICE_BEAUTIFIER_PRESET preset, int param1, int param2) = 0; + /** Sets the log files that the SDK outputs. + * + * @deprecated This method is deprecated from v3.3.0. Use `logConfig` in the \ref IRtcEngine::initialize "initialize" method instead. + * + * By default, the SDK outputs five log files, `agorasdk.log`, `agorasdk_1.log`, `agorasdk_2.log`, `agorasdk_3.log`, `agorasdk_4.log`, each with a default size of 1024 KB. + * These log files are encoded in UTF-8. The SDK writes the latest logs in `agorasdk.log`. When `agorasdk.log` is full, the SDK deletes the log file with the earliest + * modification time among the other four, renames `agorasdk.log` to the name of the deleted log file, and create a new `agorasdk.log` to record latest logs. + * + * @note Ensure that you call this method immediately after calling \ref agora::rtc::IRtcEngine::initialize "initialize" , otherwise the output logs may not be complete. + * + * @see \ref IRtcEngine::setLogFileSize "setLogFileSize" + * @see \ref IRtcEngine::setLogFilter "setLogFilter" + * + * @param filePath The absolute path of log files. The default file path is `C: \Users\\AppData\Local\Agora\\agorasdk.log`. + * Ensure that the directory for the log files exists and is writable. You can use this parameter to rename the log files. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setLogFile(const char* filePath) = 0; + /// @cond + /** Specifies an SDK external log writer. - /** Changes the voice pitch of the local speaker. + The external log writer output all SDK operations during runtime if it exist. - @note You can call this method either before or after joining a channel. + @note + - Ensure that you call this method after calling the \ref agora::rtc::IRtcEngine::initialize "initialize" method. - @param pitch Sets the voice pitch. The value ranges between 0.5 and 2.0. The lower the value, the lower the voice pitch. The default value is 1.0 (no change to the local voice pitch). - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setLocalVoicePitch(double pitch) = 0; - /** Sets the local voice equalization effect. + @param pLogWriter . - @note You can call this method either before or after joining a channel. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setLogWriter(agora::commons::ILogWriter* pLogWriter) = 0; - @param bandFrequency Sets the band frequency. The value ranges between 0 and 9, representing the respective 10-band center frequencies of the voice effects, including 31, 62, 125, 250, 500, 1k, 2k, 4k, 8k, and 16k Hz. See #AUDIO_EQUALIZATION_BAND_FREQUENCY. - @param bandGain Sets the gain of each band in dB. The value ranges between -15 and 15. + /** Set the value of external log writer to null + @note + - Ensure that you call this method after calling the \ref agora::rtc::IRtcEngine::initialize "initialize" method. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setLocalVoiceEqualization(AUDIO_EQUALIZATION_BAND_FREQUENCY bandFrequency, int bandGain) = 0; - /** Sets the local voice reverberation. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int releaseLogWriter() = 0; + /// @endcond + /** Sets the output log level of the SDK. - v2.4.0 adds the \ref agora::rtc::IRtcEngine::setLocalVoiceReverbPreset "setLocalVoiceReverbPreset" method, a more user-friendly method for setting the local voice reverberation. You can use this method to set the local reverberation effect, such as pop music, R&B, rock music, and hip-hop. + @deprecated This method is deprecated from v3.3.0. Use `logConfig` in the \ref IRtcEngine::initialize "initialize" method instead. - @note You can call this method either before or after joining a channel. + You can use one or a combination of the log filter levels. The log level follows the sequence of OFF, CRITICAL, ERROR, WARNING, INFO, and DEBUG. Choose a level to see the logs preceding that level. - @param reverbKey Sets the reverberation key. See #AUDIO_REVERB_TYPE. - @param value Sets the value of the reverberation key. + If you set the log level to WARNING, you see the logs within levels CRITICAL, ERROR, and WARNING. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setLocalVoiceReverb(AUDIO_REVERB_TYPE reverbKey, int value) = 0; - /** Sets the local voice changer option. - - @deprecated Deprecated from v3.2.0. Use \ref IRtcEngine::setAudioEffectPreset "setAudioEffectPreset" or - \ref IRtcEngine::setVoiceBeautifierPreset "setVoiceBeautifierPreset" instead. - - This method can be used to set the local voice effect for users in a `COMMUNICATION` channel or hosts in a `LIVE_BROADCASTING` channel. - Voice changer options include the following voice effects: - - - `VOICE_CHANGER_XXX`: Changes the local voice to an old man, a little boy, or the Hulk. Applies to the voice talk scenario. - - `VOICE_BEAUTY_XXX`: Beautifies the local voice by making it sound more vigorous, resounding, or adding spacial resonance. Applies to the voice talk and singing scenario. - - `GENERAL_VOICE_BEAUTY_XXX`: Adds gender-based beautification effect to the local voice. Applies to the voice talk scenario. - - For a male voice: Adds magnetism to the voice. - - For a female voice: Adds freshness or vitality to the voice. - - @note - - To achieve better voice effect quality, Agora recommends setting the profile parameter in \ref IRtcEngine::setAudioProfile "setAudioProfile" as #AUDIO_PROFILE_MUSIC_HIGH_QUALITY (4) or #AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO (5) - - This method works best with the human voice, and Agora does not recommend using it for audio containing music and a human voice. - - Do not use this method with \ref IRtcEngine::setLocalVoiceReverbPreset "setLocalVoiceReverbPreset" , because the method called later overrides the one called earlier. For detailed considerations, see the advanced guide *Voice Changer and Reverberation*. - - You can call this method either before or after joining a channel. - - @param voiceChanger Sets the local voice changer option. The default value is #VOICE_CHANGER_OFF, which means the original voice. See details in #VOICE_CHANGER_PRESET - Gender-based beatification effect works best only when assigned a proper gender: - - For male: #GENERAL_BEAUTY_VOICE_MALE_MAGNETIC - - For female: #GENERAL_BEAUTY_VOICE_FEMALE_FRESH or #GENERAL_BEAUTY_VOICE_FEMALE_VITALITY - Failure to do so can lead to voice distortion. - - @return - - 0: Success. - - < 0: Failure. Check if the enumeration is properly set. - */ - virtual int setLocalVoiceChanger(VOICE_CHANGER_PRESET voiceChanger) = 0; - /** Sets the local voice reverberation option, including the virtual stereo. - * - * @deprecated Deprecated from v3.2.0. Use \ref IRtcEngine::setAudioEffectPreset "setAudioEffectPreset" or - * \ref IRtcEngine::setVoiceBeautifierPreset "setVoiceBeautifierPreset" instead. - * - * This method sets the local voice reverberation for users in a `COMMUNICATION` channel or hosts in a `LIVE_BROADCASTING` channel. - * After successfully calling this method, all users in the channel can hear the voice with reverberation. - * - * @note - * - When calling this method with enumerations that begin with `AUDIO_REVERB_FX`, ensure that you set profile in `setAudioProfile` as - * `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`; otherwise, this methods cannot set the corresponding voice reverberation option. - * - When calling this method with `AUDIO_VIRTUAL_STEREO`, Agora recommends setting the `profile` parameter in `setAudioProfile` as `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)`. - * - This method works best with the human voice, and Agora does not recommend using it for audio containing music and a human voice. - * - Do not use this method with `setLocalVoiceChanger`, because the method called later overrides the one called earlier. - * For detailed considerations, see the advanced guide *Voice Changer and Reverberation*. - * - You can call this method either before or after joining a channel. - * - * @param reverbPreset The local voice reverberation option. The default value is `AUDIO_REVERB_OFF`, - * which means the original voice. See #AUDIO_REVERB_PRESET. - * To achieve better voice effects, Agora recommends the enumeration whose name begins with `AUDIO_REVERB_FX`. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int setLocalVoiceReverbPreset(AUDIO_REVERB_PRESET reverbPreset) = 0; - /** Sets an SDK preset voice beautifier effect. - * - * @since v3.2.0 - * - * Call this method to set an SDK preset voice beautifier effect for the local user who sends an audio stream. After - * setting a voice beautifier effect, all users in the channel can hear the effect. - * - * You can set different voice beautifier effects for different scenarios. See *Set the Voice Beautifier and Audio Effects*. - * - * To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" and - * setting the `scenario` parameter to `AUDIO_SCENARIO_GAME_STREAMING(3)` and the `profile` parameter to - * `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before calling this method. - * - * @note - * - You can call this method either before or after joining a channel. - * - Do not set the `profile` parameter of \ref IRtcEngine::setAudioProfile "setAudioProfile" to `AUDIO_PROFILE_SPEECH_STANDARD(1)` - * or `AUDIO_PROFILE_IOT(6)`; otherwise, this method call fails. - * - This method works best with the human voice. Agora does not recommend using this method for audio containing music. - * - After calling this method, Agora recommends not calling the following methods, because they can override \ref IRtcEngine::setAudioEffectParameters "setAudioEffectParameters": - * - \ref IRtcEngine::setAudioEffectPreset "setAudioEffectPreset" - * - \ref IRtcEngine::setVoiceBeautifierPreset "setVoiceBeautifierPreset" - * - \ref IRtcEngine::setLocalVoiceReverbPreset "setLocalVoiceReverbPreset" - * - \ref IRtcEngine::setLocalVoiceChanger "setLocalVoiceChanger" - * - \ref IRtcEngine::setLocalVoicePitch "setLocalVoicePitch" - * - \ref IRtcEngine::setLocalVoiceEqualization "setLocalVoiceEqualization" - * - \ref IRtcEngine::setLocalVoiceReverb "setLocalVoiceReverb" - * - * @param preset The options for SDK preset voice beautifier effects: #VOICE_BEAUTIFIER_PRESET. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int setVoiceBeautifierPreset(VOICE_BEAUTIFIER_PRESET preset) = 0; - /** Sets an SDK preset audio effect. - * - * @since v3.2.0 - * - * Call this method to set an SDK preset audio effect for the local user who sends an audio stream. This audio effect - * does not change the gender characteristics of the original voice. After setting an audio effect, all users in the - * channel can hear the effect. - * - * You can set different audio effects for different scenarios. See *Set the Voice Beautifier and Audio Effects*. - * - * To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" - * and setting the `scenario` parameter to `AUDIO_SCENARIO_GAME_STREAMING(3)` before calling this method. - * - * @note - * - You can call this method either before or after joining a channel. - * - Do not set the profile `parameter` of `setAudioProfile` to `AUDIO_PROFILE_SPEECH_STANDARD(1)` or `AUDIO_PROFILE_IOT(6)`; - * otherwise, this method call fails. - * - This method works best with the human voice. Agora does not recommend using this method for audio containing music. - * - If you call this method and set the `preset` parameter to enumerators except `ROOM_ACOUSTICS_3D_VOICE` or `PITCH_CORRECTION`, - * do not call \ref IRtcEngine::setAudioEffectParameters "setAudioEffectParameters"; otherwise, `setAudioEffectParameters` - * overrides this method. - * - After calling this method, Agora recommends not calling the following methods, because they can override `setAudioEffectPreset`: - * - \ref IRtcEngine::setVoiceBeautifierPreset "setVoiceBeautifierPreset" - * - \ref IRtcEngine::setLocalVoiceReverbPreset "setLocalVoiceReverbPreset" - * - \ref IRtcEngine::setLocalVoiceChanger "setLocalVoiceChanger" - * - \ref IRtcEngine::setLocalVoicePitch "setLocalVoicePitch" - * - \ref IRtcEngine::setLocalVoiceEqualization "setLocalVoiceEqualization" - * - \ref IRtcEngine::setLocalVoiceReverb "setLocalVoiceReverb" - * - * @param preset The options for SDK preset audio effects. See #AUDIO_EFFECT_PRESET. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int setAudioEffectPreset(AUDIO_EFFECT_PRESET preset) = 0; - /** Sets parameters for SDK preset audio effects. - * - * @since v3.2.0 - * - * Call this method to set the following parameters for the local user who send an audio stream: - * - 3D voice effect: Sets the cycle period of the 3D voice effect. - * - Pitch correction effect: Sets the basic mode and tonic pitch of the pitch correction effect. Different songs - * have different modes and tonic pitches. Agora recommends bounding this method with interface elements to enable - * users to adjust the pitch correction interactively. - * - * After setting parameters, all users in the channel can hear the relevant effect. - * - * You can call this method directly or after \ref IRtcEngine::setAudioEffectPreset "setAudioEffectPreset". If you - * call this method after \ref IRtcEngine::setAudioEffectPreset "setAudioEffectPreset", ensure that you set the preset - * parameter of `setAudioEffectPreset` to `ROOM_ACOUSTICS_3D_VOICE` or `PITCH_CORRECTION` and then call this method - * to set the same enumerator; otherwise, this method overrides `setAudioEffectPreset`. - * - * @note - * - You can call this method either before or after joining a channel. - * - To achieve better audio effect quality, Agora recommends calling \ref IRtcEngine::setAudioProfile "setAudioProfile" - * and setting the `scenario` parameter to `AUDIO_SCENARIO_GAME_STREAMING(3)` before calling this method. - * - Do not set the `profile` parameter of \ref IRtcEngine::setAudioProfile "setAudioProfile" to `AUDIO_PROFILE_SPEECH_STANDARD(1)` or - * `AUDIO_PROFILE_IOT(6)`; otherwise, this method call fails. - * - This method works best with the human voice. Agora does not recommend using this method for audio containing music. - * - After calling this method, Agora recommends not calling the following methods, because they can override `setAudioEffectParameters`: - * - \ref IRtcEngine::setAudioEffectPreset "setAudioEffectPreset" - * - \ref IRtcEngine::setVoiceBeautifierPreset "setVoiceBeautifierPreset" - * - \ref IRtcEngine::setLocalVoiceReverbPreset "setLocalVoiceReverbPreset" - * - \ref IRtcEngine::setLocalVoiceChanger "setLocalVoiceChanger" - * - \ref IRtcEngine::setLocalVoicePitch "setLocalVoicePitch" - * - \ref IRtcEngine::setLocalVoiceEqualization "setLocalVoiceEqualization" - * - \ref IRtcEngine::setLocalVoiceReverb "setLocalVoiceReverb" - * - * @param preset The options for SDK preset audio effects: - * - 3D voice effect: `ROOM_ACOUSTICS_3D_VOICE`. - * - Call \ref IRtcEngine::setAudioProfile "setAudioProfile" and set the `profile` parameter to `AUDIO_PROFILE_MUSIC_STANDARD_STEREO(3)` - * or `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before setting this enumerator; otherwise, the enumerator setting does not take effect. - * - If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect. - * - Pitch correction effect: `PITCH_CORRECTION`. To achieve better audio effect quality, Agora recommends calling - * \ref IRtcEngine::setAudioProfile "setAudioProfile" and setting the `profile` parameter to `AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)` or - * `AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)` before setting this enumerator. - * @param param1 - * - If you set `preset` to `ROOM_ACOUSTICS_3D_VOICE`, the `param1` sets the cycle period of the 3D voice effect. - * The value range is [1,60] and the unit is a second. The default value is 10 seconds, indicating that the voice moves - * around you every 10 seconds. - * - If you set `preset` to `PITCH_CORRECTION`, `param1` sets the basic mode of the pitch correction effect: - * - `1`: (Default) Natural major scale. - * - `2`: Natural minor scale. - * - `3`: Japanese pentatonic scale. - * @param param2 - * - If you set `preset` to `ROOM_ACOUSTICS_3D_VOICE`, you do not need to set `param2`. - * - If you set `preset` to `PITCH_CORRECTION`, `param2` sets the tonic pitch of the pitch correction effect: - * - `1`: A - * - `2`: A# - * - `3`: B - * - `4`: (Default) C - * - `5`: C# - * - `6`: D - * - `7`: D# - * - `8`: E - * - `9`: F - * - `10`: F# - * - `11`: G - * - `12`: G# - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int setAudioEffectParameters(AUDIO_EFFECT_PRESET preset, int param1, int param2) = 0; - /** Sets the log files that the SDK outputs. - * - * By default, the SDK outputs five log files, `agorasdk.log`, `agorasdk_1.log`, `agorasdk_2.log`, `agorasdk_3.log`, `agorasdk_4.log`, each with a default size of 1024 KB. - * These log files are encoded in UTF-8. The SDK writes the latest logs in `agorasdk.log`. When `agorasdk.log` is full, the SDK deletes the log file with the earliest - * modification time among the other four, renames `agorasdk.log` to the name of the deleted log file, and create a new `agorasdk.log` to record latest logs. - * - * @note Ensure that you call this method immediately after calling \ref agora::rtc::IRtcEngine::initialize "initialize" , otherwise the output logs may not be complete. - * - * @see \ref IRtcEngine::setLogFileSize "setLogFileSize" - * @see \ref IRtcEngine::setLogFilter "setLogFilter" - * - * @param filePath The absolute path of log files. The default file path is `C: \Users\\AppData\Local\Agora\\agorasdk.log`. - * Ensure that the directory for the log files exists and is writable. You can use this parameter to rename the log files. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int setLogFile(const char* filePath) = 0; - /** Sets the output log level of the SDK. + @see \ref IRtcEngine::setLogFile "setLogFile" + @see \ref IRtcEngine::setLogFileSize "setLogFileSize" - You can use one or a combination of the log filter levels. The log level follows the sequence of OFF, CRITICAL, ERROR, WARNING, INFO, and DEBUG. Choose a level to see the logs preceding that level. + @param filter Sets the log filter level. See #LOG_FILTER_TYPE. - If you set the log level to WARNING, you see the logs within levels CRITICAL, ERROR, and WARNING. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setLogFilter(unsigned int filter) = 0; + /** Sets the size of a log file that the SDK outputs. + * + * @deprecated This method is deprecated from v3.3.0. Use `logConfig` in the \ref IRtcEngine::initialize "initialize" method instead. + * + * @note If you want to set the log file size, ensure that you call + * this method before \ref IRtcEngine::setLogFile "setLogFile", or the logs are cleared. + * + * By default, the SDK outputs five log files, `agorasdk.log`, `agorasdk_1.log`, `agorasdk_2.log`, `agorasdk_3.log`, `agorasdk_4.log`, each with a default size of 1024 KB. + * These log files are encoded in UTF-8. The SDK writes the latest logs in `agorasdk.log`. When `agorasdk.log` is full, the SDK deletes the log file with the earliest + * modification time among the other four, renames `agorasdk.log` to the name of the deleted log file, and create a new `agorasdk.log` to record latest logs. + * + * @see \ref IRtcEngine::setLogFile "setLogFile" + * @see \ref IRtcEngine::setLogFilter "setLogFilter" + * + * @param fileSizeInKBytes The size (KB) of a log file. The default value is 1024 KB. If you set `fileSizeInKByte` to 1024 KB, + * the SDK outputs at most 5 MB log files; if you set it to less than 1024 KB, the maximum size of a log file is still 1024 KB. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setLogFileSize(unsigned int fileSizeInKBytes) = 0; + /// @cond + /** Uploads all SDK log files. + * + * @since v3.3.0 + * + * Uploads all SDK log files from the client to the Agora server. + * After a successful method call, the SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onUploadLogResult "onUploadLogResult" callback + * to report whether the log files are successfully uploaded to the Agora server. + * + * + * For easier debugging, Agora recommends that you bind this method to the UI element of your App, so as to instruct the + * user to upload a log file when a quality issue occurs. + * + * @note Do not call this method more than once per minute, otherwise the SDK reports #ERR_TOO_OFTEN (12). + * + * @param[out] requestId The request ID. This request ID is the same as requestId in the \ref IRtcEngineEventHandler::onUploadLogResult "onUploadLogResult" callback, + * and you can use the request ID to match a specific upload with a callback. + * + * @return + * - 0: Success. + * - < 0: Failure. + * - -12(ERR_TOO_OFTEN): The call frequency exceeds the limit. + */ + virtual int uploadLogFile(agora::util::AString& requestId) = 0; + /// @endcond + /** + @deprecated This method is deprecated, use the \ref IRtcEngine::setLocalRenderMode(RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) "setLocalRenderMode" [2/2] method instead. + Sets the local video display mode. - @see \ref IRtcEngine::setLogFile "setLogFile" - @see \ref IRtcEngine::setLogFileSize "setLogFileSize" + This method can be called multiple times during a call to change the display mode. - @param filter Sets the log filter level. See #LOG_FILTER_TYPE. + @param renderMode Sets the local video display mode. See #RENDER_MODE_TYPE. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setLocalRenderMode(RENDER_MODE_TYPE renderMode) = 0; + /** Updates the display mode of the local video view. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setLogFilter(unsigned int filter) = 0; - /** Sets the size of a log file that the SDK outputs. - * - * - * @note If you want to set the log file size, ensure that you call - * this method before \ref IRtcEngine::setLogFile "setLogFile", or the logs are cleared. - * - * By default, the SDK outputs five log files, `agorasdk.log`, `agorasdk_1.log`, `agorasdk_2.log`, `agorasdk_3.log`, `agorasdk_4.log`, each with a default size of 1024 KB. - * These log files are encoded in UTF-8. The SDK writes the latest logs in `agorasdk.log`. When `agorasdk.log` is full, the SDK deletes the log file with the earliest - * modification time among the other four, renames `agorasdk.log` to the name of the deleted log file, and create a new `agorasdk.log` to record latest logs. - * - * @see \ref IRtcEngine::setLogFile "setLogFile" - * @see \ref IRtcEngine::setLogFilter "setLogFilter" - * - * @param fileSizeInKBytes The size (KB) of a log file. The default value is 1024 KB. If you set `fileSizeInKByte` to 1024 KB, - * the SDK outputs at most 5 MB log files; if you set it to less than 1024 KB, the maximum size of a log file is still 1024 KB. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int setLogFileSize(unsigned int fileSizeInKBytes) = 0; - /** - @deprecated This method is deprecated, use the \ref IRtcEngine::setLocalRenderMode(RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) "setLocalRenderMode"2 method instead. - Sets the local video display mode. + @since v3.0.0 - This method can be called multiple times during a call to change the display mode. + After initializing the local video view, you can call this method to update its rendering and mirror modes. It affects only the video view that the local user sees, not the published local video stream. - @param renderMode Sets the local video display mode. See #RENDER_MODE_TYPE. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setLocalRenderMode(RENDER_MODE_TYPE renderMode) = 0; - /** Updates the display mode of the local video view. - - @since v3.0.0 - - After initializing the local video view, you can call this method to update its rendering and mirror modes. It affects only the video view that the local user sees, not the published local video stream. - - @note - - Ensure that you have called the \ref IRtcEngine::setupLocalVideo "setupLocalVideo" method to initialize the local video view before calling this method. - - During a call, you can call this method as many times as necessary to update the display mode of the local video view. - @param renderMode The rendering mode of the local video view. See #RENDER_MODE_TYPE. - @param mirrorMode - - The mirror mode of the local video view. See #VIDEO_MIRROR_MODE_TYPE. - - **Note**: If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setLocalRenderMode(RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0; - /** - @deprecated This method is deprecated, use the \ref IRtcEngine::setRemoteRenderMode(uid_t userId, RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) "setRemoteRenderMode"2 method instead. - Sets the video display mode of a specified remote user. - - This method can be called multiple times during a call to change the display mode. - - @param userId ID of the remote user. - @param renderMode Sets the video display mode. See #RENDER_MODE_TYPE. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setRemoteRenderMode(uid_t userId, RENDER_MODE_TYPE renderMode) = 0; - /** Updates the display mode of the video view of a remote user. + @note + - Ensure that you have called the \ref IRtcEngine::setupLocalVideo "setupLocalVideo" method to initialize the local video view before calling this method. + - During a call, you can call this method as many times as necessary to update the display mode of the local video view. + @param renderMode The rendering mode of the local video view. See #RENDER_MODE_TYPE. + @param mirrorMode + - The mirror mode of the local video view. See #VIDEO_MIRROR_MODE_TYPE. + - **Note**: If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setLocalRenderMode(RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0; + /** + @deprecated This method is deprecated, use the \ref IRtcEngine::setRemoteRenderMode(uid_t userId, RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) "setRemoteRenderMode" [2/2] method instead. + Sets the video display mode of a specified remote user. - @since v3.0.0 - After initializing the video view of a remote user, you can call this method to update its rendering and mirror modes. This method affects only the video view that the local user sees. + This method can be called multiple times during a call to change the display mode. - @note - - Ensure that you have called the \ref IRtcEngine::setupRemoteVideo "setupRemoteVideo" method to initialize the remote video view before calling this method. - - During a call, you can call this method as many times as necessary to update the display mode of the video view of a remote user. + @param userId ID of the remote user. + @param renderMode Sets the video display mode. See #RENDER_MODE_TYPE. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setRemoteRenderMode(uid_t userId, RENDER_MODE_TYPE renderMode) = 0; + /** Updates the display mode of the video view of a remote user. - @param userId The ID of the remote user. - @param renderMode The rendering mode of the remote video view. See #RENDER_MODE_TYPE. - @param mirrorMode - - The mirror mode of the remote video view. See #VIDEO_MIRROR_MODE_TYPE. - - **Note**: The SDK disables the mirror mode by default. + @since v3.0.0 + After initializing the video view of a remote user, you can call this method to update its rendering and mirror modes. This method affects only the video view that the local user sees. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setRemoteRenderMode(uid_t userId, RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0; - /** - @deprecated This method is deprecated, use the \ref IRtcEngine::setupLocalVideo "setupLocalVideo" - or \ref IRtcEngine::setLocalRenderMode(RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) "setLocalRenderMode" method instead. + @note + - Ensure that you have called the \ref IRtcEngine::setupRemoteVideo "setupRemoteVideo" method to initialize the remote video view before calling this method. + - During a call, you can call this method as many times as necessary to update the display mode of the video view of a remote user. - Sets the local video mirror mode. + @param userId The ID of the remote user. + @param renderMode The rendering mode of the remote video view. See #RENDER_MODE_TYPE. + @param mirrorMode + - The mirror mode of the remote video view. See #VIDEO_MIRROR_MODE_TYPE. + - **Note**: The SDK disables the mirror mode by default. - @warning Call this method after calling the \ref agora::rtc::IRtcEngine::setupLocalVideo "setupLocalVideo" method to initialize the local video view. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setRemoteRenderMode(uid_t userId, RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0; + /** + @deprecated This method is deprecated, use the \ref IRtcEngine::setupLocalVideo "setupLocalVideo" + or \ref IRtcEngine::setLocalRenderMode(RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) "setLocalRenderMode" method instead. - @param mirrorMode Sets the local video mirror mode. See #VIDEO_MIRROR_MODE_TYPE. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setLocalVideoMirrorMode(VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0; - /** Sets the stream mode to the single-stream (default) or dual-stream mode. (`LIVE_BROADCASTING` only.) + Sets the local video mirror mode. - If the dual-stream mode is enabled, the receiver can choose to receive the high stream (high-resolution and high-bitrate video stream), or the low stream (low-resolution and low-bitrate video stream). + @warning Call this method after calling the \ref agora::rtc::IRtcEngine::setupLocalVideo "setupLocalVideo" method to initialize the local video view. - @note You can call this method either before or after joining a channel. + @param mirrorMode Sets the local video mirror mode. See #VIDEO_MIRROR_MODE_TYPE. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setLocalVideoMirrorMode(VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0; + /** Sets the stream mode to the single-stream (default) or dual-stream mode. - @param enabled Sets the stream mode: - - true: Dual-stream mode. - - false: Single-stream mode. - */ - virtual int enableDualStreamMode(bool enabled) = 0; - /** Sets the external audio source. - - @note Please call this method before \ref agora::rtc::IRtcEngine::joinChannel "joinChannel" - and \ref IRtcEngine::startPreview "startPreview". - - @param enabled Sets whether to enable/disable the external audio source: - - true: Enables the external audio source. - - false: (Default) Disables the external audio source. - @param sampleRate Sets the sample rate (Hz) of the external audio source, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz. - @param channels Sets the number of audio channels of the external audio source: - - 1: Mono. - - 2: Stereo. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setExternalAudioSource(bool enabled, int sampleRate, int channels) = 0; - /** Sets the external audio sink. - * This method applies to scenarios where you want to use external audio - * data for playback. After enabling the external audio sink, you can call - * the \ref agora::media::IMediaEngine::pullAudioFrame "pullAudioFrame" method to pull the remote audio data, process - * it, and play it with the audio effects that you want. - * - * @note - * - Once you enable the external audio sink, the app will not retrieve any - * audio data from the - * \ref agora::media::IAudioFrameObserver::onPlaybackAudioFrame "onPlaybackAudioFrame" callback. - * - Ensure that you call this method before joining a channel. - * - * @param enabled - * - true: Enables the external audio sink. - * - false: (Default) Disables the external audio sink. - * @param sampleRate Sets the sample rate (Hz) of the external audio sink, which can be set as 16000, 32000, 44100 or 48000. - * @param channels Sets the number of audio channels of the external - * audio sink: - * - 1: Mono. - * - 2: Stereo. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int setExternalAudioSink(bool enabled, int sampleRate, int channels) = 0; - /** Sets the audio recording format for the \ref agora::media::IAudioFrameObserver::onRecordAudioFrame "onRecordAudioFrame" callback. + If the dual-stream mode is enabled, the receiver can choose to receive the high stream (high-resolution and high-bitrate video stream), or the low stream (low-resolution and low-bitrate video stream). - @note Ensure that you call this method before joining a channel. + @note You can call this method either before or after joining a channel. - @param sampleRate Sets the sample rate (@p samplesPerSec) returned in the *onRecordAudioFrame* callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz. - @param channel Sets the number of audio channels (@p channels) returned in the *onRecordAudioFrame* callback: - - 1: Mono - - 2: Stereo - @param mode Sets the use mode (see #RAW_AUDIO_FRAME_OP_MODE_TYPE) of the *onRecordAudioFrame* callback. - @param samplesPerCall Sets the number of samples returned in the *onRecordAudioFrame* callback. `samplesPerCall` is usually set as 1024 for RTMP streaming. + @param enabled Sets the stream mode: + - true: Dual-stream mode. + - false: Single-stream mode. + */ + virtual int enableDualStreamMode(bool enabled) = 0; + /** Sets the external audio source. + @note Please call this method before \ref agora::rtc::IRtcEngine::joinChannel "joinChannel" + and \ref IRtcEngine::startPreview "startPreview". - @note The SDK triggers the `onRecordAudioFrame` callback according to the sample interval. Ensure that the sample interval ≥ 0.01 (s). And, Sample interval (sec) = `samplePerCall`/(`sampleRate` × `channel`). + @param enabled Sets whether to enable/disable the external audio source: + - true: Enables the external audio source. + - false: (Default) Disables the external audio source. + @param sampleRate Sets the sample rate (Hz) of the external audio source, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz. + @param channels Sets the number of audio channels of the external audio source: + - 1: Mono. + - 2: Stereo. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setRecordingAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall) = 0; - /** Sets the audio playback format for the \ref agora::media::IAudioFrameObserver::onPlaybackAudioFrame "onPlaybackAudioFrame" callback. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setExternalAudioSource(bool enabled, int sampleRate, int channels) = 0; + /** Sets the external audio sink. + * This method applies to scenarios where you want to use external audio + * data for playback. After enabling the external audio sink, you can call + * the \ref agora::media::IMediaEngine::pullAudioFrame "pullAudioFrame" method to pull the remote audio data, process + * it, and play it with the audio effects that you want. + * + * @note + * - Once you enable the external audio sink, the app will not get any + * audio data from the + * \ref agora::media::IAudioFrameObserver::onPlaybackAudioFrame "onPlaybackAudioFrame" callback. + * - Ensure that you call this method before joining a channel. + * + * @param enabled + * - true: Enables the external audio sink. + * - false: (Default) Disables the external audio sink. + * @param sampleRate Sets the sample rate (Hz) of the external audio sink, which can be set as 16000, 32000, 44100 or 48000. + * @param channels Sets the number of audio channels of the external + * audio sink: + * - 1: Mono. + * - 2: Stereo. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setExternalAudioSink(bool enabled, int sampleRate, int channels) = 0; + /** Sets the audio recording format for the \ref agora::media::IAudioFrameObserver::onRecordAudioFrame "onRecordAudioFrame" callback. - @note Ensure that you call this method before joining a channel. + @note Ensure that you call this method before joining a channel. - @param sampleRate Sets the sample rate (@p samplesPerSec) returned in the *onPlaybackAudioFrame* callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz. - @param channel Sets the number of channels (@p channels) returned in the *onPlaybackAudioFrame* callback: - - 1: Mono - - 2: Stereo - @param mode Sets the use mode (see #RAW_AUDIO_FRAME_OP_MODE_TYPE) of the *onPlaybackAudioFrame* callback. - @param samplesPerCall Sets the number of samples returned in the *onPlaybackAudioFrame* callback. `samplesPerCall` is usually set as 1024 for RTMP streaming. + @param sampleRate Sets the sample rate (@p samplesPerSec) returned in the *onRecordAudioFrame* callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz. + @param channel Sets the number of audio channels (@p channels) returned in the *onRecordAudioFrame* callback: + - 1: Mono + - 2: Stereo + @param mode Sets the use mode (see #RAW_AUDIO_FRAME_OP_MODE_TYPE) of the *onRecordAudioFrame* callback. + @param samplesPerCall Sets the number of samples returned in the *onRecordAudioFrame* callback. `samplesPerCall` is usually set as 1024 for RTMP or RTMPS streaming. - @note The SDK triggers the `onPlaybackAudioFrame` callback according to the sample interval. Ensure that the sample interval ≥ 0.01 (s). And, Sample interval (sec) = `samplePerCall`/(`sampleRate` × `channel`). - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setPlaybackAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall) = 0; - /** Sets the mixed audio format for the \ref agora::media::IAudioFrameObserver::onMixedAudioFrame "onMixedAudioFrame" callback. + @note The SDK triggers the `onRecordAudioFrame` callback according to the sample interval. Ensure that the sample interval ≥ 0.01 (s). And, Sample interval (sec) = `samplePerCall`/(`sampleRate` × `channel`). - @note Ensure that you call this method before joining a channel. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setRecordingAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall) = 0; + /** Sets the audio playback format for the \ref agora::media::IAudioFrameObserver::onPlaybackAudioFrame "onPlaybackAudioFrame" callback. - @param sampleRate Sets the sample rate (@p samplesPerSec) returned in the *onMixedAudioFrame* callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz. - @param samplesPerCall Sets the number of samples (`samples`) returned in the *onMixedAudioFrame* callback. `samplesPerCall` is usually set as 1024 for RTMP streaming. + @note Ensure that you call this method before joining a channel. - @note The SDK triggers the `onMixedAudioFrame` callback according to the sample interval. Ensure that the sample interval ≥ 0.01 (s). And, Sample interval (sec) = `samplePerCall`/(`sampleRate` × `channels`). + @param sampleRate Sets the sample rate (@p samplesPerSec) returned in the *onPlaybackAudioFrame* callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz. + @param channel Sets the number of channels (@p channels) returned in the *onPlaybackAudioFrame* callback: + - 1: Mono + - 2: Stereo + @param mode Sets the use mode (see #RAW_AUDIO_FRAME_OP_MODE_TYPE) of the *onPlaybackAudioFrame* callback. + @param samplesPerCall Sets the number of samples returned in the *onPlaybackAudioFrame* callback. `samplesPerCall` is usually set as 1024 for RTMP or RTMPS streaming. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setMixedAudioFrameParameters(int sampleRate, int samplesPerCall) = 0; - /** Adjusts the recording volume. + @note The SDK triggers the `onPlaybackAudioFrame` callback according to the sample interval. Ensure that the sample interval ≥ 0.01 (s). And, Sample interval (sec) = `samplePerCall`/(`sampleRate` × `channel`). - @note You can call this method either before or after joining a channel. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setPlaybackAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall) = 0; + /** Sets the mixed audio format for the \ref agora::media::IAudioFrameObserver::onMixedAudioFrame "onMixedAudioFrame" callback. - @param volume Recording volume. To avoid echoes and - improve call quality, Agora recommends setting the value of volume between - 0 and 100. If you need to set the value higher than 100, contact - support@agora.io first. - - 0: Mute. - - 100: Original volume. + @note Ensure that you call this method before joining a channel. + @param sampleRate Sets the sample rate (@p samplesPerSec) returned in the *onMixedAudioFrame* callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz. + @param samplesPerCall Sets the number of samples (`samples`) returned in the *onMixedAudioFrame* callback. `samplesPerCall` is usually set as 1024 for RTMP or RTMPS streaming. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int adjustRecordingSignalVolume(int volume) = 0; - /** Adjusts the playback volume of all remote users. - - @note - - This method adjusts the playback volume that is the mixed volume of all remote users. - - You can call this method either before or after joining a channel. - - (Since v2.3.2) To mute the local audio playback, call both the `adjustPlaybackSignalVolume` and \ref IRtcEngine::adjustAudioMixingVolume "adjustAudioMixingVolume" methods and set the volume as `0`. - - @param volume The playback volume of all remote users. To avoid echoes and - improve call quality, Agora recommends setting the value of volume between - 0 and 100. If you need to set the value higher than 100, contact - support@agora.io first. - - 0: Mute. - - 100: Original volume. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int adjustPlaybackSignalVolume(int volume) = 0; + @note The SDK triggers the `onMixedAudioFrame` callback according to the sample interval. Ensure that the sample interval ≥ 0.01 (s). And, Sample interval (sec) = `samplePerCall`/(`sampleRate` × `channels`). - /** - @deprecated This method is deprecated. As of v3.0.0, the Native SDK automatically enables interoperability with the Web SDK, so you no longer need to call this method. - Enables interoperability with the Agora Web SDK. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setMixedAudioFrameParameters(int sampleRate, int samplesPerCall) = 0; + /** Adjusts the volume of the signal captured by the microphone. + * + * @note You can call this method either before or after joining a channel. + * + * @param volume The volume of the signal captured by the microphone. + * The range is 0 to 100. The default value is 100, which represents the + * original volume. + * - 0: Mute. + * - 100: Original volume. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int adjustRecordingSignalVolume(int volume) = 0; + /** Adjusts the playback signal volume of all remote users. + * + * @note + * - This method adjusts the playback volume that is the mixed volume of all + * remote users. + * - You can call this method either before or after joining a channel. + * - (Since v2.3.2) To mute the local audio playback, call both the + * `adjustPlaybackSignalVolume` and + * \ref IRtcEngine::adjustAudioMixingVolume "adjustAudioMixingVolume" + * methods and set the volume as `0`. + * + * @param volume The playback volume. The range is 0 to 100. The default + * value is 100, which represents the original volume. + * - 0: Mute. + * - 100: Original volume. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int adjustPlaybackSignalVolume(int volume) = 0; + /** + * Adjusts the volume of the signal captured by the sound card. + * + * @since v3.4.0 + * + * After calling enableLoopbackRecording to enable loopback audio capturing, + * you can call this method to adjust the volume of the signal captured by + * the sound card. + * + * @note This method applies to Windows and macOS only. + * + * @param volume The volume of the signal captured by the sound card. + * The range is 0 to 100. The default value is 100, which represents the + * unadjusted volume. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int adjustLoopbackRecordingSignalVolume(int volume) = 0; + /** + @deprecated This method is deprecated. As of v3.0.0, the Native SDK automatically enables interoperability with the Web SDK, so you no longer need to call this method. + Enables interoperability with the Agora Web SDK. - @note - - This method applies only to the `LIVE_BROADCASTING` profile. In the `COMMUNICATION` profile, interoperability with the Agora Web SDK is enabled by default. - - If the channel has Web SDK users, ensure that you call this method, or the video of the Native user will be a black screen for the Web user. + @note + - This method applies only to the `LIVE_BROADCASTING` profile. In the `COMMUNICATION` profile, interoperability with the Agora Web SDK is enabled by default. + - If the channel has Web SDK users, ensure that you call this method, or the video of the Native user will be a black screen for the Web user. - @param enabled Sets whether to enable/disable interoperability with the Agora Web SDK: - - true: Enable. - - false: (Default) Disable. + @param enabled Sets whether to enable/disable interoperability with the Agora Web SDK: + - true: Enable. + - false: (Default) Disable. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int enableWebSdkInteroperability(bool enabled) = 0; - //only for live broadcast - /** **DEPRECATED** Sets the preferences for the high-quality video. (`LIVE_BROADCASTING` only). + @return + - 0: Success. + - < 0: Failure. + */ + virtual int enableWebSdkInteroperability(bool enabled) = 0; + // only for live broadcast + /** **DEPRECATED** Sets the preferences for the high-quality video. (`LIVE_BROADCASTING` only). - This method is deprecated as of v2.4.0. + This method is deprecated as of v2.4.0. - @param preferFrameRateOverImageQuality Sets the video quality preference: - - true: Frame rate over image quality. - - false: (Default) Image quality over frame rate. + @param preferFrameRateOverImageQuality Sets the video quality preference: + - true: Frame rate over image quality. + - false: (Default) Image quality over frame rate. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setVideoQualityParameters(bool preferFrameRateOverImageQuality) = 0; - /** Sets the fallback option for the published video stream based on the network conditions. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setVideoQualityParameters(bool preferFrameRateOverImageQuality) = 0; + /** Sets the fallback option for the published video stream based on the network conditions. - If `option` is set as #STREAM_FALLBACK_OPTION_AUDIO_ONLY (2), the SDK will: + If `option` is set as #STREAM_FALLBACK_OPTION_AUDIO_ONLY (2), the SDK will: - - Disable the upstream video but enable audio only when the network conditions deteriorate and cannot support both video and audio. - - Re-enable the video when the network conditions improve. + - Disable the upstream video but enable audio only when the network conditions deteriorate and cannot support both video and audio. + - Re-enable the video when the network conditions improve. - When the published video stream falls back to audio only or when the audio-only stream switches back to the video, the SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onLocalPublishFallbackToAudioOnly "onLocalPublishFallbackToAudioOnly" callback. + When the published video stream falls back to audio only or when the audio-only stream switches back to the video, the SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onLocalPublishFallbackToAudioOnly "onLocalPublishFallbackToAudioOnly" callback. - @note - - Agora does not recommend using this method for CDN live streaming, because the remote CDN live user will have a noticeable lag when the published video stream falls back to audio only. - - Ensure that you call this method before joining a channel. + @note + - Agora does not recommend using this method for CDN live streaming, because the remote CDN live user will have a noticeable lag when the published video stream falls back to audio only. + - Ensure that you call this method before joining a channel. - @param option Sets the fallback option for the published video stream: - - #STREAM_FALLBACK_OPTION_DISABLED (0): (Default) No fallback behavior for the published video stream when the uplink network condition is poor. The stream quality is not guaranteed. - - #STREAM_FALLBACK_OPTION_AUDIO_ONLY (2): The published video stream falls back to audio only when the uplink network condition is poor. + @param option Sets the fallback option for the published video stream: + - #STREAM_FALLBACK_OPTION_DISABLED (0): (Default) No fallback behavior for the published video stream when the uplink network condition is poor. The stream quality is not guaranteed. + - #STREAM_FALLBACK_OPTION_AUDIO_ONLY (2): The published video stream falls back to audio only when the uplink network condition is poor. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setLocalPublishFallbackOption(STREAM_FALLBACK_OPTIONS option) = 0; - /** Sets the fallback option for the remotely subscribed video stream based on the network conditions. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setLocalPublishFallbackOption(STREAM_FALLBACK_OPTIONS option) = 0; + /** Sets the fallback option for the remotely subscribed video stream based on the network conditions. - The default setting for `option` is #STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW (1), where the remotely subscribed video stream falls back to the low-stream video (low resolution and low bitrate) under poor downlink network conditions. + The default setting for `option` is #STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW (1), where the remotely subscribed video stream falls back to the low-stream video (low resolution and low bitrate) under poor downlink network conditions. - If `option` is set as #STREAM_FALLBACK_OPTION_AUDIO_ONLY (2), the SDK automatically switches the video from a high-stream to a low-stream, or disables the video when the downlink network conditions cannot support both audio and video to guarantee the quality of the audio. The SDK monitors the network quality and restores the video stream when the network conditions improve. + If `option` is set as #STREAM_FALLBACK_OPTION_AUDIO_ONLY (2), the SDK automatically switches the video from a high-stream to a low-stream, or disables the video when the downlink network conditions cannot support both audio and video to guarantee the quality of the audio. The SDK monitors the network quality and restores the video stream when the network conditions improve. - When the remotely subscribed video stream falls back to audio only or when the audio-only stream switches back to the video stream, the SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onRemoteSubscribeFallbackToAudioOnly "onRemoteSubscribeFallbackToAudioOnly" callback. + When the remotely subscribed video stream falls back to audio only or when the audio-only stream switches back to the video stream, the SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onRemoteSubscribeFallbackToAudioOnly "onRemoteSubscribeFallbackToAudioOnly" callback. - @note Ensure that you call this method before joining a channel. + @note Ensure that you call this method before joining a channel. - @param option Sets the fallback option for the remotely subscribed video stream. See #STREAM_FALLBACK_OPTIONS. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setRemoteSubscribeFallbackOption(STREAM_FALLBACK_OPTIONS option) = 0; + @param option Sets the fallback option for the remotely subscribed video stream. See #STREAM_FALLBACK_OPTIONS. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setRemoteSubscribeFallbackOption(STREAM_FALLBACK_OPTIONS option) = 0; #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) - /** Switches between front and rear cameras. - - @note - - This method is for Android and iOS only. - - Ensure that you call this method after the camera starts, for example, by - calling \ref IRtcEngine::startPreview "startPreview" or \ref IRtcEngine::joinChannel "joinChannel". + /** Switches between front and rear cameras. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int switchCamera() = 0; - /// @cond - /** Switches between front and rear cameras. - - @note This method is for Android and iOS only. - @note This method is private. + @note + - This method is for Android and iOS only. + - Ensure that you call this method after the camera starts, for example, by + calling \ref IRtcEngine::startPreview "startPreview" or \ref IRtcEngine::joinChannel "joinChannel". - @param direction Sets the camera to be used: - - CAMERA_DIRECTION.CAMERA_REAR: Use the rear camera. - - CAMERA_DIRECTION.CAMERA_FRONT: Use the front camera. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int switchCamera(CAMERA_DIRECTION direction) = 0; - /// @endcond - /** Sets the default audio playback route. - - This method sets whether the received audio is routed to the earpiece or speakerphone by default before joining a channel. - If a user does not call this method, the audio is routed to the earpiece by default. If you need to change the default audio route after joining a channel, call the \ref IRtcEngine::setEnableSpeakerphone "setEnableSpeakerphone" method. - - The default setting for each profile: - - `COMMUNICATION`: In a voice call, the default audio route is the earpiece. In a video call, the default audio route is the speakerphone. If a user who is in the `COMMUNICATION` profile calls - the \ref IRtcEngine.disableVideo "disableVideo" method or if the user calls - the \ref IRtcEngine.muteLocalVideoStream "muteLocalVideoStream" and - \ref IRtcEngine.muteAllRemoteVideoStreams "muteAllRemoteVideoStreams" methods, the - default audio route switches back to the earpiece automatically. - - `LIVE_BROADCASTING`: Speakerphone. - - @note - - This method is for Android and iOS only. - - This method is applicable only to the `COMMUNICATION` profile. - - For iOS, this method only works in a voice call. - - Call this method before calling the \ref IRtcEngine::joinChannel "joinChannel" method. - - @param defaultToSpeaker Sets the default audio route: - - true: Route the audio to the speakerphone. If the playback device connects to the earpiece or Bluetooth, the audio cannot be routed to the speakerphone. - - false: (Default) Route the audio to the earpiece. If a headset is plugged in, the audio is routed to the headset. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker) = 0; - /** Enables/Disables the audio playback route to the speakerphone. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int switchCamera() = 0; + /// @cond + /** Switches between front and rear cameras. - This method sets whether the audio is routed to the speakerphone or earpiece. + @note This method is for Android and iOS only. + @note This method is private. - See the default audio route explanation in the \ref IRtcEngine::setDefaultAudioRouteToSpeakerphone "setDefaultAudioRouteToSpeakerphone" method and check whether it is necessary to call this method. + @param direction Sets the camera to be used: + - CAMERA_DIRECTION.CAMERA_REAR: Use the rear camera. + - CAMERA_DIRECTION.CAMERA_FRONT: Use the front camera. - @note - - This method is for Android and iOS only. - - Ensure that you have successfully called the \ref IRtcEngine::joinChannel "joinChannel" method before calling this method. - - After calling this method, the SDK returns the \ref IRtcEngineEventHandler::onAudioRouteChanged "onAudioRouteChanged" callback to indicate the changes. - - This method does not take effect if a headset is used. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int switchCamera(CAMERA_DIRECTION direction) = 0; + /// @endcond + /** Sets the default audio playback route. + + This method sets whether the received audio is routed to the earpiece or speakerphone by default before joining a channel. + If a user does not call this method, the audio is routed to the earpiece by default. If you need to change the default audio route after joining a channel, call the \ref IRtcEngine::setEnableSpeakerphone "setEnableSpeakerphone" method. + + The default setting for each profile: + - `COMMUNICATION`: In a voice call, the default audio route is the earpiece. In a video call, the default audio route is the speakerphone. If a user who is in the `COMMUNICATION` profile calls + the \ref IRtcEngine.disableVideo "disableVideo" method or if the user calls + the \ref IRtcEngine.muteLocalVideoStream "muteLocalVideoStream" and + \ref IRtcEngine.muteAllRemoteVideoStreams "muteAllRemoteVideoStreams" methods, the + default audio route switches back to the earpiece automatically. + - `LIVE_BROADCASTING`: Speakerphone. + + @note + - This method is for Android and iOS only. + - This method is applicable only to the `COMMUNICATION` profile. + - For iOS, this method only works in a voice call. + - Call this method before calling the \ref IRtcEngine::joinChannel "joinChannel" method. + + @param defaultToSpeaker Sets the default audio route: + - true: Route the audio to the speakerphone. If the playback device connects to the earpiece or Bluetooth, the audio cannot be routed to the speakerphone. + - false: (Default) Route the audio to the earpiece. If a headset is plugged in, the audio is routed to the headset. - @param speakerOn Sets whether to route the audio to the speakerphone or earpiece: - - true: Route the audio to the speakerphone. If the playback device connects to the earpiece or Bluetooth, the audio cannot be routed to the speakerphone. - - false: Route the audio to the earpiece. If a headset is plugged in, the audio is routed to the headset. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker) = 0; + /** Enables/Disables the audio playback route to the speakerphone. + + This method sets whether the audio is routed to the speakerphone or earpiece. + + See the default audio route explanation in the \ref IRtcEngine::setDefaultAudioRouteToSpeakerphone "setDefaultAudioRouteToSpeakerphone" method and check whether it is necessary to call this method. + + @note + - This method is for Android and iOS only. + - Ensure that you have successfully called the \ref IRtcEngine::joinChannel "joinChannel" method before calling this method. + - After calling this method, the SDK returns the \ref IRtcEngineEventHandler::onAudioRouteChanged "onAudioRouteChanged" callback to indicate the changes. + - This method does not take effect if a headset is used. + - Settings of \ref IRtcEngine::setAudioProfile "setAudioProfile" and \ref IRtcEngine::setChannelProfile "setChannelProfile" affect the call + result of `setEnableSpeakerphone`. The following are scenarios where `setEnableSpeakerphone` does not take effect: + - If you set `scenario` as `AUDIO_SCENARIO_GAME_STREAMING`, no user can change the audio playback route. + - If you set `scenario` as `AUDIO_SCENARIO_DEFAULT` or `AUDIO_SCENARIO_SHOWROOM`, the audience cannot change + the audio playback route. If there is only one broadcaster is in the channel, the broadcaster cannot change + the audio playback route either. + - If you set `scenario` as `AUDIO_SCENARIO_EDUCATION`, the audience cannot change the audio playback route. + + @param speakerOn Sets whether to route the audio to the speakerphone or earpiece: + - true: Route the audio to the speakerphone. If the playback device connects to the headset or Bluetooth, the audio cannot be routed to the speakerphone. + - false: Route the audio to the earpiece. If a headset is plugged in, the audio is routed to the headset. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setEnableSpeakerphone(bool speakerOn) = 0; - /** Enables in-ear monitoring (for Android and iOS only). - * - * @note - * - Users must use wired earphones to hear their own voices. - * - You can call this method either before or after joining a channel. - * - * @param enabled Determines whether to enable in-ear monitoring. - * - true: Enable. - * - false: (Default) Disable. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int enableInEarMonitoring(bool enabled) = 0; - /** Sets the volume of the in-ear monitor. - * - * @note - * - This method is for Android and iOS only. - * - Users must use wired earphones to hear their own voices. - * - You can call this method either before or after joining a channel. - * - * @param volume Sets the volume of the in-ear monitor. The value ranges between 0 and 100 (default). - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int setInEarMonitoringVolume(int volume) = 0; - /** Checks whether the speakerphone is enabled. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setEnableSpeakerphone(bool speakerOn) = 0; + /** Enables in-ear monitoring (for Android and iOS only). + * + * @note + * - Users must use wired earphones to hear their own voices. + * - You can call this method either before or after joining a channel. + * + * @param enabled Determines whether to enable in-ear monitoring. + * - true: Enable. + * - false: (Default) Disable. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int enableInEarMonitoring(bool enabled) = 0; + /** Sets the volume of the in-ear monitor. + * + * @note + * - This method is for Android and iOS only. + * - Users must use wired earphones to hear their own voices. + * - You can call this method either before or after joining a channel. + * + * @param volume Sets the volume of the in-ear monitor. The value ranges between 0 and 100 (default). + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setInEarMonitoringVolume(int volume) = 0; + /** Checks whether the speakerphone is enabled. - @note - - This method is for Android and iOS only. - - You can call this method either before or after joining a channel. + @note + - This method is for Android and iOS only. + - You can call this method either before or after joining a channel. - @return - - 0: Success. - - < 0: Failure. - */ - virtual bool isSpeakerphoneEnabled() = 0; + @return + - true: The speakerphone is enabled, and the audio plays from the speakerphone. + - false: The speakerphone is not enabled, and the audio plays from devices other than the speakerphone. For example, the headset or earpiece. + */ + virtual bool isSpeakerphoneEnabled() = 0; #endif #if (defined(__APPLE__) && TARGET_OS_IOS) - /** Sets the audio session’s operational restriction. - - The SDK and the app can both configure the audio session by default. The app may occasionally use other apps or third-party components to manipulate the audio session and restrict the SDK from doing so. This method allows the app to restrict the SDK’s manipulation of the audio session. - - You can call this method at any time to return the control of the audio sessions to the SDK. - - @note - - This method is for iOS only. - - This method restricts the SDK’s manipulation of the audio session. Any operation to the audio session relies solely on the app, other apps, or third-party components. - - You can call this method either before or after joining a channel. - - @param restriction The operational restriction (bit mask) of the SDK on the audio session. See #AUDIO_SESSION_OPERATION_RESTRICTION. - - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setAudioSessionOperationRestriction(AUDIO_SESSION_OPERATION_RESTRICTION restriction) = 0; + /** Sets the operational permission of the SDK on the audio session. + * + * The SDK and the app can both configure the audio session by default. If + * you need to only use the app to configure the audio session, this method + * restricts the operational permission of the SDK on the audio session. + * + * You can call this method either before or after joining a channel. Once + * you call this method to restrict the operational permission of the SDK + * on the audio session, the restriction takes effect when the SDK needs to + * change the audio session. + * + * @note + * - This method is for iOS only. + * - This method does not restrict the operational permission of the app on + * the audio session. + * + * @param restriction The operational permission of the SDK on the audio session. + * See #AUDIO_SESSION_OPERATION_RESTRICTION. This parameter is in bit mask + * format, and each bit corresponds to a permission. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int setAudioSessionOperationRestriction(AUDIO_SESSION_OPERATION_RESTRICTION restriction) = 0; #endif #if (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE) || defined(_WIN32) - /** Enables loopback recording. + /** Enables loopback audio capturing. - If you enable loopback recording, the output of the sound card is mixed into the audio stream sent to the other end. + If you enable loopback audio capturing, the output of the sound card is mixed into the audio stream sent to the other end. - @note You can call this method either before or after joining a channel. + @note You can call this method either before or after joining a channel. - @param enabled Sets whether to enable/disable loopback recording. - - true: Enable loopback recording. - - false: (Default) Disable loopback recording. - @param deviceName Pointer to the device name of the sound card. The default value is NULL (the default sound card). + @param enabled Sets whether to enable/disable loopback capturing. + - true: Enable loopback capturing. + - false: (Default) Disable loopback capturing. + @param deviceName Pointer to the device name of the sound card. The default value is NULL (the default sound card). - @note - - This method is for macOS and Windows only. - - macOS does not support loopback recording of the default sound card. If you need to use this method, please use a virtual sound card and pass its name to the deviceName parameter. Agora has tested and recommends using soundflower. + @note + - This method is for macOS and Windows only. + - macOS does not support loopback capturing of the default sound card. If you need to use this method, please use a virtual sound card and pass its name to the deviceName parameter. Agora has tested and recommends using soundflower. - */ - virtual int enableLoopbackRecording(bool enabled, const char* deviceName = NULL) = 0; + */ + virtual int enableLoopbackRecording(bool enabled, const char* deviceName = NULL) = 0; #if (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE) - /** Shares the whole or part of a screen by specifying the display ID. - * - * @note - * - This method is for macOS only. - * - Ensure that you call this method after joining a channel. - * - * @param displayId The display ID of the screen to be shared. This parameter specifies which screen you want to share. - * @param regionRect (Optional) Sets the relative location of the region to the screen. NIL means sharing the whole screen. See Rectangle. If the specified region overruns the screen, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen. - * @param captureParams Sets the screen sharing encoding parameters. See ScreenCaptureParameters. - * - * - * @return - * - 0: Success. - * - < 0: Failure: - * - #ERR_INVALID_STATE: the screen sharing state is invalid, probably because another screen or window is being - * shared. Call \ref IRtcEngine::stopScreenCapture "stopScreenCapture" to stop the current screen sharing. - * - #ERR_INVALID_ARGUMENT: the argument is invalid. - */ - virtual int startScreenCaptureByDisplayId(unsigned int displayId, const Rectangle& regionRect, const ScreenCaptureParameters& captureParams) = 0; + /** Shares the whole or part of a screen by specifying the display ID. + * + * @note + * - This method is for macOS only. + * - Ensure that you call this method after joining a channel. + * + * @param displayId The display ID of the screen to be shared. This parameter specifies which screen you want to share. + * @param regionRect (Optional) Sets the relative location of the region to the screen. NIL means sharing the whole screen. See Rectangle. If the specified region overruns the screen, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen. + * @param captureParams The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of `videoDimension` to calculate the charges. + * For details, see descriptions in ScreenCaptureParameters. + * + * + * @return + * - 0: Success. + * - < 0: Failure: + * - #ERR_INVALID_ARGUMENT: The argument is invalid. + */ + virtual int startScreenCaptureByDisplayId(unsigned int displayId, const Rectangle& regionRect, const ScreenCaptureParameters& captureParams) = 0; #endif #if defined(_WIN32) - /** Shares the whole or part of a screen by specifying the screen rect. - * - * @note - * - Ensure that you call this method after joining a channel. - * - Applies to the Windows platform only. - * - * @param screenRect Sets the relative location of the screen to the virtual screen. For information on how to get screenRect, see the advanced guide *Share Screen*. - * @param regionRect (Optional) Sets the relative location of the region to the screen. NULL means sharing the whole screen. See Rectangle. If the specified region overruns the screen, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen. - * @param captureParams Sets the screen sharing encoding parameters. See ScreenCaptureParameters. - * - * @return - * - 0: Success. - * - < 0: Failure: - * - #ERR_INVALID_STATE: the screen sharing state is invalid, probably because another screen or window is being - * shared. Call \ref IRtcEngine::stopScreenCapture "stopScreenCapture" to stop the current screen sharing. - * - #ERR_INVALID_ARGUMENT : the argument is invalid. - */ - virtual int startScreenCaptureByScreenRect(const Rectangle& screenRect, const Rectangle& regionRect, const ScreenCaptureParameters& captureParams) = 0; + /** Shares the whole or part of a screen by specifying the screen rect. + * + * @note + * - Ensure that you call this method after joining a channel. + * - Applies to the Windows platform only. + * + * @param screenRect Sets the relative location of the screen to the virtual screen. For information on how to get screenRect, see the advanced guide *Share Screen*. + * @param regionRect (Optional) Sets the relative location of the region to the screen. NULL means sharing the whole screen. See Rectangle. If the specified region overruns the screen, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen. + * @param captureParams The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. + * Agora uses the value of `videoDimension` to calculate the charges. For details, see descriptions in ScreenCaptureParameters. + * + * @return + * - 0: Success. + * - < 0: Failure: + * - #ERR_INVALID_ARGUMENT : The argument is invalid. + */ + virtual int startScreenCaptureByScreenRect(const Rectangle& screenRect, const Rectangle& regionRect, const ScreenCaptureParameters& captureParams) = 0; #endif - /** Shares the whole or part of a window by specifying the window ID. - * - * @note - * - Ensure that you call this method after joining a channel. - * - Applies to the macOS and Windows platforms only. - * - * Since v3.0.0, this method supports window sharing of UWP (Universal Windows Platform) applications. - * - * Agora tests the mainstream UWP applications by using the lastest SDK, see details as follows: - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
OS versionSoftwareSoftware nameWhether support
win10Chrome76.0.3809.100No
Office Word18.1903.1152.0Yes
Office ExcelNo
Office PPTYes
WPS Word11.1.0.9145Yes
WPS Excel
WPS PPT
Media Player (come with the system)AllYes
win8ChromeAllYes
Office WordAllYes
Office Excel
Office PPT
WPS Word11.1.0.9098Yes
WPS Excel
WPS PPT
Media Player(come with the system)AllYes
win7Chrome73.0.3683.103No
Office WordAllYes
Office Excel
Office PPT
WPS Word11.1.0.9098No
WPS Excel
WPS PPT11.1.0.9098Yes
Media Player(come with the system)AllNo
- * @param windowId The ID of the window to be shared. For information on how to get the windowId, see the advanced guide *Share Screen*. - * @param regionRect (Optional) The relative location of the region to the window. NULL/NIL means sharing the whole window. See Rectangle. If the specified region overruns the window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole window. - * @param captureParams Window sharing encoding parameters. See ScreenCaptureParameters. - * - * @return - * - 0: Success. - * - < 0: Failure: - * - #ERR_INVALID_STATE: the screen sharing state is invalid, probably because another screen or window is being - * shared. Call \ref IRtcEngine::stopScreenCapture "stopScreenCapture" to stop the current screen sharing. - * - #ERR_INVALID_ARGUMENT: the argument is invalid. - */ - virtual int startScreenCaptureByWindowId(view_t windowId, const Rectangle& regionRect, const ScreenCaptureParameters& captureParams) = 0; + /** Shares the whole or part of a window by specifying the window ID. + * + * @note + * - Ensure that you call this method after joining a channel. + * - Applies to the macOS and Windows platforms only. + * + * Since v3.0.0, this method supports window sharing of UWP (Universal Windows Platform) applications. + * + * Agora tests the mainstream UWP applications by using the lastest SDK, see details as follows: + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
OS versionSoftwareSoftware nameWhether support
win10Chrome76.0.3809.100No
Office Word18.1903.1152.0Yes
Office ExcelNo
Office PPTYes
WPS Word11.1.0.9145Yes
WPS Excel
WPS PPT
Media Player (come with the system)AllYes
win8ChromeAllYes
Office WordAllYes
Office Excel
Office PPT
WPS Word11.1.0.9098Yes
WPS Excel
WPS PPT
Media Player(come with the system)AllYes
win7Chrome73.0.3683.103No
Office WordAllYes
Office Excel
Office PPT
WPS Word11.1.0.9098No
WPS Excel
WPS PPT11.1.0.9098Yes
Media Player(come with the system)AllNo
+ * @param windowId The ID of the window to be shared. For information on how to get the windowId, see the advanced guide *Share Screen*. + * @param regionRect (Optional) The relative location of the region to the window. NULL/NIL means sharing the whole window. See Rectangle. If the specified region overruns the window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole window. + * @param captureParams The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of `videoDimension` to calculate the charges. For details, see descriptions in ScreenCaptureParameters. + * + * @return + * - 0: Success. + * - < 0: Failure: + * - #ERR_INVALID_ARGUMENT: The argument is invalid. + */ + virtual int startScreenCaptureByWindowId(view_t windowId, const Rectangle& regionRect, const ScreenCaptureParameters& captureParams) = 0; - /** Sets the content hint for screen sharing. + /** Sets the content hint for screen sharing. - A content hint suggests the type of the content being shared, so that the SDK applies different optimization algorithm to different types of content. + A content hint suggests the type of the content being shared, so that the SDK applies different optimization algorithm to different types of content. - @note You can call this method either before or after you start screen sharing. + @note You can call this method either before or after you start screen sharing. - @param contentHint Sets the content hint for screen sharing. See VideoContentHint. + @param contentHint Sets the content hint for screen sharing. See VideoContentHint. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setScreenCaptureContentHint(VideoContentHint contentHint) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setScreenCaptureContentHint(VideoContentHint contentHint) = 0; - /** Updates the screen sharing parameters. + /** Updates the screen sharing parameters. - @param captureParams Sets the screen sharing encoding parameters. See ScreenCaptureParameters. + @param captureParams The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, + 2,073,600 pixels. Agora uses the value of `videoDimension` to calculate the charges. For details, + see descriptions in ScreenCaptureParameters. - @return - - 0: Success. - - < 0: Failure: - - #ERR_NOT_READY: no screen or windows is being shared. - */ - virtual int updateScreenCaptureParameters(const ScreenCaptureParameters& captureParams) = 0; + @return + - 0: Success. + - < 0: Failure: + - #ERR_NOT_READY: no screen or windows is being shared. + */ + virtual int updateScreenCaptureParameters(const ScreenCaptureParameters& captureParams) = 0; - /** Updates the screen sharing region. + /** Updates the screen sharing region. - @param regionRect Sets the relative location of the region to the screen or window. NULL means sharing the whole screen or window. See Rectangle. If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window. + @param regionRect Sets the relative location of the region to the screen or window. NULL means sharing the whole screen or window. See Rectangle. If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window. - @return - - 0: Success. - - < 0: Failure: - - #ERR_NOT_READY: no screen or window is being shared. - */ - virtual int updateScreenCaptureRegion(const Rectangle& regionRect) = 0; + @return + - 0: Success. + - < 0: Failure: + - #ERR_NOT_READY: no screen or window is being shared. + */ + virtual int updateScreenCaptureRegion(const Rectangle& regionRect) = 0; - /** Stop screen sharing. + /** Stop screen sharing. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int stopScreenCapture() = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int stopScreenCapture() = 0; #if defined(__APPLE__) - typedef unsigned int WindowIDType; + typedef unsigned int WindowIDType; #elif defined(_WIN32) - typedef HWND WindowIDType; + typedef HWND WindowIDType; #endif - /** **DEPRECATED** Starts screen sharing. + /** **DEPRECATED** Starts screen sharing. - This method is deprecated as of v2.4.0. See the following methods instead: + This method is deprecated as of v2.4.0. See the following methods instead: - - \ref agora::rtc::IRtcEngine::startScreenCaptureByDisplayId "startScreenCaptureByDisplayId" - - \ref agora::rtc::IRtcEngine::startScreenCaptureByScreenRect "startScreenCaptureByScreenRect" - - \ref agora::rtc::IRtcEngine::startScreenCaptureByWindowId "startScreenCaptureByWindowId" + - \ref agora::rtc::IRtcEngine::startScreenCaptureByDisplayId "startScreenCaptureByDisplayId" + - \ref agora::rtc::IRtcEngine::startScreenCaptureByScreenRect "startScreenCaptureByScreenRect" + - \ref agora::rtc::IRtcEngine::startScreenCaptureByWindowId "startScreenCaptureByWindowId" - This method shares the whole screen, specified window, or specified region: + This method shares the whole screen, specified window, or specified region: - - Whole screen: Set @p windowId as 0 and @p rect as NULL. - - Specified window: Set @p windowId as a value other than 0. Each window has a @p windowId that is not 0. - - Specified region: Set @p windowId as 0 and @p rect not as NULL. In this case, you can share the specified region, for example by dragging the mouse or implementing your own logic. + - Whole screen: Set @p windowId as 0 and @p rect as NULL. + - Specified window: Set @p windowId as a value other than 0. Each window has a @p windowId that is not 0. + - Specified region: Set @p windowId as 0 and @p rect not as NULL. In this case, you can share the specified region, for example by dragging the mouse or implementing your own logic. - @note The specified region is a region on the whole screen. Currently, sharing a specified region in a specific window is not supported. - *captureFreq* is the captured frame rate once the screen-sharing function is enabled. The mandatory value ranges between 1 fps and 15 fps. + @note The specified region is a region on the whole screen. Currently, sharing a specified region in a specific window is not supported. + *captureFreq* is the captured frame rate once the screen-sharing function is enabled. The mandatory value ranges between 1 fps and 15 fps. - @param windowId Sets the screen sharing area. See WindowIDType. - @param captureFreq (Mandatory) The captured frame rate. The value ranges between 1 fps and 15 fps. - @param rect Specifies the screen-sharing region. @p rect is valid when @p windowsId is set as 0. When @p rect is set as NULL, the whole screen is shared. - @param bitrate The captured bitrate. + @param windowId Sets the screen sharing area. See WindowIDType. + @param captureFreq (Mandatory) The captured frame rate. The value ranges between 1 fps and 15 fps. + @param rect Specifies the screen-sharing region. @p rect is valid when @p windowsId is set as 0. When @p rect is set as NULL, the whole screen is shared. + @param bitrate The captured bitrate. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int startScreenCapture(WindowIDType windowId, int captureFreq, const Rect *rect, int bitrate) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int startScreenCapture(WindowIDType windowId, int captureFreq, const Rect* rect, int bitrate) = 0; - /** **DEPRECATED** Updates the screen capture region. + /** **DEPRECATED** Updates the screen capture region. - @param rect Specifies the required region inside the screen or window. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int updateScreenCaptureRegion(const Rect *rect) = 0; + @param rect Specifies the required region inside the screen or window. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int updateScreenCaptureRegion(const Rect* rect) = 0; #endif #if defined(_WIN32) - /** Sets a custom video source. - * - * During real-time communication, the Agora SDK enables the default video input device, that is, the built-in camera to - * capture video. If you need a custom video source, implement the IVideoSource class first, and call this method to add - * the custom video source to the SDK. - * - * @note You can call this method either before or after joining a channel. - * - * @param source The custom video source. See IVideoSource. - * - * @return - * - true: The custom video source is added to the SDK. - * - false: The custom video source is not added to the SDK. - */ - virtual bool setVideoSource(IVideoSource *source) = 0; + /** Sets a custom video source. + * + * During real-time communication, the Agora SDK enables the default video input device, that is, the built-in camera to + * capture video. If you need a custom video source, implement the IVideoSource class first, and call this method to add + * the custom video source to the SDK. + * + * @note You can call this method either before or after joining a channel. + * + * @param source The custom video source. See IVideoSource. + * + * @return + * - true: The custom video source is added to the SDK. + * - false: The custom video source is not added to the SDK. + */ + virtual bool setVideoSource(IVideoSource* source) = 0; #endif - /** Retrieves the current call ID. + /** Gets the current call ID. - When a user joins a channel on a client, a @p callId is generated to identify the call from the client. Feedback methods, such as \ref IRtcEngine::rate "rate" and \ref IRtcEngine::complain "complain", must be called after the call ends to submit feedback to the SDK. + When a user joins a channel on a client, a @p callId is generated to identify the call from the client. Feedback methods, such as \ref IRtcEngine::rate "rate" and \ref IRtcEngine::complain "complain", must be called after the call ends to submit feedback to the SDK. - The \ref IRtcEngine::rate "rate" and \ref IRtcEngine::complain "complain" methods require the @p callId parameter retrieved from the *getCallId* method during a call. @p callId is passed as an argument into the \ref IRtcEngine::rate "rate" and \ref IRtcEngine::complain "complain" methods after the call ends. + The \ref IRtcEngine::rate "rate" and \ref IRtcEngine::complain "complain" methods require the @p callId parameter retrieved from the *getCallId* method during a call. @p callId is passed as an argument into the \ref IRtcEngine::rate "rate" and \ref IRtcEngine::complain "complain" methods after the call ends. - @note Ensure that you call this method after joining a channel. + @note Ensure that you call this method after joining a channel. - @param callId Pointer to the current call ID. + @param callId Pointer to the current call ID. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getCallId(agora::util::AString& callId) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getCallId(agora::util::AString& callId) = 0; - /** Allows a user to rate a call after the call ends. + /** Allows a user to rate a call after the call ends. - @note Ensure that you call this method after joining a channel. + @note Ensure that you call this method after joining a channel. - @param callId Pointer to the ID of the call, retrieved from the \ref IRtcEngine::getCallId "getCallId" method. - @param rating Rating of the call. The value is between 1 (lowest score) and 5 (highest score). If you set a value out of this range, the #ERR_INVALID_ARGUMENT (2) error returns. - @param description (Optional) Pointer to the description of the rating, with a string length of less than 800 bytes. + @param callId Pointer to the ID of the call, retrieved from the \ref IRtcEngine::getCallId "getCallId" method. + @param rating Rating of the call. The value is between 1 (lowest score) and 5 (highest score). If you set a value out of this range, the #ERR_INVALID_ARGUMENT (2) error returns. + @param description (Optional) Pointer to the description of the rating, with a string length of less than 800 bytes. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int rate(const char* callId, int rating, const char* description) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int rate(const char* callId, int rating, const char* description) = 0; - /** Allows a user to complain about the call quality after a call ends. + /** Allows a user to complain about the call quality after a call ends. - @note Ensure that you call this method after joining a channel. + @note Ensure that you call this method after joining a channel. - @param callId Pointer to the ID of the call, retrieved from the \ref IRtcEngine::getCallId "getCallId" method. - @param description (Optional) Pointer to the description of the complaint, with a string length of less than 800 bytes. + @param callId Pointer to the ID of the call, retrieved from the \ref IRtcEngine::getCallId "getCallId" method. + @param description (Optional) Pointer to the description of the complaint, with a string length of less than 800 bytes. - @return - - 0: Success. - - < 0: Failure. + @return + - 0: Success. + - < 0: Failure. - */ - virtual int complain(const char* callId, const char* description) = 0; + */ + virtual int complain(const char* callId, const char* description) = 0; - /** Retrieves the SDK version number. + /** Gets the SDK version number. - @param build Pointer to the build number. - @return The version of the current SDK in the string format. For example, 2.3.1. - */ - virtual const char* getVersion(int* build) = 0; + @param build Pointer to the build number. + @return The version of the current SDK in the string format. For example, 2.3.1. + */ + virtual const char* getVersion(int* build) = 0; - /** Enables the network connection quality test. + /** Enables the network connection quality test. - This method tests the quality of the users' network connections and is disabled by default. + This method tests the quality of the users' network connections and is disabled by default. - Before a user joins a channel or before an audience switches to a host, call this method to check the uplink network quality. + Before a user joins a channel or before an audience switches to a host, call this method to check the uplink network quality. - This method consumes additional network traffic, and hence may affect communication quality. + This method consumes additional network traffic, and hence may affect communication quality. - Call the \ref IRtcEngine::disableLastmileTest "disableLastmileTest" method to disable this test after receiving the \ref IRtcEngineEventHandler::onLastmileQuality "onLastmileQuality" callback, and before joining a channel. + Call the \ref IRtcEngine::disableLastmileTest "disableLastmileTest" method to disable this test after receiving the \ref IRtcEngineEventHandler::onLastmileQuality "onLastmileQuality" callback, and before joining a channel. - @note - - Do not call any other methods before receiving the \ref IRtcEngineEventHandler::onLastmileQuality "onLastmileQuality" callback. Otherwise, the callback may be interrupted by other methods, and hence may not be triggered. - - A host should not call this method after joining a channel (when in a call). - - If you call this method to test the last-mile quality, the SDK consumes the bandwidth of a video stream, whose bitrate corresponds to the bitrate you set in the \ref agora::rtc::IRtcEngine::setVideoEncoderConfiguration "setVideoEncoderConfiguration" method. After you join the channel, whether you have called the `disableLastmileTest` method or not, the SDK automatically stops consuming the bandwidth. + @note + - Do not call any other methods before receiving the \ref IRtcEngineEventHandler::onLastmileQuality "onLastmileQuality" callback. Otherwise, the callback may be interrupted by other methods, and hence may not be triggered. + - A host should not call this method after joining a channel (when in a call). + - If you call this method to test the last mile network quality, the SDK consumes the bandwidth of a video stream, whose bitrate corresponds to the bitrate you set in the \ref agora::rtc::IRtcEngine::setVideoEncoderConfiguration "setVideoEncoderConfiguration" method. After you join the channel, whether you have called the `disableLastmileTest` method or not, the SDK automatically stops consuming the bandwidth. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int enableLastmileTest() = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int enableLastmileTest() = 0; - /** Disables the network connection quality test. + /** Disables the network connection quality test. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int disableLastmileTest() = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int disableLastmileTest() = 0; - /** Starts the last-mile network probe test. + /** Starts the last-mile network probe test. - This method starts the last-mile network probe test before joining a channel to get the uplink and downlink last-mile network statistics, including the bandwidth, packet loss, jitter, and round-trip time (RTT). + This method starts the last-mile network probe test before joining a channel to get the uplink and downlink last mile network statistics, including the bandwidth, packet loss, jitter, and round-trip time (RTT). - Call this method to check the uplink network quality before users join a channel or before an audience switches to a host. - Once this method is enabled, the SDK returns the following callbacks: - - \ref IRtcEngineEventHandler::onLastmileQuality "onLastmileQuality": the SDK triggers this callback within two seconds depending on the network conditions. This callback rates the network conditions and is more closely linked to the user experience. - - \ref IRtcEngineEventHandler::onLastmileProbeResult "onLastmileProbeResult": the SDK triggers this callback within 30 seconds depending on the network conditions. This callback returns the real-time statistics of the network conditions and is more objective. + Call this method to check the uplink network quality before users join a channel or before an audience switches to a host. + Once this method is enabled, the SDK returns the following callbacks: + - \ref IRtcEngineEventHandler::onLastmileQuality "onLastmileQuality": the SDK triggers this callback within two seconds depending on the network conditions. This callback rates the network conditions and is more closely linked to the user experience. + - \ref IRtcEngineEventHandler::onLastmileProbeResult "onLastmileProbeResult": the SDK triggers this callback within 30 seconds depending on the network conditions. This callback returns the real-time statistics of the network conditions and is more objective. - @note - - This method consumes extra network traffic and may affect communication quality. We do not recommend calling this method together with enableLastmileTest. - - Do not call other methods before receiving the \ref IRtcEngineEventHandler::onLastmileQuality "onLastmileQuality" and \ref IRtcEngineEventHandler::onLastmileProbeResult "onLastmileProbeResult" callbacks. Otherwise, the callbacks may be interrupted. - - In the `LIVE_BROADCASTING` profile, a host should not call this method after joining a channel. + @note + - This method consumes extra network traffic and may affect communication quality. We do not recommend calling this method together with enableLastmileTest. + - Do not call other methods before receiving the \ref IRtcEngineEventHandler::onLastmileQuality "onLastmileQuality" and \ref IRtcEngineEventHandler::onLastmileProbeResult "onLastmileProbeResult" callbacks. Otherwise, the callbacks may be interrupted. + - In the `LIVE_BROADCASTING` profile, a host should not call this method after joining a channel. - @param config Sets the configurations of the last-mile network probe test. See LastmileProbeConfig. + @param config Sets the configurations of the last-mile network probe test. See LastmileProbeConfig. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int startLastmileProbeTest(const LastmileProbeConfig& config) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int startLastmileProbeTest(const LastmileProbeConfig& config) = 0; - /** Stops the last-mile network probe test. */ - virtual int stopLastmileProbeTest() = 0; + /** Stops the last-mile network probe test. */ + virtual int stopLastmileProbeTest() = 0; - /** Retrieves the warning or error description. + /** Gets the warning or error description. - @param code Warning code or error code returned in the \ref agora::rtc::IRtcEngineEventHandler::onWarning "onWarning" or \ref agora::rtc::IRtcEngineEventHandler::onError "onError" callback. + @param code Warning code or error code returned in the \ref agora::rtc::IRtcEngineEventHandler::onWarning "onWarning" or \ref agora::rtc::IRtcEngineEventHandler::onError "onError" callback. - @return #WARN_CODE_TYPE or #ERROR_CODE_TYPE. - */ - virtual const char* getErrorDescription(int code) = 0; + @return #WARN_CODE_TYPE or #ERROR_CODE_TYPE. + */ + virtual const char* getErrorDescription(int code) = 0; - /** **DEPRECATED** Enables built-in encryption with an encryption password before users join a channel. + /** Enables built-in encryption with an encryption password before users join a channel. - Deprecated as of v3.1.0. Use the \ref agora::rtc::IRtcEngine::enableEncryption "enableEncryption" instead. + @deprecated Deprecated as of v3.1.0. Use the \ref agora::rtc::IRtcEngine::enableEncryption "enableEncryption" instead. - All users in a channel must use the same encryption password. The encryption password is automatically cleared once a user leaves the channel. + All users in a channel must use the same encryption password. The encryption password is automatically cleared once a user leaves the channel. - If an encryption password is not specified, the encryption functionality will be disabled. + If an encryption password is not specified, the encryption functionality will be disabled. - @note - - Do not use this method for CDN live streaming. - - For optimal transmission, ensure that the encrypted data size does not exceed the original data size + 16 bytes. 16 bytes is the maximum padding size for AES encryption. + @note + - Do not use this method for CDN live streaming. + - For optimal transmission, ensure that the encrypted data size does not exceed the original data size + 16 bytes. 16 bytes is the maximum padding size for AES encryption. - @param secret Pointer to the encryption password. + @param secret Pointer to the encryption password. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setEncryptionSecret(const char* secret) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setEncryptionSecret(const char* secret) = 0; - /** **DEPRECATED** Sets the built-in encryption mode. + /** Sets the built-in encryption mode. - @deprecated Deprecated as of v3.1.0. Use the \ref agora::rtc::IRtcEngine::enableEncryption "enableEncryption" instead. + @deprecated Deprecated as of v3.1.0. Use the \ref agora::rtc::IRtcEngine::enableEncryption "enableEncryption" instead. - The Agora SDK supports built-in encryption, which is set to the @p aes-128-xts mode by default. Call this method to use other encryption modes. + The Agora SDK supports built-in encryption, which is set to the @p aes-128-xts mode by default. Call this method to use other encryption modes. - All users in the same channel must use the same encryption mode and password. + All users in the same channel must use the same encryption mode and password. - Refer to the information related to the AES encryption algorithm on the differences between the encryption modes. + Refer to the information related to the AES encryption algorithm on the differences between the encryption modes. - @note Call the \ref IRtcEngine::setEncryptionSecret "setEncryptionSecret" method to enable the built-in encryption function before calling this method. + @note Call the \ref IRtcEngine::setEncryptionSecret "setEncryptionSecret" method to enable the built-in encryption function before calling this method. - @param encryptionMode Pointer to the set encryption mode: - - "aes-128-xts": (Default) 128-bit AES encryption, XTS mode. - - "aes-128-ecb": 128-bit AES encryption, ECB mode. - - "aes-256-xts": 256-bit AES encryption, XTS mode. - - "": When encryptionMode is set as NULL, the encryption mode is set as "aes-128-xts" by default. + @param encryptionMode Pointer to the set encryption mode: + - "aes-128-xts": (Default) 128-bit AES encryption, XTS mode. + - "aes-128-ecb": 128-bit AES encryption, ECB mode. + - "aes-256-xts": 256-bit AES encryption, XTS mode. + - "": When encryptionMode is set as NULL, the encryption mode is set as "aes-128-xts" by default. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setEncryptionMode(const char* encryptionMode) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setEncryptionMode(const char* encryptionMode) = 0; - /** Enables/Disables the built-in encryption. - * - * @since v3.1.0 - * - * In scenarios requiring high security, Agora recommends calling this method to enable the built-in encryption before joining a channel. - * - * All users in the same channel must use the same encryption mode and encryption key. Once all users leave the channel, the encryption key of this channel is automatically cleared. - * - * @note - * - If you enable the built-in encryption, you cannot use the RTMP streaming function. - * - Agora supports four encryption modes. If you choose an encryption mode (excepting `SM4_128_ECB` mode), you need to add an external encryption library when integrating the Android and iOS SDK. See the advanced guide *Channel Encryption*. - * - * @param enabled Whether to enable the built-in encryption: - * - true: Enable the built-in encryption. - * - false: Disable the built-in encryption. - * @param config Configurations of built-in encryption schemas. See EncryptionConfig. - * - * @return - * - 0: Success. - * - < 0: Failure. - * - -2(ERR_INVALID_ARGUMENT): An invalid parameter is used. Set the parameter with a valid value. - * - -4(ERR_NOT_SUPPORTED): The encryption mode is incorrect or the SDK fails to load the external encryption library. Check the enumeration or reload the external encryption library. - * - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. Initialize the `IRtcEngine` instance before calling this method. - */ - virtual int enableEncryption(bool enabled, const EncryptionConfig& config) = 0; + /** Enables/Disables the built-in encryption. + * + * @since v3.1.0 + * + * In scenarios requiring high security, Agora recommends calling this method to enable the built-in encryption before joining a channel. + * + * All users in the same channel must use the same encryption mode and encryption key. After a user leaves the channel, the SDK automatically disables the built-in encryption. To enable the built-in encryption, call this method before the user joins the channel again. + * + * @note If you enable the built-in encryption, you cannot use the RTMP or RTMPS streaming function. + * + * @param enabled Whether to enable the built-in encryption: + * - true: Enable the built-in encryption. + * - false: Disable the built-in encryption. + * @param config Configurations of built-in encryption schemas. See EncryptionConfig. + * + * @return + * - 0: Success. + * - < 0: Failure. + * - -2(ERR_INVALID_ARGUMENT): An invalid parameter is used. Set the parameter with a valid value. + * - -4(ERR_NOT_SUPPORTED): The encryption mode is incorrect or the SDK fails to load the external encryption library. Check the enumeration or reload the external encryption library. + * - -7(ERR_NOT_INITIALIZED): The SDK is not initialized. Initialize the `IRtcEngine` instance before calling this method. + */ + virtual int enableEncryption(bool enabled, const EncryptionConfig& config) = 0; - /** Registers a packet observer. + /** Registers a packet observer. - The Agora SDK allows your application to register a packet observer to receive callbacks for voice or video packet transmission. + The Agora SDK allows your application to register a packet observer to receive callbacks for voice or video packet transmission. - @note - - The size of the packet sent to the network after processing should not exceed 1200 bytes, otherwise, the packet may fail to be sent. - - Ensure that both receivers and senders call this method, otherwise, you may meet undefined behaviors such as no voice and black screen. - - When you use CDN live streaming, recording or storage functions, Agora doesn't recommend calling this method. - - Call this method before joining a channel. + @note + - The size of the packet sent to the network after processing should not exceed 1200 bytes, otherwise, the packet may fail to be sent. + - Ensure that both receivers and senders call this method, otherwise, you may meet undefined behaviors such as no voice and black screen. + - When you use CDN live streaming and recording functions, Agora doesn't recommend calling this method. + - Call this method before joining a channel. - @param observer Pointer to the registered packet observer. See IPacketObserver. + @param observer Pointer to the registered packet observer. See IPacketObserver. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int registerPacketObserver(IPacketObserver* observer) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int registerPacketObserver(IPacketObserver* observer) = 0; - /** Creates a data stream. + /** Creates a data stream. - Each user can create up to five data streams during the lifecycle of the IRtcEngine. + @deprecated This method is deprecated from v3.3.0. Use the \ref IRtcEngine::createDataStream(int* streamId, DataStreamConfig& config) "createDataStream" [2/2] method instead. - @note - - Set both the @p reliable and @p ordered parameters to true or false. Do not set one as true and the other as false. - - Ensure that you call this method after joining a channel. + Each user can create up to five data streams during the lifecycle of the IRtcEngine. - @param[out] streamId Pointer to the ID of the created data stream. - @param reliable Sets whether or not the recipients are guaranteed to receive the data stream from the sender within five seconds: - - true: The recipients receive the data stream from the sender within five seconds. If the recipient does not receive the data stream within five seconds, an error is reported to the application. - - false: There is no guarantee that the recipients receive the data stream within five seconds and no error message is reported for any delay or missing data stream. - @param ordered Sets whether or not the recipients receive the data stream in the sent order: - - true: The recipients receive the data stream in the sent order. - - false: The recipients do not receive the data stream in the sent order. + @note + - Do not set `reliable` as `true` while setting `ordered` as `false`. + - Ensure that you call this method after joining a channel. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int createDataStream(int* streamId, bool reliable, bool ordered) = 0; + @param[out] streamId Pointer to the ID of the created data stream. + @param reliable Sets whether or not the recipients are guaranteed to receive the data stream from the sender within five seconds: + - true: The recipients receive the data stream from the sender within five seconds. If the recipient does not receive the data stream within five seconds, an error is reported to the application. + - false: There is no guarantee that the recipients receive the data stream within five seconds and no error message is reported for any delay or missing data stream. + @param ordered Sets whether or not the recipients receive the data stream in the sent order: + - true: The recipients receive the data stream in the sent order. + - false: The recipients do not receive the data stream in the sent order. + + @return + - 0: Success. + - < 0: Failure. + */ + virtual int createDataStream(int* streamId, bool reliable, bool ordered) = 0; + /** Creates a data stream. + * + * @since v3.3.0 + * + * Each user can create up to five data streams in a single channel. + * + * This method does not support data reliability. If the receiver receives a data packet five + * seconds or more after it was sent, the SDK directly discards the data. + * + * @param[out] streamId The ID of the created data stream. + * @param config The configurations for the data stream: DataStreamConfig. + * + * @return + * - 0: Creates the data stream successfully. + * - < 0: Fails to create the data stream. + */ + virtual int createDataStream(int* streamId, DataStreamConfig& config) = 0; - /** Sends data stream messages to all users in a channel. + /** Sends data stream messages to all users in a channel. - The SDK has the following restrictions on this method: - - Up to 30 packets can be sent per second in a channel with each packet having a maximum size of 1 kB. - - Each client can send up to 6 kB of data per second. - - Each user can have up to five data streams simultaneously. + The SDK has the following restrictions on this method: + - Up to 30 packets can be sent per second in a channel with each packet having a maximum size of 1 kB. + - Each client can send up to 6 kB of data per second. + - Each user can have up to five data streams simultaneously. - A successful \ref agora::rtc::IRtcEngine::sendStreamMessage "sendStreamMessage" method call triggers the - \ref agora::rtc::IRtcEngineEventHandler::onStreamMessage "onStreamMessage" callback on the remote client, from which the remote user gets the stream message. + A successful \ref agora::rtc::IRtcEngine::sendStreamMessage "sendStreamMessage" method call triggers the + \ref agora::rtc::IRtcEngineEventHandler::onStreamMessage "onStreamMessage" callback on the remote client, from which the remote user gets the stream message. - A failed \ref agora::rtc::IRtcEngine::sendStreamMessage "sendStreamMessage" method call triggers the - \ref agora::rtc::IRtcEngineEventHandler::onStreamMessage "onStreamMessage" callback on the remote client. - @note This method applies only to the `COMMUNICATION` profile or to the hosts in the `LIVE_BROADCASTING` profile. If an audience in the `LIVE_BROADCASTING` profile calls this method, the audience may be switched to a host. - @param streamId ID of the sent data stream, returned in the \ref IRtcEngine::createDataStream "createDataStream" method. - @param data Pointer to the sent data. - @param length Length of the sent data. + A failed \ref agora::rtc::IRtcEngine::sendStreamMessage "sendStreamMessage" method call triggers the + \ref agora::rtc::IRtcEngineEventHandler::onStreamMessage "onStreamMessage" callback on the remote client. + @note This method applies only to the `COMMUNICATION` profile or to the hosts in the `LIVE_BROADCASTING` profile. If an audience in the `LIVE_BROADCASTING` profile calls this method, the audience may be switched to a host. + @param streamId ID of the sent data stream, returned in the \ref IRtcEngine::createDataStream "createDataStream" method. + @param data Pointer to the sent data. + @param length Length of the sent data. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int sendStreamMessage(int streamId, const char* data, size_t length) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int sendStreamMessage(int streamId, const char* data, size_t length) = 0; - /** Publishes the local stream to a specified CDN live RTMP address. (CDN live only.) + /** Publishes the local stream to a specified CDN live address. (CDN live only.) - The SDK returns the result of this method call in the \ref IRtcEngineEventHandler::onStreamPublished "onStreamPublished" callback. + The SDK returns the result of this method call in the \ref IRtcEngineEventHandler::onStreamPublished "onStreamPublished" callback. - The \ref agora::rtc::IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" method call triggers the \ref agora::rtc::IRtcEngineEventHandler::onRtmpStreamingStateChanged "onRtmpStreamingStateChanged" callback on the local client to report the state of adding a local stream to the CDN. - @note - - Ensure that the user joins the channel before calling this method. - - Ensure that you enable the RTMP Converter service before using this function. See *Prerequisites* in the advanced guide *Push Streams to CDN*. - - This method adds only one stream RTMP URL address each time it is called. - - This method applies to `LIVE_BROADCASTING` only. + The \ref agora::rtc::IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" method call triggers the \ref agora::rtc::IRtcEngineEventHandler::onRtmpStreamingStateChanged "onRtmpStreamingStateChanged" callback on the local client to report the state of adding a local stream to the CDN. + @note + - Ensure that the user joins the channel before calling this method. + - Ensure that you enable the RTMP Converter service before using this function. See *Prerequisites* in the advanced guide *Push Streams to CDN*. + - This method adds only one stream CDN streaming URL each time it is called. + - This method applies to `LIVE_BROADCASTING` only. - @param url The CDN streaming URL in the RTMP format. The maximum length of this parameter is 1024 bytes. The RTMP URL address must not contain special characters, such as Chinese language characters. - @param transcodingEnabled Sets whether transcoding is enabled/disabled: - - true: Enable transcoding. To [transcode](https://docs.agora.io/en/Agora%20Platform/terms?platform=All%20Platforms#transcoding) the audio or video streams when publishing them to CDN live, often used for combining the audio and video streams of multiple hosts in CDN live. If you set this parameter as `true`, ensure that you call the \ref IRtcEngine::setLiveTranscoding "setLiveTranscoding" method before this method. - - false: Disable transcoding. + @param url The CDN streaming URL in the RTMP or RTMPS format. The maximum length of this parameter is 1024 bytes. The CDN streaming URL must not contain special characters, such as Chinese language characters. + @param transcodingEnabled Sets whether transcoding is enabled/disabled: + - true: Enable transcoding. To [transcode](https://docs.agora.io/en/Agora%20Platform/terms?platform=All%20Platforms#transcoding) the audio or video streams when publishing them to CDN live, often used for combining the audio and video streams of multiple hosts in CDN live. If you set this parameter as `true`, ensure that you call the \ref IRtcEngine::setLiveTranscoding "setLiveTranscoding" method before this method. + - false: Disable transcoding. - @return - - 0: Success. - - < 0: Failure. - - #ERR_INVALID_ARGUMENT (2): The RTMP URL address is NULL or has a string length of 0. - - #ERR_NOT_INITIALIZED (7): You have not initialized the RTC engine when publishing the stream. - */ - virtual int addPublishStreamUrl(const char *url, bool transcodingEnabled) = 0; + @return + - 0: Success. + - < 0: Failure. + - #ERR_INVALID_ARGUMENT (-2): The CDN streaming URL is NULL or has a string length of 0. + - #ERR_NOT_INITIALIZED (-7): You have not initialized the RTC engine when publishing the stream. + */ + virtual int addPublishStreamUrl(const char* url, bool transcodingEnabled) = 0; - /** Removes an RTMP stream from the CDN. (CDN live only.) + /** Removes an RTMP or RTMPS stream from the CDN. (CDN live only.) - This method removes the RTMP URL address (added by the \ref IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" method) from a CDN live stream. The SDK returns the result of this method call in the \ref IRtcEngineEventHandler::onStreamUnpublished "onStreamUnpublished" callback. + This method removes the CDN streaming URL (added by the \ref IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" method) from a CDN live stream. The SDK returns the result of this method call in the \ref IRtcEngineEventHandler::onStreamUnpublished "onStreamUnpublished" callback. - The \ref agora::rtc::IRtcEngine::removePublishStreamUrl "removePublishStreamUrl" method call triggers the \ref agora::rtc::IRtcEngineEventHandler::onRtmpStreamingStateChanged "onRtmpStreamingStateChanged" callback on the local client to report the state of removing an RTMP stream from the CDN. - @note - - This method removes only one RTMP URL address each time it is called. - - The RTMP URL address must not contain special characters, such as Chinese language characters. - - This method applies to `LIVE_BROADCASTING` only. + The \ref agora::rtc::IRtcEngine::removePublishStreamUrl "removePublishStreamUrl" method call triggers the \ref agora::rtc::IRtcEngineEventHandler::onRtmpStreamingStateChanged "onRtmpStreamingStateChanged" callback on the local client to report the state of removing an RTMP or RTMPS stream from the CDN. - @param url The RTMP URL address to be removed. The maximum length of this parameter is 1024 bytes. + @note + - This method removes only one CDN streaming URL each time it is called. + - The CDN streaming URL must not contain special characters, such as Chinese language characters. + - This method applies to `LIVE_BROADCASTING` only. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int removePublishStreamUrl(const char *url) = 0; + @param url The CDN streaming URL to be removed. The maximum length of this parameter is 1024 bytes. - /** Sets the video layout and audio settings for CDN live. (CDN live only.) + @return + - 0: Success. + - < 0: Failure. + */ + virtual int removePublishStreamUrl(const char* url) = 0; - The SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onTranscodingUpdated "onTranscodingUpdated" callback when you call the `setLiveTranscoding` method to update the transcoding setting. + /** Sets the video layout and audio settings for CDN live. (CDN live only.) - @note - - This method applies to `LIVE_BROADCASTING` only. - - Ensure that you enable the RTMP Converter service before using this function. See *Prerequisites* in the advanced guide *Push Streams to CDN*. - - If you call the `setLiveTranscoding` method to update the transcoding setting for the first time, the SDK does not trigger the `onTranscodingUpdated` callback. - - Ensure that you call this method after joining a channel. + The SDK triggers the \ref agora::rtc::IRtcEngineEventHandler::onTranscodingUpdated "onTranscodingUpdated" callback when you call the `setLiveTranscoding` method to update the transcoding setting. - @param transcoding Sets the CDN live audio/video transcoding settings. See LiveTranscoding. + @note + - This method applies to `LIVE_BROADCASTING` only. + - Ensure that you enable the RTMP Converter service before using this function. See *Prerequisites* in the advanced guide *Push Streams to CDN*. + - If you call the `setLiveTranscoding` method to update the transcoding setting for the first time, the SDK does not trigger the `onTranscodingUpdated` callback. + - Ensure that you call this method after joining a channel. + - Agora supports pushing media streams in RTMPS protocol to the CDN only when you enable transcoding. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setLiveTranscoding(const LiveTranscoding &transcoding) = 0; + @param transcoding Sets the CDN live audio/video transcoding settings. See LiveTranscoding. - /** **DEPRECATED** Adds a watermark image to the local video or CDN live stream. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setLiveTranscoding(const LiveTranscoding& transcoding) = 0; - This method is deprecated from v2.9.1. Use \ref agora::rtc::IRtcEngine::addVideoWatermark(const char* watermarkUrl, const WatermarkOptions& options) "addVideoWatermark"2 instead. + /** **DEPRECATED** Adds a watermark image to the local video or CDN live stream. - This method adds a PNG watermark image to the local video stream for the recording device, channel audience, and CDN live audience to view and capture. + This method is deprecated from v2.9.1. Use \ref agora::rtc::IRtcEngine::addVideoWatermark(const char* watermarkUrl, const WatermarkOptions& options) "addVideoWatermark" [2/2] instead. - To add the PNG file to the CDN live publishing stream, see the \ref IRtcEngine::setLiveTranscoding "setLiveTranscoding" method. + This method adds a PNG watermark image to the local video stream for the capturing device, channel audience, and CDN live audience to view and capture. - @param watermark Pointer to the watermark image to be added to the local video stream. See RtcImage. + To add the PNG file to the CDN live publishing stream, see the \ref IRtcEngine::setLiveTranscoding "setLiveTranscoding" method. - @note - - The URL descriptions are different for the local video and CDN live streams: - - In a local video stream, `url` in RtcImage refers to the absolute path of the added watermark image file in the local video stream. - - In a CDN live stream, `url` in RtcImage refers to the URL address of the added watermark image in the CDN live streaming. - - The source file of the watermark image must be in the PNG file format. If the width and height of the PNG file differ from your settings in this method, the PNG file will be cropped to conform to your settings. - - The Agora SDK supports adding only one watermark image onto a local video or CDN live stream. The newly added watermark image replaces the previous one. + @param watermark Pointer to the watermark image to be added to the local video stream. See RtcImage. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int addVideoWatermark(const RtcImage& watermark) = 0; + @note + - The URL descriptions are different for the local video and CDN live streams: + - In a local video stream, `url` in RtcImage refers to the absolute path of the added watermark image file in the local video stream. + - In a CDN live stream, `url` in RtcImage refers to the URL address of the added watermark image in the CDN live streaming. + - The source file of the watermark image must be in the PNG file format. If the width and height of the PNG file differ from your settings in this method, the PNG file will be cropped to conform to your settings. + - The Agora SDK supports adding only one watermark image onto a local video or CDN live stream. The newly added watermark image replaces the previous one. - /** Adds a watermark image to the local video. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int addVideoWatermark(const RtcImage& watermark) = 0; - This method adds a PNG watermark image to the local video in the live streaming. Once the watermark image is added, all the audience in the channel (CDN audience included), - and the recording device can see and capture it. Agora supports adding only one watermark image onto the local video, and the newly watermark image replaces the previous one. + /** Adds a watermark image to the local video. + * + * This method adds a PNG watermark image to the local video in the live streaming. Once the watermark image is added, all the audience in the channel (CDN audience included), + * and the capturing device can see and capture it. Agora supports adding only one watermark image onto the local video, and the newly watermark image replaces the previous one. + * + * The watermark position depends on the settings in the \ref IRtcEngine::setVideoEncoderConfiguration "setVideoEncoderConfiguration" method: + * - If the orientation mode of the encoding video is #ORIENTATION_MODE_FIXED_LANDSCAPE, or the landscape mode in #ORIENTATION_MODE_ADAPTIVE, the watermark uses the landscape orientation. + * - If the orientation mode of the encoding video is #ORIENTATION_MODE_FIXED_PORTRAIT, or the portrait mode in #ORIENTATION_MODE_ADAPTIVE, the watermark uses the portrait orientation. + * - When setting the watermark position, the region must be less than the dimensions set in the `setVideoEncoderConfiguration` method. Otherwise, the watermark image will be cropped. + * + * @note + * - Ensure that you have called the \ref agora::rtc::IRtcEngine::enableVideo "enableVideo" method to enable the video module before calling this method. + * - If you only want to add a watermark image to the local video for the audience in the CDN live streaming channel to see and capture, you can call this method or the \ref agora::rtc::IRtcEngine::setLiveTranscoding "setLiveTranscoding" method. + * - This method supports adding a watermark image in the PNG file format only. Supported pixel formats of the PNG image are RGBA, RGB, Palette, Gray, and Alpha_gray. + * - If the dimensions of the PNG image differ from your settings in this method, the image will be cropped or zoomed to conform to your settings. + * - If you have enabled the local video preview by calling the \ref agora::rtc::IRtcEngine::startPreview "startPreview" method, you can use the `visibleInPreview` member in the WatermarkOptions class to set whether or not the watermark is visible in preview. + * - If you have enabled the mirror mode for the local video, the watermark on the local video is also mirrored. To avoid mirroring the watermark, Agora recommends that you do not use the mirror and watermark functions for the local video at the same time. You can implement the watermark function in your application layer. + * + * @param watermarkUrl The local file path of the watermark image to be added. + * This method supports adding a watermark image from the local absolute or relative file path. + * On Android, Agora recommends passing a URI address or the path starts with `/assets/` in this parameter + * @param options Pointer to the watermark's options to be added. See WatermarkOptions for more infomation. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int addVideoWatermark(const char* watermarkUrl, const WatermarkOptions& options) = 0; - The watermark position depends on the settings in the \ref IRtcEngine::setVideoEncoderConfiguration "setVideoEncoderConfiguration" method: - - If the orientation mode of the encoding video is #ORIENTATION_MODE_FIXED_LANDSCAPE, or the landscape mode in #ORIENTATION_MODE_ADAPTIVE, the watermark uses the landscape orientation. - - If the orientation mode of the encoding video is #ORIENTATION_MODE_FIXED_PORTRAIT, or the portrait mode in #ORIENTATION_MODE_ADAPTIVE, the watermark uses the portrait orientation. - - When setting the watermark position, the region must be less than the dimensions set in the `setVideoEncoderConfiguration` method. Otherwise, the watermark image will be cropped. + /** Removes the watermark image from the video stream added by the \ref agora::rtc::IRtcEngine::addVideoWatermark(const char* watermarkUrl, const WatermarkOptions& options) "addVideoWatermark" method. - @note - - Ensure that you have called the \ref agora::rtc::IRtcEngine::enableVideo "enableVideo" method to enable the video module before calling this method. - - If you only want to add a watermark image to the local video for the audience in the CDN live streaming channel to see and capture, you can call this method or the \ref agora::rtc::IRtcEngine::setLiveTranscoding "setLiveTranscoding" method. - - This method supports adding a watermark image in the PNG file format only. Supported pixel formats of the PNG image are RGBA, RGB, Palette, Gray, and Alpha_gray. - - If the dimensions of the PNG image differ from your settings in this method, the image will be cropped or zoomed to conform to your settings. - - If you have enabled the local video preview by calling the \ref agora::rtc::IRtcEngine::startPreview "startPreview" method, you can use the `visibleInPreview` member in the WatermarkOptions class to set whether or not the watermark is visible in preview. - - If you have enabled the mirror mode for the local video, the watermark on the local video is also mirrored. To avoid mirroring the watermark, Agora recommends that you do not use the mirror and watermark functions for the local video at the same time. You can implement the watermark function in your application layer. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int clearVideoWatermarks() = 0; - @param watermarkUrl The local file path of the watermark image to be added. This method supports adding a watermark image from the local absolute or relative file path. - @param options Pointer to the watermark's options to be added. See WatermarkOptions for more infomation. + /** Enables/Disables image enhancement and sets the options. + * + * @note Call this method after calling the \ref IRtcEngine::enableVideo "enableVideo" method. + * + * @param enabled Sets whether to enable image enhancement: + * - true: enables image enhancement. + * - false: disables image enhancement. + * @param options Sets the image enhancement option. See BeautyOptions. + */ + virtual int setBeautyEffectOptions(bool enabled, BeautyOptions options) = 0; - @return - - 0: Success. - - < 0: Failure. - */ - virtual int addVideoWatermark(const char* watermarkUrl, const WatermarkOptions& options) = 0; + /** Enables/Disables portrait segmentation and repalce the background(not portrait area) with specified source. + * + * @note Call this method after calling the \ref IRtcEngine::enableVideo "enableVideo" method. + * + * @param enabled Sets whether or not to do background substitution: + * - true: enables background substitution. + * - false: disables background substitution. + * @param VirtualBackgroundSource Background source can be image path or pure color. + */ + virtual int enableVirtualBackground(bool enabled, VirtualBackgroundSource backgroundSource) = 0; - /** Removes the watermark image from the video stream added by the \ref agora::rtc::IRtcEngine::addVideoWatermark(const char* watermarkUrl, const WatermarkOptions& options) "addVideoWatermark" method. + /** Adds a voice or video stream URL address to the live streaming. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int clearVideoWatermarks() = 0; - - /** Enables/Disables image enhancement and sets the options. - * - * @note Call this method after calling the \ref IRtcEngine::enableVideo "enableVideo" method. - * - * @param enabled Sets whether or not to enable image enhancement: - * - true: enables image enhancement. - * - false: disables image enhancement. - * @param options Sets the image enhancement option. See BeautyOptions. - */ - virtual int setBeautyEffectOptions(bool enabled, BeautyOptions options) = 0; - - /** Adds a voice or video stream URL address to the live streaming. - - The \ref IRtcEngineEventHandler::onStreamPublished "onStreamPublished" callback returns the inject status. If this method call is successful, the server pulls the voice or video stream and injects it into a live channel. This is applicable to scenarios where all audience members in the channel can watch a live show and interact with each other. - - The \ref agora::rtc::IRtcEngine::addInjectStreamUrl "addInjectStreamUrl" method call triggers the following callbacks: - - The local client: - - \ref agora::rtc::IRtcEngineEventHandler::onStreamInjectedStatus "onStreamInjectedStatus" , with the state of the injecting the online stream. - - \ref agora::rtc::IRtcEngineEventHandler::onUserJoined "onUserJoined" (uid: 666), if the method call is successful and the online media stream is injected into the channel. - - The remote client: - - \ref agora::rtc::IRtcEngineEventHandler::onUserJoined "onUserJoined" (uid: 666), if the method call is successful and the online media stream is injected into the channel. - - @note - - Ensure that you enable the RTMP Converter service before using this function. See *Prerequisites* in the advanced guide *Push Streams to CDN*. - - This method applies to the Native SDK v2.4.1 and later. - - This method applies to the `LIVE_BROADCASTING` profile only. - - You can inject only one media stream into the channel at the same time. - - Ensure that you call this method after joining a channel. - - @param url Pointer to the URL address to be added to the ongoing streaming. Valid protocols are RTMP, HLS, and HTTP-FLV. - - Supported audio codec type: AAC. - - Supported video codec type: H264 (AVC). - @param config Pointer to the InjectStreamConfig object that contains the configuration of the added voice or video stream. - - @return - - 0: Success. - - < 0: Failure. - - #ERR_INVALID_ARGUMENT (2): The injected URL does not exist. Call this method again to inject the stream and ensure that the URL is valid. - - #ERR_NOT_READY (3): The user is not in the channel. - - #ERR_NOT_SUPPORTED (4): The channel profile is not `LIVE_BROADCASTING`. Call the \ref agora::rtc::IRtcEngine::setChannelProfile "setChannelProfile" method and set the channel profile to `LIVE_BROADCASTING` before calling this method. - - #ERR_NOT_INITIALIZED (7): The SDK is not initialized. Ensure that the IRtcEngine object is initialized before calling this method. - */ - virtual int addInjectStreamUrl(const char* url, const InjectStreamConfig& config) = 0; - /** Starts to relay media streams across channels. - * - * After a successful method call, the SDK triggers the - * \ref agora::rtc::IRtcEngineEventHandler::onChannelMediaRelayStateChanged - * "onChannelMediaRelayStateChanged" and - * \ref agora::rtc::IRtcEngineEventHandler::onChannelMediaRelayEvent - * "onChannelMediaRelayEvent" callbacks, and these callbacks return the - * state and events of the media stream relay. - * - If the - * \ref agora::rtc::IRtcEngineEventHandler::onChannelMediaRelayStateChanged - * "onChannelMediaRelayStateChanged" callback returns - * #RELAY_STATE_RUNNING (2) and #RELAY_OK (0), and the - * \ref agora::rtc::IRtcEngineEventHandler::onChannelMediaRelayEvent - * "onChannelMediaRelayEvent" callback returns - * #RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL (4), the host starts - * sending data to the destination channel. - * - If the - * \ref agora::rtc::IRtcEngineEventHandler::onChannelMediaRelayStateChanged - * "onChannelMediaRelayStateChanged" callback returns - * #RELAY_STATE_FAILURE (3), an exception occurs during the media stream - * relay. - * - * @note - * - Call this method after the \ref joinChannel() "joinChannel" method. - * - This method takes effect only when you are a host in a - * `LIVE_BROADCASTING` channel. - * - After a successful method call, if you want to call this method - * again, ensure that you call the - * \ref stopChannelMediaRelay() "stopChannelMediaRelay" method to quit the - * current relay. - * - Contact sales-us@agora.io before implementing this function. - * - We do not support string user accounts in this API. - * - * @param configuration The configuration of the media stream relay: - * ChannelMediaRelayConfiguration. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int startChannelMediaRelay(const ChannelMediaRelayConfiguration &configuration) = 0; - /** Updates the channels for media stream relay. After a successful - * \ref startChannelMediaRelay() "startChannelMediaRelay" method call, if - * you want to relay the media stream to more channels, or leave the - * current relay channel, you can call the - * \ref updateChannelMediaRelay() "updateChannelMediaRelay" method. - * - * After a successful method call, the SDK triggers the - * \ref agora::rtc::IRtcEngineEventHandler::onChannelMediaRelayEvent - * "onChannelMediaRelayEvent" callback with the - * #RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL (7) state code. - * - * @note - * Call this method after the - * \ref startChannelMediaRelay() "startChannelMediaRelay" method to update - * the destination channel. - * - * @param configuration The media stream relay configuration: - * ChannelMediaRelayConfiguration. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int updateChannelMediaRelay(const ChannelMediaRelayConfiguration &configuration) = 0; - /** Stops the media stream relay. - * - * Once the relay stops, the host quits all the destination - * channels. - * - * After a successful method call, the SDK triggers the - * \ref agora::rtc::IRtcEngineEventHandler::onChannelMediaRelayStateChanged - * "onChannelMediaRelayStateChanged" callback. If the callback returns - * #RELAY_STATE_IDLE (0) and #RELAY_OK (0), the host successfully - * stops the relay. - * - * @note - * If the method call fails, the SDK triggers the - * \ref agora::rtc::IRtcEngineEventHandler::onChannelMediaRelayStateChanged - * "onChannelMediaRelayStateChanged" callback with the - * #RELAY_ERROR_SERVER_NO_RESPONSE (2) or - * #RELAY_ERROR_SERVER_CONNECTION_LOST (8) state code. You can leave the - * channel by calling the \ref leaveChannel() "leaveChannel" method, and - * the media stream relay automatically stops. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int stopChannelMediaRelay() = 0; + The \ref IRtcEngineEventHandler::onStreamPublished "onStreamPublished" callback returns the inject status. If this method call is successful, the server pulls the voice or video stream and injects it into a live channel. This is applicable to scenarios where all audience members in the channel can watch a live show and interact with each other. - /** Removes the voice or video stream URL address from the live streaming. + The \ref agora::rtc::IRtcEngine::addInjectStreamUrl "addInjectStreamUrl" method call triggers the following callbacks: + - The local client: + - \ref agora::rtc::IRtcEngineEventHandler::onStreamInjectedStatus "onStreamInjectedStatus" , with the state of the injecting the online stream. + - \ref agora::rtc::IRtcEngineEventHandler::onUserJoined "onUserJoined" (uid: 666), if the method call is successful and the online media stream is injected into the channel. + - The remote client: + - \ref agora::rtc::IRtcEngineEventHandler::onUserJoined "onUserJoined" (uid: 666), if the method call is successful and the online media stream is injected into the channel. - This method removes the URL address (added by the \ref IRtcEngine::addInjectStreamUrl "addInjectStreamUrl" method) from the live streaming. + @warning Agora will soon stop the service for injecting online media streams on the client. If you have not implemented this service, Agora recommends that you do not use it. - @note If this method is called successfully, the SDK triggers the \ref IRtcEngineEventHandler::onUserOffline "onUserOffline" callback and returns a stream uid of 666. + @note + - Ensure that you enable the RTMP Converter service before using this function. See *Prerequisites* in the advanced guide *Push Streams to CDN*. + - This method applies to the Native SDK v2.4.1 and later. + - This method applies to the `LIVE_BROADCASTING` profile only. + - You can inject only one media stream into the channel at the same time. + - Ensure that you call this method after joining a channel. - @param url Pointer to the URL address of the injected stream to be removed. + @param url Pointer to the URL address to be added to the ongoing streaming. Valid protocols are RTMP, HLS, and HTTP-FLV. + - Supported audio codec type: AAC. + - Supported video codec type: H264 (AVC). + @param config Pointer to the InjectStreamConfig object that contains the configuration of the added voice or video stream. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int removeInjectStreamUrl(const char* url) = 0; - virtual bool registerEventHandler(IRtcEngineEventHandler *eventHandler) = 0; - virtual bool unregisterEventHandler(IRtcEngineEventHandler *eventHandler) = 0; - /** Agora supports reporting and analyzing customized messages. - * - * @since v3.1.0 - * - * This function is in the beta stage with a free trial. The ability provided in its beta test version is reporting a maximum of 10 message pieces within 6 seconds, with each message piece not exceeding 256 bytes and each string not exceeding 100 bytes. - * To try out this function, contact [support@agora.io](mailto:support@agora.io) and discuss the format of customized messages with us. - */ - virtual int sendCustomReportMessage(const char *id, const char* category, const char* event, const char* label, int value) = 0; - /** Gets the current connection state of the SDK. + @return + - 0: Success. + - < 0: Failure. + - #ERR_INVALID_ARGUMENT (-2): The injected URL does not exist. Call this method again to inject the stream and ensure that the URL is valid. + - #ERR_NOT_READY (-3): The user is not in the channel. + - #ERR_NOT_SUPPORTED (-4): The channel profile is not `LIVE_BROADCASTING`. Call the \ref agora::rtc::IRtcEngine::setChannelProfile "setChannelProfile" method and set the channel profile to `LIVE_BROADCASTING` before calling this method. + - #ERR_NOT_INITIALIZED (-7): The SDK is not initialized. Ensure that the IRtcEngine object is initialized before calling this method. + */ + virtual int addInjectStreamUrl(const char* url, const InjectStreamConfig& config) = 0; + /** Starts to relay media streams across channels. + * + * After a successful method call, the SDK triggers the + * \ref agora::rtc::IRtcEngineEventHandler::onChannelMediaRelayStateChanged + * "onChannelMediaRelayStateChanged" and + * \ref agora::rtc::IRtcEngineEventHandler::onChannelMediaRelayEvent + * "onChannelMediaRelayEvent" callbacks, and these callbacks return the + * state and events of the media stream relay. + * - If the + * \ref agora::rtc::IRtcEngineEventHandler::onChannelMediaRelayStateChanged + * "onChannelMediaRelayStateChanged" callback returns + * #RELAY_STATE_RUNNING (2) and #RELAY_OK (0), and the + * \ref agora::rtc::IRtcEngineEventHandler::onChannelMediaRelayEvent + * "onChannelMediaRelayEvent" callback returns + * #RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL (4), the host starts + * sending data to the destination channel. + * - If the + * \ref agora::rtc::IRtcEngineEventHandler::onChannelMediaRelayStateChanged + * "onChannelMediaRelayStateChanged" callback returns + * #RELAY_STATE_FAILURE (3), an exception occurs during the media stream + * relay. + * + * @note + * - Call this method after the \ref joinChannel() "joinChannel" method. + * - This method takes effect only when you are a host in a + * `LIVE_BROADCASTING` channel. + * - After a successful method call, if you want to call this method + * again, ensure that you call the + * \ref stopChannelMediaRelay() "stopChannelMediaRelay" method to quit the + * current relay. + * - Contact sales-us@agora.io before implementing this function. + * - We do not support string user accounts in this API. + * + * @param configuration The configuration of the media stream relay: + * ChannelMediaRelayConfiguration. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int startChannelMediaRelay(const ChannelMediaRelayConfiguration& configuration) = 0; + /** Updates the channels for media stream relay. After a successful + * \ref startChannelMediaRelay() "startChannelMediaRelay" method call, if + * you want to relay the media stream to more channels, or leave the + * current relay channel, you can call the + * \ref updateChannelMediaRelay() "updateChannelMediaRelay" method. + * + * After a successful method call, the SDK triggers the + * \ref agora::rtc::IRtcEngineEventHandler::onChannelMediaRelayEvent + * "onChannelMediaRelayEvent" callback with the + * #RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL (7) state code. + * + * @note + * Call this method after the + * \ref startChannelMediaRelay() "startChannelMediaRelay" method to update + * the destination channel. + * + * @param configuration The media stream relay configuration: + * ChannelMediaRelayConfiguration. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int updateChannelMediaRelay(const ChannelMediaRelayConfiguration& configuration) = 0; + /** Stops the media stream relay. + * + * Once the relay stops, the host quits all the destination + * channels. + * + * After a successful method call, the SDK triggers the + * \ref agora::rtc::IRtcEngineEventHandler::onChannelMediaRelayStateChanged + * "onChannelMediaRelayStateChanged" callback. If the callback returns + * #RELAY_STATE_IDLE (0) and #RELAY_OK (0), the host successfully + * stops the relay. + * + * @note + * If the method call fails, the SDK triggers the + * \ref agora::rtc::IRtcEngineEventHandler::onChannelMediaRelayStateChanged + * "onChannelMediaRelayStateChanged" callback with the + * #RELAY_ERROR_SERVER_NO_RESPONSE (2) or + * #RELAY_ERROR_SERVER_CONNECTION_LOST (8) error code. You can leave the + * channel by calling the \ref leaveChannel() "leaveChannel" method, and + * the media stream relay automatically stops. + * + * @return + * - 0: Success. + * - < 0: Failure. + */ + virtual int stopChannelMediaRelay() = 0; - @note You can call this method either before or after joining a channel. + /** Removes the voice or video stream URL address from the live streaming. - @return #CONNECTION_STATE_TYPE. - */ - virtual CONNECTION_STATE_TYPE getConnectionState() = 0; - /// @cond - /** Enables/Disables the super-resolution algorithm for a remote user's video stream. - * - * @since v3.2.0 - * - * The algorithm effectively improves the resolution of the specified remote user's video stream. When the original - * resolution of the remote video stream is a × b pixels, you can receive and render the stream at a higher - * resolution (2a × 2b pixels) by enabling the algorithm. - * - * After calling this method, the SDK triggers the - * \ref IRtcEngineEventHandler::onUserSuperResolutionEnabled "onUserSuperResolutionEnabled" callback to report - * whether you have successfully enabled the super-resolution algorithm. - * - * @warning The super-resolution algorithm requires extra system resources. - * To balance the visual experience and system usage, the SDK poses the following restrictions: - * - The algorithm can only be used for a single user at a time. - * - On the Android platform, the original resolution of the remote video must not exceed 640 × 360 pixels. - * - On the iOS platform, the original resolution of the remote video must not exceed 640 × 480 pixels. - * If you exceed these limitations, the SDK triggers the \ref IRtcEngineEventHandler::onWarning "onWarning" - * callback with the corresponding warning codes: - * - #WARN_SUPER_RESOLUTION_STREAM_OVER_LIMITATION (1610): The origin resolution of the remote video is beyond the range where the super-resolution algorithm can be applied. - * - #WARN_SUPER_RESOLUTION_USER_COUNT_OVER_LIMITATION (1611): Another user is already using the super-resolution algorithm. - * - #WARN_SUPER_RESOLUTION_DEVICE_NOT_SUPPORTED (1612): The device does not support the super-resolution algorithm. - * - * @note - * - This method applies to Android and iOS only. - * - Requirements for the user's device: - * - Android: The following devices are known to support the method: - * - VIVO: V1821A, NEX S, 1914A, 1916A, and 1824BA - * - OPPO: PCCM00 - * - OnePlus: A6000 - * - Xiaomi: Mi 8, Mi 9, MIX3, and Redmi K20 Pro - * - SAMSUNG: SM-G9600, SM-G9650, SM-N9600, SM-G9708, SM-G960U, and SM-G9750 - * - HUAWEI: SEA-AL00, ELE-AL00, VOG-AL00, YAL-AL10, HMA-AL00, and EVR-AN00 - * - iOS: This method is supported on devices running iOS 12.0 or later. The following - * device models are known to support the method: - * - iPhone XR - * - iPhone XS - * - iPhone XS Max - * - iPhone 11 - * - iPhone 11 Pro - * - iPhone 11 Pro Max - * - iPad Pro 11-inch (3rd Generation) - * - iPad Pro 12.9-inch (3rd Generation) - * - iPad Air 3 (3rd Generation) - * - * @param userId The ID of the remote user. - * @param enable Whether to enable the super-resolution algorithm: - * - true: Enable the super-resolution algorithm. - * - false: Disable the super-resolution algorithm. - * - * @return - * - 0: Success. - * - < 0: Failure. - */ - virtual int enableRemoteSuperResolution(uid_t userId, bool enable) = 0; - /// @endcond + This method removes the URL address (added by the \ref IRtcEngine::addInjectStreamUrl "addInjectStreamUrl" method) from the live streaming. + + @warning Agora will soon stop the service for injecting online media streams on the client. If you have not implemented this service, Agora recommends that you do not use it. - /** Registers the metadata observer. + @note If this method is called successfully, the SDK triggers the \ref IRtcEngineEventHandler::onUserOffline "onUserOffline" callback and returns a stream uid of 666. - Registers the metadata observer. You need to implement the IMetadataObserver class and specify the metadata type in this method. A successful call of this method triggers the \ref agora::rtc::IMetadataObserver::getMaxMetadataSize "getMaxMetadataSize" callback. - This method enables you to add synchronized metadata in the video stream for more diversified live interactive streaming, such as sending shopping links, digital coupons, and online quizzes. + @param url Pointer to the URL address of the injected stream to be removed. - @note - - Call this method before the joinChannel method. - - This method applies to the `LIVE_BROADCASTING` channel profile. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int removeInjectStreamUrl(const char* url) = 0; + virtual bool registerEventHandler(IRtcEngineEventHandler* eventHandler) = 0; + virtual bool unregisterEventHandler(IRtcEngineEventHandler* eventHandler) = 0; + /** Agora supports reporting and analyzing customized messages. + * + * @since v3.1.0 + * + * This function is in the beta stage with a free trial. The ability provided in its beta test version is reporting a maximum of 10 message pieces within 6 seconds, with each message piece not exceeding 256 bytes and each string not exceeding 100 bytes. + * To try out this function, contact [support@agora.io](mailto:support@agora.io) and discuss the format of customized messages with us. + */ + virtual int sendCustomReportMessage(const char* id, const char* category, const char* event, const char* label, int value) = 0; + /** Gets the current connection state of the SDK. - @param observer The IMetadataObserver class. See the definition of IMetadataObserver for details. - @param type See \ref IMetadataObserver::METADATA_TYPE "METADATA_TYPE". The SDK supports VIDEO_METADATA (0) only for now. + @note You can call this method either before or after joining a channel. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int registerMediaMetadataObserver(IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type) = 0; - /** Provides technical preview functionalities or special customizations by configuring the SDK with JSON options. + @return #CONNECTION_STATE_TYPE. + */ + virtual CONNECTION_STATE_TYPE getConnectionState() = 0; + /// @cond + /** Enables/Disables the super-resolution algorithm for a remote user's video stream. + * + * @since v3.2.0 + * + * The algorithm effectively improves the resolution of the specified remote user's video stream. When the original + * resolution of the remote video stream is a × b pixels, you can receive and render the stream at a higher + * resolution (2a × 2b pixels) by enabling the algorithm. + * + * After calling this method, the SDK triggers the + * \ref IRtcEngineEventHandler::onUserSuperResolutionEnabled "onUserSuperResolutionEnabled" callback to report + * whether you have successfully enabled the super-resolution algorithm. + * + * @warning The super-resolution algorithm requires extra system resources. + * To balance the visual experience and system usage, the SDK poses the following restrictions: + * - The algorithm can only be used for a single user at a time. + * - On the Android platform, the original resolution of the remote video must not exceed 640 × 360 pixels. + * - On the iOS platform, the original resolution of the remote video must not exceed 640 × 480 pixels. + * If you exceed these limitations, the SDK triggers the \ref IRtcEngineEventHandler::onWarning "onWarning" + * callback with the corresponding warning codes: + * - #WARN_SUPER_RESOLUTION_STREAM_OVER_LIMITATION (1610): The origin resolution of the remote video is beyond the range where the super-resolution algorithm can be applied. + * - #WARN_SUPER_RESOLUTION_USER_COUNT_OVER_LIMITATION (1611): Another user is already using the super-resolution algorithm. + * - #WARN_SUPER_RESOLUTION_DEVICE_NOT_SUPPORTED (1612): The device does not support the super-resolution algorithm. + * + * @note + * - This method applies to Android and iOS only. + * - Requirements for the user's device: + * - Android: The following devices are known to support the method: + * - VIVO: V1821A, NEX S, 1914A, 1916A, and 1824BA + * - OPPO: PCCM00 + * - OnePlus: A6000 + * - Xiaomi: Mi 8, Mi 9, MIX3, and Redmi K20 Pro + * - SAMSUNG: SM-G9600, SM-G9650, SM-N9600, SM-G9708, SM-G960U, and SM-G9750 + * - HUAWEI: SEA-AL00, ELE-AL00, VOG-AL00, YAL-AL10, HMA-AL00, and EVR-AN00 + * - iOS: This method is supported on devices running iOS 12.0 or later. The following + * device models are known to support the method: + * - iPhone XR + * - iPhone XS + * - iPhone XS Max + * - iPhone 11 + * - iPhone 11 Pro + * - iPhone 11 Pro Max + * - iPad Pro 11-inch (3rd Generation) + * - iPad Pro 12.9-inch (3rd Generation) + * - iPad Air 3 (3rd Generation) + * + * @param userId The ID of the remote user. + * @param enable Whether to enable the super-resolution algorithm: + * - true: Enable the super-resolution algorithm. + * - false: Disable the super-resolution algorithm. + * + * @return + * - 0: Success. + * - < 0: Failure. + * - -158 (ERR_MODULE_SUPER_RESOLUTION_NOT_FOUND): You have not integrated the dynamic library for the super-resolution algorithm. + */ + virtual int enableRemoteSuperResolution(uid_t userId, bool enable) = 0; + /// @endcond + + /** Registers the metadata observer. + + Registers the metadata observer. You need to implement the IMetadataObserver class and specify the metadata type in this method. A successful call of this method triggers the \ref agora::rtc::IMetadataObserver::getMaxMetadataSize "getMaxMetadataSize" callback. + This method enables you to add synchronized metadata in the video stream for more diversified interactive live streaming, such as sending shopping links, digital coupons, and online quizzes. + + @note + - Call this method before the joinChannel method. + - This method applies to the `LIVE_BROADCASTING` channel profile. + + @param observer The IMetadataObserver class. See the definition of IMetadataObserver for details. + @param type See \ref IMetadataObserver::METADATA_TYPE "METADATA_TYPE". The SDK supports VIDEO_METADATA (0) only for now. + + @return + - 0: Success. + - < 0: Failure. + */ + virtual int registerMediaMetadataObserver(IMetadataObserver* observer, IMetadataObserver::METADATA_TYPE type) = 0; + /** Provides technical preview functionalities or special customizations by configuring the SDK with JSON options. + + The JSON options are not public by default. Agora is working on making commonly used JSON options public in a standard way. + + @param parameters Sets the parameter as a JSON string in the specified format. - The JSON options are not public by default. Agora is working on making commonly used JSON options public in a standard way. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setParameters(const char* parameters) = 0; + /** set local access point addresses in local proxy mode. use this method before join + channel. - @param parameters Sets the parameter as a JSON string in the specified format. + @param ips local access point ip addresses. + @param ipSize the number of local access point. + @param domain The domain described in certificate installed on specific local access point. pass "" means using sni domain on specific local access point - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setParameters(const char* parameters) = 0; + @return + - 0: Success + - < 0: Failure + */ + virtual int setLocalAccessPoint(const char** ips, int ipSize, const char* domain) = 0; }; +class IRtcEngineParameter { + public: + virtual ~IRtcEngineParameter() {} + /** + * Releases all IRtcEngineParameter resources. + */ + virtual void release() = 0; -class IRtcEngineParameter -{ -public: - virtual ~IRtcEngineParameter () {} - /** - * Releases all IRtcEngineParameter resources. - */ - virtual void release() = 0; - - /** Sets the bool value of a specified key in the JSON format. - - @param key Pointer to the name of the key. - @param value Sets the value. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setBool(const char* key, bool value) = 0; + /** Sets the bool value of a specified key in the JSON format. - /** Sets the int value of a specified key in the JSON format. + @param key Pointer to the name of the key. + @param value Sets the value. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setBool(const char* key, bool value) = 0; - @param key Pointer to the name of the key. - @param value Sets the value. + /** Sets the int value of a specified key in the JSON format. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setInt(const char* key, int value) = 0; + @param key Pointer to the name of the key. + @param value Sets the value. - /** Sets the unsigned int value of a specified key in the JSON format. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setInt(const char* key, int value) = 0; - @param key Pointer to the name of the key. - @param value Sets the value. + /** Sets the unsigned int value of a specified key in the JSON format. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setUInt(const char* key, unsigned int value) = 0; + @param key Pointer to the name of the key. + @param value Sets the value. + + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setUInt(const char* key, unsigned int value) = 0; - /** Sets the double value of a specified key in the JSON format. + /** Sets the double value of a specified key in the JSON format. - @param key Pointer to the name of the key. - @param value Sets the value. + @param key Pointer to the name of the key. + @param value Sets the value. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setNumber(const char* key, double value) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setNumber(const char* key, double value) = 0; - /** Sets the string value of a specified key in the JSON format. + /** Sets the string value of a specified key in the JSON format. - @param key Pointer to the name of the key. - @param value Pointer to the set value. + @param key Pointer to the name of the key. + @param value Pointer to the set value. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setString(const char* key, const char* value) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setString(const char* key, const char* value) = 0; - /** Sets the object value of a specified key in the JSON format. + /** Sets the object value of a specified key in the JSON format. - @param key Pointer to the name of the key. - @param value Pointer to the set value. + @param key Pointer to the name of the key. + @param value Pointer to the set value. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setObject(const char* key, const char* value) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setObject(const char* key, const char* value) = 0; - /** Retrieves the bool value of a specified key in the JSON format. + /** Gets the bool value of a specified key in the JSON format. - @param key Pointer to the name of the key. - @param value Pointer to the retrieved value. + @param key Pointer to the name of the key. + @param value Pointer to the retrieved value. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getBool(const char* key, bool& value) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getBool(const char* key, bool& value) = 0; - /** Retrieves the int value of the JSON format. + /** Gets the int value of the JSON format. - @param key Pointer to the name of the key. - @param value Pointer to the retrieved value. + @param key Pointer to the name of the key. + @param value Pointer to the retrieved value. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getInt(const char* key, int& value) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getInt(const char* key, int& value) = 0; - /** Retrieves the unsigned int value of a specified key in the JSON format. + /** Gets the unsigned int value of a specified key in the JSON format. - @param key Pointer to the name of the key. - @param value Pointer to the retrieved value. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getUInt(const char* key, unsigned int& value) = 0; + @param key Pointer to the name of the key. + @param value Pointer to the retrieved value. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getUInt(const char* key, unsigned int& value) = 0; - /** Retrieves the double value of a specified key in the JSON format. + /** Gets the double value of a specified key in the JSON format. - @param key Pointer to the name of the key. - @param value Pointer to the retrieved value. + @param key Pointer to the name of the key. + @param value Pointer to the retrieved value. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getNumber(const char* key, double& value) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getNumber(const char* key, double& value) = 0; - /** Retrieves the string value of a specified key in the JSON format. + /** Gets the string value of a specified key in the JSON format. - @param key Pointer to the name of the key. - @param value Pointer to the retrieved value. + @param key Pointer to the name of the key. + @param value Pointer to the retrieved value. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getString(const char* key, agora::util::AString& value) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getString(const char* key, agora::util::AString& value) = 0; - /** Retrieves a child object value of a specified key in the JSON format. + /** Gets a child object value of a specified key in the JSON format. - @param key Pointer to the name of the key. - @param value Pointer to the retrieved value. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getObject(const char* key, agora::util::AString& value) = 0; + @param key Pointer to the name of the key. + @param value Pointer to the retrieved value. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getObject(const char* key, agora::util::AString& value) = 0; - /** Retrieves the array value of a specified key in the JSON format. + /** Gets the array value of a specified key in the JSON format. - @param key Pointer to the name of the key. - @param value Pointer to the retrieved value. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int getArray(const char* key, agora::util::AString& value) = 0; + @param key Pointer to the name of the key. + @param value Pointer to the retrieved value. + @return + - 0: Success. + - < 0: Failure. + */ + virtual int getArray(const char* key, agora::util::AString& value) = 0; - /** Provides the technical preview functionalities or special customizations by configuring the SDK with JSON options. + /** Provides the technical preview functionalities or special customizations by configuring the SDK with JSON options. - @param parameters Pointer to the set parameters in a JSON string. + @param parameters Pointer to the set parameters in a JSON string. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setParameters(const char* parameters) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setParameters(const char* parameters) = 0; - /** Sets the profile to control the RTC engine. + /** Sets the profile to control the RTC engine. - @param profile Pointer to the set profile. - @param merge Sets whether to merge the profile data with the original value: - - true: Merge the profile data with the original value. - - false: Do not merge the profile data with the original value. + @param profile Pointer to the set profile. + @param merge Sets whether to merge the profile data with the original value: + - true: Merge the profile data with the original value. + - false: Do not merge the profile data with the original value. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int setProfile(const char* profile, bool merge) = 0; + @return + - 0: Success. + - < 0: Failure. + */ + virtual int setProfile(const char* profile, bool merge) = 0; - virtual int convertPath(const char* filePath, agora::util::AString& value) = 0; + virtual int convertPath(const char* filePath, agora::util::AString& value) = 0; }; -class AAudioDeviceManager : public agora::util::AutoPtr -{ -public: - AAudioDeviceManager(IRtcEngine* engine) - { - queryInterface(engine, AGORA_IID_AUDIO_DEVICE_MANAGER); - } +class AAudioDeviceManager : public agora::util::AutoPtr { + public: + AAudioDeviceManager(IRtcEngine* engine) { queryInterface(engine, AGORA_IID_AUDIO_DEVICE_MANAGER); } }; -class AVideoDeviceManager : public agora::util::AutoPtr -{ -public: - AVideoDeviceManager(IRtcEngine* engine) - { - queryInterface(engine, AGORA_IID_VIDEO_DEVICE_MANAGER); - } +class AVideoDeviceManager : public agora::util::AutoPtr { + public: + AVideoDeviceManager(IRtcEngine* engine) { queryInterface(engine, AGORA_IID_VIDEO_DEVICE_MANAGER); } }; -class AParameter : public agora::util::AutoPtr -{ -public: - AParameter(IRtcEngine& engine) { initialize(&engine); } - AParameter(IRtcEngine* engine) { initialize(engine); } - AParameter(IRtcEngineParameter* p) :agora::util::AutoPtr(p) {} -private: - bool initialize(IRtcEngine* engine) - { - IRtcEngineParameter* p = NULL; - if (engine && !engine->queryInterface(AGORA_IID_RTC_ENGINE_PARAMETER, (void**)&p)) - reset(p); - return p != NULL; - } +class AParameter : public agora::util::AutoPtr { + public: + AParameter(IRtcEngine& engine) { initialize(&engine); } + AParameter(IRtcEngine* engine) { initialize(engine); } + AParameter(IRtcEngineParameter* p) : agora::util::AutoPtr(p) {} + + private: + bool initialize(IRtcEngine* engine) { + IRtcEngineParameter* p = NULL; + if (engine && !engine->queryInterface(AGORA_IID_RTC_ENGINE_PARAMETER, (void**)&p)) reset(p); + return p != NULL; + } }; /** **DEPRECATED** The RtcEngineParameters class is deprecated, use the IRtcEngine class instead. -*/ -class RtcEngineParameters -{ -public: - RtcEngineParameters(IRtcEngine& engine) - :m_parameter(&engine){} - RtcEngineParameters(IRtcEngine* engine) - :m_parameter(engine){} + */ +class RtcEngineParameters { + public: + RtcEngineParameters(IRtcEngine& engine) : m_parameter(&engine) {} + RtcEngineParameters(IRtcEngine* engine) : m_parameter(engine) {} + int enableLocalVideo(bool enabled) { return setParameters("{\"rtc.video.capture\":%s,\"che.video.local.capture\":%s,\"che.video.local.render\":%s,\"che.video.local.send\":%s}", enabled ? "true" : "false", enabled ? "true" : "false", enabled ? "true" : "false", enabled ? "true" : "false"); } - int enableLocalVideo(bool enabled) { - return setParameters("{\"rtc.video.capture\":%s,\"che.video.local.capture\":%s,\"che.video.local.render\":%s,\"che.video.local.send\":%s}", enabled ? "true" : "false", enabled ? "true" : "false", enabled ? "true" : "false", enabled ? "true" : "false"); - } + int muteLocalVideoStream(bool mute) { return setParameters("{\"rtc.video.mute_me\":%s}", mute ? "true" : "false"); } + int muteAllRemoteVideoStreams(bool mute) { return m_parameter ? m_parameter->setBool("rtc.video.mute_peers", mute) : -ERR_NOT_INITIALIZED; } + int setDefaultMuteAllRemoteVideoStreams(bool mute) { return m_parameter ? m_parameter->setBool("rtc.video.set_default_mute_peers", mute) : -ERR_NOT_INITIALIZED; } - int muteLocalVideoStream(bool mute) { - return setParameters("{\"rtc.video.mute_me\":%s,\"che.video.local.send\":%s}", mute ? "true" : "false", mute ? "false" : "true"); - } + int muteRemoteVideoStream(uid_t uid, bool mute) { return setObject("rtc.video.mute_peer", "{\"uid\":%u,\"mute\":%s}", uid, mute ? "true" : "false"); } + int setPlaybackDeviceVolume(int volume) { // [0,255] + return m_parameter ? m_parameter->setInt("che.audio.output.volume", volume) : -ERR_NOT_INITIALIZED; + } - int muteAllRemoteVideoStreams(bool mute) { - return m_parameter ? m_parameter->setBool("rtc.video.mute_peers", mute) : -ERR_NOT_INITIALIZED; - } + int startAudioRecording(const char* filePath, AUDIO_RECORDING_QUALITY_TYPE quality) { return startAudioRecording(filePath, 32000, quality); } + int startAudioRecording(const char* filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality) { + if (!m_parameter) return -ERR_NOT_INITIALIZED; +#if defined(_WIN32) + util::AString path; + if (!m_parameter->convertPath(filePath, path)) + filePath = path->c_str(); + else + return -ERR_INVALID_ARGUMENT; +#endif + return setObject("che.audio.start_recording", "{\"filePath\":\"%s\",\"sampleRate\":%d,\"quality\":%d}", filePath, sampleRate, quality); + } + int stopAudioRecording() { return setParameters("{\"che.audio.stop_recording\":true, \"che.audio.stop_nearend_recording\":true, \"che.audio.stop_farend_recording\":true}"); } - int setDefaultMuteAllRemoteVideoStreams(bool mute) { - return m_parameter ? m_parameter->setBool("rtc.video.set_default_mute_peers", mute) : -ERR_NOT_INITIALIZED; - } + int startAudioMixing(const char* filePath, bool loopback, bool replace, int cycle, int startPos = 0) { + if (!m_parameter) return -ERR_NOT_INITIALIZED; +#if defined(_WIN32) + util::AString path; + if (!m_parameter->convertPath(filePath, path)) + filePath = path->c_str(); + else + return -ERR_INVALID_ARGUMENT; +#endif + return setObject("che.audio.start_file_as_playout", "{\"filePath\":\"%s\",\"loopback\":%s,\"replace\":%s,\"cycle\":%d, \"startPos\":%d}", filePath, loopback ? "true" : "false", replace ? "true" : "false", cycle, startPos); + } + int stopAudioMixing() { return m_parameter ? m_parameter->setBool("che.audio.stop_file_as_playout", true) : -ERR_NOT_INITIALIZED; } - int muteRemoteVideoStream(uid_t uid, bool mute) { - return setObject("rtc.video.mute_peer", "{\"uid\":%u,\"mute\":%s}", uid, mute ? "true" : "false"); - } + int pauseAudioMixing() { return m_parameter ? m_parameter->setBool("che.audio.pause_file_as_playout", true) : -ERR_NOT_INITIALIZED; } + int resumeAudioMixing() { return m_parameter ? m_parameter->setBool("che.audio.pause_file_as_playout", false) : -ERR_NOT_INITIALIZED; } - int setPlaybackDeviceVolume(int volume) {// [0,255] - return m_parameter ? m_parameter->setInt("che.audio.output.volume", volume) : -ERR_NOT_INITIALIZED; + int adjustAudioMixingVolume(int volume) { + int ret = adjustAudioMixingPlayoutVolume(volume); + if (ret == 0) { + adjustAudioMixingPublishVolume(volume); } + return ret; + } + int adjustAudioMixingPlayoutVolume(int volume) { return m_parameter ? m_parameter->setInt("che.audio.set_file_as_playout_volume", volume) : -ERR_NOT_INITIALIZED; } - int startAudioRecording(const char* filePath, AUDIO_RECORDING_QUALITY_TYPE quality) { - return startAudioRecording(filePath, 32000, quality); - } - - int startAudioRecording(const char* filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality) { - if (!m_parameter) return -ERR_NOT_INITIALIZED; -#if defined(_WIN32) - util::AString path; - if (!m_parameter->convertPath(filePath, path)) - filePath = path->c_str(); - else - return -ERR_INVALID_ARGUMENT; -#endif - return setObject("che.audio.start_recording", "{\"filePath\":\"%s\",\"sampleRate\":%d,\"quality\":%d}", filePath, sampleRate, quality); - } + int getAudioMixingPlayoutVolume() { + int volume = 0; + int r = m_parameter ? m_parameter->getInt("che.audio.get_file_as_playout_volume", volume) : -ERR_NOT_INITIALIZED; + if (r == 0) r = volume; + return r; + } + int adjustAudioMixingPublishVolume(int volume) { return m_parameter ? m_parameter->setInt("che.audio.set_file_as_playout_publish_volume", volume) : -ERR_NOT_INITIALIZED; } - int stopAudioRecording() { - return m_parameter ? m_parameter->setBool("che.audio.stop_recording", true) : -ERR_NOT_INITIALIZED; - } + int getAudioMixingPublishVolume() { + int volume = 0; + int r = m_parameter ? m_parameter->getInt("che.audio.get_file_as_playout_publish_volume", volume) : -ERR_NOT_INITIALIZED; + if (r == 0) r = volume; + return r; + } + int getAudioMixingDuration() { + int duration = 0; + int r = m_parameter ? m_parameter->getInt("che.audio.get_mixing_file_length_ms", duration) : -ERR_NOT_INITIALIZED; + if (r == 0) r = duration; + return r; + } - int startAudioMixing(const char* filePath, bool loopback, bool replace, int cycle) { - if (!m_parameter) return -ERR_NOT_INITIALIZED; -#if defined(_WIN32) - util::AString path; - if (!m_parameter->convertPath(filePath, path)) - filePath = path->c_str(); - else - return -ERR_INVALID_ARGUMENT; -#endif - return setObject("che.audio.start_file_as_playout", "{\"filePath\":\"%s\",\"loopback\":%s,\"replace\":%s,\"cycle\":%d}", - filePath, - loopback?"true":"false", - replace?"true":"false", - cycle); - } + int getAudioMixingCurrentPosition() { + if (!m_parameter) return -ERR_NOT_INITIALIZED; + int pos = 0; + int r = m_parameter->getInt("che.audio.get_mixing_file_played_ms", pos); + if (r == 0) r = pos; + return r; + } + int setAudioMixingPosition(int pos /*in ms*/) { return m_parameter ? m_parameter->setInt("che.audio.mixing.file.position", pos) : -ERR_NOT_INITIALIZED; } - int stopAudioMixing() { - return m_parameter ? m_parameter->setBool("che.audio.stop_file_as_playout", true) : -ERR_NOT_INITIALIZED; + int setAudioMixingPitch(int pitch) { + if (!m_parameter) { + return -ERR_NOT_INITIALIZED; + } + if (pitch > 12 || pitch < -12) { + return -ERR_INVALID_ARGUMENT; } + return m_parameter->setInt("che.audio.set_playout_file_pitch_semitones", pitch); + } + int getEffectsVolume() { + if (!m_parameter) return -ERR_NOT_INITIALIZED; + int volume = 0; + int r = m_parameter->getInt("che.audio.game_get_effects_volume", volume); + if (r == 0) r = volume; + return r; + } - int pauseAudioMixing() { - return m_parameter ? m_parameter->setBool("che.audio.pause_file_as_playout", true) : -ERR_NOT_INITIALIZED; - } + int setEffectsVolume(int volume) { return m_parameter ? m_parameter->setInt("che.audio.game_set_effects_volume", volume) : -ERR_NOT_INITIALIZED; } + int setVolumeOfEffect(int soundId, int volume) { return setObject("che.audio.game_adjust_effect_volume", "{\"soundId\":%d,\"gain\":%d}", soundId, volume); } - int resumeAudioMixing() { - return m_parameter ? m_parameter->setBool("che.audio.pause_file_as_playout", false) : -ERR_NOT_INITIALIZED; - } + int playEffect(int soundId, const char* filePath, int loopCount, double pitch, double pan, int gain, bool publish = false) { +#if defined(_WIN32) + util::AString path; + if (!m_parameter->convertPath(filePath, path)) + filePath = path->c_str(); + else if (!filePath) + filePath = ""; +#endif + return setObject("che.audio.game_play_effect", "{\"soundId\":%d,\"filePath\":\"%s\",\"loopCount\":%d, \"pitch\":%lf,\"pan\":%lf,\"gain\":%d, \"send2far\":%d}", soundId, filePath, loopCount, pitch, pan, gain, publish); + } + int stopEffect(int soundId) { return m_parameter ? m_parameter->setInt("che.audio.game_stop_effect", soundId) : -ERR_NOT_INITIALIZED; } - int adjustAudioMixingVolume(int volume) { - int ret = adjustAudioMixingPlayoutVolume(volume); - if (ret == 0) { - adjustAudioMixingPublishVolume(volume); - } - return ret; - } + int stopAllEffects() { return m_parameter ? m_parameter->setBool("che.audio.game_stop_all_effects", true) : -ERR_NOT_INITIALIZED; } + int preloadEffect(int soundId, char* filePath) { return setObject("che.audio.game_preload_effect", "{\"soundId\":%d,\"filePath\":\"%s\"}", soundId, filePath); } - int adjustAudioMixingPlayoutVolume(int volume) { - return m_parameter ? m_parameter->setInt("che.audio.set_file_as_playout_volume", volume) : -ERR_NOT_INITIALIZED; - } + int unloadEffect(int soundId) { return m_parameter ? m_parameter->setInt("che.audio.game_unload_effect", soundId) : -ERR_NOT_INITIALIZED; } + int pauseEffect(int soundId) { return m_parameter ? m_parameter->setInt("che.audio.game_pause_effect", soundId) : -ERR_NOT_INITIALIZED; } - int getAudioMixingPlayoutVolume() { - int volume = 0; - int r = m_parameter ? m_parameter->getInt("che.audio.get_file_as_playout_volume", volume) : -ERR_NOT_INITIALIZED; - if (r == 0) - r = volume; - return r; - } + int pauseAllEffects() { return m_parameter ? m_parameter->setBool("che.audio.game_pause_all_effects", true) : -ERR_NOT_INITIALIZED; } + int resumeEffect(int soundId) { return m_parameter ? m_parameter->setInt("che.audio.game_resume_effect", soundId) : -ERR_NOT_INITIALIZED; } - int adjustAudioMixingPublishVolume(int volume) { - return m_parameter ? m_parameter->setInt("che.audio.set_file_as_playout_publish_volume", volume) : -ERR_NOT_INITIALIZED; - } + int resumeAllEffects() { return m_parameter ? m_parameter->setBool("che.audio.game_resume_all_effects", true) : -ERR_NOT_INITIALIZED; } + int enableSoundPositionIndication(bool enabled) { return m_parameter ? m_parameter->setBool("che.audio.enable_sound_position", enabled) : -ERR_NOT_INITIALIZED; } - int getAudioMixingPublishVolume() { - int volume = 0; - int r = m_parameter ? m_parameter->getInt("che.audio.get_file_as_playout_publish_volume", volume) : -ERR_NOT_INITIALIZED; - if (r == 0) - r = volume; - return r; - } + int setRemoteVoicePosition(uid_t uid, double pan, double gain) { return setObject("che.audio.game_place_sound_position", "{\"uid\":%u,\"pan\":%lf,\"gain\":%lf}", uid, pan, gain); } + int setLocalVoicePitch(double pitch) { return m_parameter ? m_parameter->setInt("che.audio.morph.pitch_shift", static_cast(pitch * 100)) : -ERR_NOT_INITIALIZED; } - int getAudioMixingDuration() { - int duration = 0; - int r = m_parameter ? m_parameter->getInt("che.audio.get_mixing_file_length_ms", duration) : -ERR_NOT_INITIALIZED; - if (r == 0) - r = duration; - return r; - } + int setLocalVoiceEqualization(AUDIO_EQUALIZATION_BAND_FREQUENCY bandFrequency, int bandGain) { return setObject("che.audio.morph.equalization", "{\"index\":%d,\"gain\":%d}", static_cast(bandFrequency), bandGain); } + int setLocalVoiceReverb(AUDIO_REVERB_TYPE reverbKey, int value) { return setObject("che.audio.morph.reverb", "{\"key\":%d,\"value\":%d}", static_cast(reverbKey), value); } - int getAudioMixingCurrentPosition() { - if (!m_parameter) return -ERR_NOT_INITIALIZED; - int pos = 0; - int r = m_parameter->getInt("che.audio.get_mixing_file_played_ms", pos); - if (r == 0) - r = pos; - return r; + int setLocalVoiceChanger(VOICE_CHANGER_PRESET voiceChanger) { + if (!m_parameter) return -ERR_NOT_INITIALIZED; + if (voiceChanger == 0x00000000) { + return m_parameter->setInt("che.audio.morph.voice_changer", static_cast(voiceChanger)); + } else if (voiceChanger > 0x00000000 && voiceChanger < 0x00100000) { + return m_parameter->setInt("che.audio.morph.voice_changer", static_cast(voiceChanger)); + } else if (voiceChanger > 0x00100000 && voiceChanger < 0x00200000) { + return m_parameter->setInt("che.audio.morph.voice_changer", static_cast(voiceChanger - 0x00100000 + 6)); + } else if (voiceChanger > 0x00200000 && voiceChanger < 0x00300000) { + return m_parameter->setInt("che.audio.morph.beauty_voice", static_cast(voiceChanger - 0x00200000)); + } else { + return -ERR_INVALID_ARGUMENT; } + } - int setAudioMixingPosition(int pos /*in ms*/) { - return m_parameter ? m_parameter->setInt("che.audio.mixing.file.position", pos) : -ERR_NOT_INITIALIZED; + int setLocalVoiceReverbPreset(AUDIO_REVERB_PRESET reverbPreset) { + if (!m_parameter) return -ERR_NOT_INITIALIZED; + if (reverbPreset == 0x00000000) { + return m_parameter->setInt("che.audio.morph.reverb_preset", static_cast(reverbPreset)); + } else if (reverbPreset > 0x00000000 && reverbPreset < 0x00100000) { + return m_parameter->setInt("che.audio.morph.reverb_preset", static_cast(reverbPreset + 8)); + } else if (reverbPreset > 0x00100000 && reverbPreset < 0x00200000) { + return m_parameter->setInt("che.audio.morph.reverb_preset", static_cast(reverbPreset - 0x00100000)); + } else if (reverbPreset > 0x00200000 && reverbPreset < 0x00200002) { + return m_parameter->setInt("che.audio.morph.virtual_stereo", static_cast(reverbPreset - 0x00200000)); + } else if (reverbPreset > (AUDIO_REVERB_PRESET)0x00300000 && reverbPreset < (AUDIO_REVERB_PRESET)0x00300002) + return setObject("che.audio.morph.electronic_voice", "{\"key\":%d,\"value\":%d}", 1, 4); + else if (reverbPreset > (AUDIO_REVERB_PRESET)0x00400000 && reverbPreset < (AUDIO_REVERB_PRESET)0x00400002) + return m_parameter->setInt("che.audio.morph.threedim_voice", 10); + else { + return -ERR_INVALID_ARGUMENT; } + } - int setAudioMixingPitch(int pitch) { - if (!m_parameter) { - return -ERR_NOT_INITIALIZED; - } - if (pitch > 12 || pitch < -12) { - return -ERR_INVALID_ARGUMENT; - } - return m_parameter->setInt("che.audio.set_playout_file_pitch_semitones", pitch); + int setAudioEffectPreset(AUDIO_EFFECT_PRESET preset) { + if (!m_parameter) return -ERR_NOT_INITIALIZED; + if (preset == AUDIO_EFFECT_OFF) { + return m_parameter->setInt("che.audio.morph.voice_changer", 0); } - - int getEffectsVolume() { - if (!m_parameter) return -ERR_NOT_INITIALIZED; - int volume = 0; - int r = m_parameter->getInt("che.audio.game_get_effects_volume", volume); - if (r == 0) - r = volume; - return r; + if (preset == ROOM_ACOUSTICS_KTV) { + return m_parameter->setInt("che.audio.morph.reverb_preset", 1); } - - - int setEffectsVolume(int volume) { - return m_parameter ? m_parameter->setInt("che.audio.game_set_effects_volume", volume) : -ERR_NOT_INITIALIZED; + if (preset == ROOM_ACOUSTICS_VOCAL_CONCERT) { + return m_parameter->setInt("che.audio.morph.reverb_preset", 2); } - - - int setVolumeOfEffect(int soundId, int volume) { - return setObject( - "che.audio.game_adjust_effect_volume", - "{\"soundId\":%d,\"gain\":%d}", - soundId, volume); + if (preset == ROOM_ACOUSTICS_STUDIO) { + return m_parameter->setInt("che.audio.morph.reverb_preset", 5); } - - - int playEffect(int soundId, const char* filePath, int loopCount, double pitch, double pan, int gain, bool publish = false) { -#if defined(_WIN32) - util::AString path; - if (!m_parameter->convertPath(filePath, path)) - filePath = path->c_str(); - else if (!filePath) - filePath = ""; -#endif - return setObject( - "che.audio.game_play_effect", - "{\"soundId\":%d,\"filePath\":\"%s\",\"loopCount\":%d, \"pitch\":%lf,\"pan\":%lf,\"gain\":%d, \"send2far\":%d}", - soundId, filePath, loopCount, pitch, pan, gain, publish); + if (preset == ROOM_ACOUSTICS_PHONOGRAPH) { + return m_parameter->setInt("che.audio.morph.reverb_preset", 8); } - - - int stopEffect(int soundId) { - return m_parameter ? m_parameter->setInt( - "che.audio.game_stop_effect", soundId) : -ERR_NOT_INITIALIZED; + if (preset == ROOM_ACOUSTICS_VIRTUAL_STEREO) { + return m_parameter->setInt("che.audio.morph.virtual_stereo", 1); } - - - int stopAllEffects() { - return m_parameter ? m_parameter->setBool( - "che.audio.game_stop_all_effects", true) : -ERR_NOT_INITIALIZED; + if (preset == ROOM_ACOUSTICS_SPACIAL) { + return m_parameter->setInt("che.audio.morph.voice_changer", 15); } - - - int preloadEffect(int soundId, char* filePath) { - return setObject( - "che.audio.game_preload_effect", - "{\"soundId\":%d,\"filePath\":\"%s\"}", - soundId, filePath); + if (preset == ROOM_ACOUSTICS_ETHEREAL) { + return m_parameter->setInt("che.audio.morph.voice_changer", 5); } - - - int unloadEffect(int soundId) { - return m_parameter ? m_parameter->setInt( - "che.audio.game_unload_effect", soundId) : -ERR_NOT_INITIALIZED; + if (preset == ROOM_ACOUSTICS_3D_VOICE) { + return m_parameter->setInt("che.audio.morph.threedim_voice", 10); } - - - int pauseEffect(int soundId) { - return m_parameter ? m_parameter->setInt( - "che.audio.game_pause_effect", soundId) : -ERR_NOT_INITIALIZED; + if (preset == VOICE_CHANGER_EFFECT_UNCLE) { + return m_parameter->setInt("che.audio.morph.reverb_preset", 3); } - - - int pauseAllEffects() { - return m_parameter ? m_parameter->setBool( - "che.audio.game_pause_all_effects", true) : -ERR_NOT_INITIALIZED; + if (preset == VOICE_CHANGER_EFFECT_OLDMAN) { + return m_parameter->setInt("che.audio.morph.voice_changer", 1); } - - - int resumeEffect(int soundId) { - return m_parameter ? m_parameter->setInt( - "che.audio.game_resume_effect", soundId) : -ERR_NOT_INITIALIZED; + if (preset == VOICE_CHANGER_EFFECT_BOY) { + return m_parameter->setInt("che.audio.morph.voice_changer", 2); } - - - int resumeAllEffects() { - return m_parameter ? m_parameter->setBool( - "che.audio.game_resume_all_effects", true) : -ERR_NOT_INITIALIZED; + if (preset == VOICE_CHANGER_EFFECT_SISTER) { + return m_parameter->setInt("che.audio.morph.reverb_preset", 4); } - - - int enableSoundPositionIndication(bool enabled) { - return m_parameter ? m_parameter->setBool( - "che.audio.enable_sound_position", enabled) : -ERR_NOT_INITIALIZED; + if (preset == VOICE_CHANGER_EFFECT_GIRL) { + return m_parameter->setInt("che.audio.morph.voice_changer", 3); } - - - int setRemoteVoicePosition(uid_t uid, double pan, double gain) { - return setObject("che.audio.game_place_sound_position", "{\"uid\":%u,\"pan\":%lf,\"gain\":%lf}", uid, pan, gain); + if (preset == VOICE_CHANGER_EFFECT_PIGKING) { + return m_parameter->setInt("che.audio.morph.voice_changer", 4); } - - - int setLocalVoicePitch(double pitch) { - return m_parameter ? m_parameter->setInt( - "che.audio.morph.pitch_shift", - static_cast(pitch * 100)) : -ERR_NOT_INITIALIZED; + if (preset == VOICE_CHANGER_EFFECT_HULK) { + return m_parameter->setInt("che.audio.morph.voice_changer", 6); } - - int setLocalVoiceEqualization(AUDIO_EQUALIZATION_BAND_FREQUENCY bandFrequency, int bandGain) { - return setObject( - "che.audio.morph.equalization", - "{\"index\":%d,\"gain\":%d}", - static_cast(bandFrequency), bandGain); + if (preset == STYLE_TRANSFORMATION_RNB) { + return m_parameter->setInt("che.audio.morph.reverb_preset", 7); } - - int setLocalVoiceReverb(AUDIO_REVERB_TYPE reverbKey, int value) { - return setObject( - "che.audio.morph.reverb", - "{\"key\":%d,\"value\":%d}", - static_cast(reverbKey), value); + if (preset == STYLE_TRANSFORMATION_POPULAR) { + return m_parameter->setInt("che.audio.morph.reverb_preset", 6); } - - - int setLocalVoiceChanger(VOICE_CHANGER_PRESET voiceChanger) { - if(!m_parameter) - return -ERR_NOT_INITIALIZED; - if(voiceChanger == 0x00000000) { - return m_parameter->setInt("che.audio.morph.voice_changer", static_cast(voiceChanger)); - } - else if(voiceChanger > 0x00000000 && voiceChanger < 0x00100000) { - return m_parameter->setInt("che.audio.morph.voice_changer", static_cast(voiceChanger)); - } - else if(voiceChanger > 0x00100000 && voiceChanger < 0x00200000) { - return m_parameter->setInt("che.audio.morph.voice_changer", static_cast(voiceChanger - 0x00100000 + 6)); - } - else if(voiceChanger > 0x00200000 && voiceChanger < 0x00300000) { - return m_parameter->setInt("che.audio.morph.beauty_voice", static_cast(voiceChanger - 0x00200000)); - } - else { - return -ERR_INVALID_ARGUMENT; - } + if (preset == PITCH_CORRECTION) { + return setObject("che.audio.morph.electronic_voice", "{\"key\":%d,\"value\":%d}", 1, 4); } + return -ERR_INVALID_ARGUMENT; + } - - int setLocalVoiceReverbPreset(AUDIO_REVERB_PRESET reverbPreset) { - if(!m_parameter) - return -ERR_NOT_INITIALIZED; - if(reverbPreset == 0x00000000) { - return m_parameter->setInt("che.audio.morph.reverb_preset", static_cast(reverbPreset)); - } - else if(reverbPreset > 0x00000000 && reverbPreset < 0x00100000) { - return m_parameter->setInt("che.audio.morph.reverb_preset", static_cast(reverbPreset + 8)); - } - else if(reverbPreset > 0x00100000 && reverbPreset < 0x00200000) { - return m_parameter->setInt("che.audio.morph.reverb_preset", static_cast(reverbPreset - 0x00100000)); - } - else if(reverbPreset > 0x00200000 && reverbPreset < 0x00200002) { - return m_parameter->setInt("che.audio.morph.virtual_stereo", static_cast(reverbPreset - 0x00200000)); - } - else if (reverbPreset > (AUDIO_REVERB_PRESET) 0x00300000 && reverbPreset < (AUDIO_REVERB_PRESET) 0x00300002) - return setObject( "che.audio.morph.electronic_voice", "{\"key\":%d,\"value\":%d}", 1, 4); - else if (reverbPreset > (AUDIO_REVERB_PRESET) 0x00400000 && reverbPreset < (AUDIO_REVERB_PRESET) 0x00400002) - return m_parameter->setInt("che.audio.morph.threedim_voice", 10); - else { - return -ERR_INVALID_ARGUMENT; - } + int setVoiceBeautifierPreset(VOICE_BEAUTIFIER_PRESET preset) { + if (!m_parameter) return -ERR_NOT_INITIALIZED; + if (preset == VOICE_BEAUTIFIER_OFF) { + return m_parameter->setInt("che.audio.morph.voice_changer", 0); } - - int setAudioEffectPreset(AUDIO_EFFECT_PRESET preset){ - if(!m_parameter) - return -ERR_NOT_INITIALIZED; - if(preset == AUDIO_EFFECT_OFF) { - return m_parameter->setInt("che.audio.morph.voice_changer", 0); - } - if(preset == ROOM_ACOUSTICS_KTV){ - return m_parameter->setInt("che.audio.morph.reverb_preset", 1); - } - if(preset == ROOM_ACOUSTICS_VOCAL_CONCERT) { - return m_parameter->setInt("che.audio.morph.reverb_preset", 2); - } - if(preset == ROOM_ACOUSTICS_STUDIO) { - return m_parameter->setInt("che.audio.morph.reverb_preset", 5); - } - if(preset == ROOM_ACOUSTICS_PHONOGRAPH) { - return m_parameter->setInt("che.audio.morph.reverb_preset", 8); - } - if(preset == ROOM_ACOUSTICS_VIRTUAL_STEREO) { - return m_parameter->setInt("che.audio.morph.virtual_stereo", 1); - } - if(preset == ROOM_ACOUSTICS_SPACIAL) { - return m_parameter->setInt("che.audio.morph.voice_changer", 15); - } - if(preset == ROOM_ACOUSTICS_ETHEREAL) { - return m_parameter->setInt("che.audio.morph.voice_changer", 5); - } - if(preset == ROOM_ACOUSTICS_3D_VOICE) { - return m_parameter->setInt("che.audio.morph.threedim_voice", 10); - } - if(preset == VOICE_CHANGER_EFFECT_UNCLE) { - return m_parameter->setInt("che.audio.morph.reverb_preset", 3); - } - if(preset == VOICE_CHANGER_EFFECT_OLDMAN) { - return m_parameter->setInt("che.audio.morph.voice_changer", 1); - } - if(preset == VOICE_CHANGER_EFFECT_BOY) { - return m_parameter->setInt("che.audio.morph.voice_changer", 2); - } - if(preset == VOICE_CHANGER_EFFECT_SISTER) { - return m_parameter->setInt("che.audio.morph.reverb_preset", 4); - } - if(preset == VOICE_CHANGER_EFFECT_GIRL) { - return m_parameter->setInt("che.audio.morph.voice_changer", 3); - } - if(preset == VOICE_CHANGER_EFFECT_PIGKING) { - return m_parameter->setInt("che.audio.morph.voice_changer", 4); - } - if(preset == VOICE_CHANGER_EFFECT_HULK) { - return m_parameter->setInt("che.audio.morph.voice_changer", 6); - } - if(preset == STYLE_TRANSFORMATION_RNB) { - return m_parameter->setInt("che.audio.morph.reverb_preset", 7); - } - if(preset == STYLE_TRANSFORMATION_POPULAR) { - return m_parameter->setInt("che.audio.morph.reverb_preset", 6); - } - if(preset == PITCH_CORRECTION) { - return setObject( "che.audio.morph.electronic_voice", "{\"key\":%d,\"value\":%d}", 1, 4); - } - return -ERR_INVALID_ARGUMENT; + if (preset == CHAT_BEAUTIFIER_MAGNETIC) { + return m_parameter->setInt("che.audio.morph.beauty_voice", 1); } - - int setVoiceBeautifierPreset(VOICE_BEAUTIFIER_PRESET preset) { - if(!m_parameter) - return -ERR_NOT_INITIALIZED; - if(preset == VOICE_BEAUTIFIER_OFF) { - return m_parameter->setInt("che.audio.morph.voice_changer", 0); - } - if(preset == CHAT_BEAUTIFIER_MAGNETIC) { - return m_parameter->setInt("che.audio.morph.beauty_voice", 1); - } - if(preset == CHAT_BEAUTIFIER_FRESH) { - return m_parameter->setInt("che.audio.morph.beauty_voice", 2); - } - if(preset == CHAT_BEAUTIFIER_VITALITY) { - return m_parameter->setInt("che.audio.morph.beauty_voice", 3); - } - /*if(preset == SINGING_BEAUTIFICATION_MAN) { - return m_parameter->setInt("che.audio.morph.beauty_sing", 1); - } - if(preset == SINGING_BEAUTIFICATION_WOMAN) { - return m_parameter->setInt("che.audio.morph.beauty_sing", 2); - }*/ - if(preset == TIMBRE_TRANSFORMATION_VIGOROUS) { - return m_parameter->setInt("che.audio.morph.voice_changer", 7); - } - if(preset == TIMBRE_TRANSFORMATION_DEEP) { - return m_parameter->setInt("che.audio.morph.voice_changer", 8); - } - if(preset == TIMBRE_TRANSFORMATION_MELLOW) { - return m_parameter->setInt("che.audio.morph.voice_changer", 9); - } - if(preset == TIMBRE_TRANSFORMATION_FALSETTO) { - return m_parameter->setInt("che.audio.morph.voice_changer", 10); - } - if(preset == TIMBRE_TRANSFORMATION_FULL) { - return m_parameter->setInt("che.audio.morph.voice_changer", 11); - } - if(preset == TIMBRE_TRANSFORMATION_CLEAR) { - return m_parameter->setInt("che.audio.morph.voice_changer", 12); - } - if(preset == TIMBRE_TRANSFORMATION_RESOUNDING) { - return m_parameter->setInt("che.audio.morph.voice_changer", 13); - } - if(preset == TIMBRE_TRANSFORMATION_RINGING) { - return m_parameter->setInt("che.audio.morph.voice_changer", 14); - } - return -ERR_INVALID_ARGUMENT; + if (preset == CHAT_BEAUTIFIER_FRESH) { + return m_parameter->setInt("che.audio.morph.beauty_voice", 2); } - - int setAudioEffectParameters(AUDIO_EFFECT_PRESET preset, int param1, int param2){ - if(!m_parameter) - return -ERR_NOT_INITIALIZED; - if(preset == PITCH_CORRECTION){ - return setObject( "che.audio.morph.electronic_voice", "{\"key\":%d,\"value\":%d}", param1, param2); - } - if(preset == ROOM_ACOUSTICS_3D_VOICE){ - return m_parameter->setInt("che.audio.morph.threedim_voice", param1); - } - return -ERR_INVALID_ARGUMENT; + if (preset == CHAT_BEAUTIFIER_VITALITY) { + return m_parameter->setInt("che.audio.morph.beauty_voice", 3); } - - /** **DEPRECATED** Use \ref IRtcEngine::disableAudio "disableAudio" instead. Disables the audio function in the channel. - - @return - - 0: Success. - - < 0: Failure. - */ - int pauseAudio() { - return m_parameter ? m_parameter->setBool("che.pause.audio", true) : -ERR_NOT_INITIALIZED; + if (preset == SINGING_BEAUTIFIER) { + return setObject("che.audio.morph.beauty_sing", "{\"key\":%d,\"value\":%d}", 1, 1); } - - - int resumeAudio() { - return m_parameter ? m_parameter->setBool("che.pause.audio", false) : -ERR_NOT_INITIALIZED; + if (preset == TIMBRE_TRANSFORMATION_VIGOROUS) { + return m_parameter->setInt("che.audio.morph.voice_changer", 7); } - - - int setHighQualityAudioParameters(bool fullband, bool stereo, bool fullBitrate) { - return setObject("che.audio.codec.hq", "{\"fullband\":%s,\"stereo\":%s,\"fullBitrate\":%s}", fullband ? "true" : "false", stereo ? "true" : "false", fullBitrate ? "true" : "false"); + if (preset == TIMBRE_TRANSFORMATION_DEEP) { + return m_parameter->setInt("che.audio.morph.voice_changer", 8); } - - - int adjustRecordingSignalVolume(int volume) {//[0, 400]: e.g. 50~0.5x 100~1x 400~4x - if (volume < 0) - volume = 0; - else if (volume > 400) - volume = 400; - return m_parameter ? m_parameter->setInt("che.audio.record.signal.volume", volume) : -ERR_NOT_INITIALIZED; + if (preset == TIMBRE_TRANSFORMATION_MELLOW) { + return m_parameter->setInt("che.audio.morph.voice_changer", 9); } - - - int adjustPlaybackSignalVolume(int volume) {//[0, 400] - if (volume < 0) - volume = 0; - else if (volume > 400) - volume = 400; - return m_parameter ? m_parameter->setInt("che.audio.playout.signal.volume", volume) : -ERR_NOT_INITIALIZED; + if (preset == TIMBRE_TRANSFORMATION_FALSETTO) { + return m_parameter->setInt("che.audio.morph.voice_changer", 10); } - - - int enableAudioVolumeIndication(int interval, int smooth, bool report_vad) { // in ms: <= 0: disable, > 0: enable, interval in ms - if (interval < 0) - interval = 0; - return setObject("che.audio.volume_indication", "{\"interval\":%d,\"smooth\":%d,\"vad\":%d}", interval, smooth, report_vad); + if (preset == TIMBRE_TRANSFORMATION_FULL) { + return m_parameter->setInt("che.audio.morph.voice_changer", 11); } - - - int muteLocalAudioStream(bool mute) { - return setParameters("{\"rtc.audio.mute_me\":%s,\"che.audio.mute_me\":%s}", mute ? "true" : "false", mute ? "true" : "false"); + if (preset == TIMBRE_TRANSFORMATION_CLEAR) { + return m_parameter->setInt("che.audio.morph.voice_changer", 12); } - // mute/unmute all peers. unmute will clear all muted peers specified mutePeer() interface - - - int muteRemoteAudioStream(uid_t uid, bool mute) { - return setObject("rtc.audio.mute_peer", "{\"uid\":%u,\"mute\":%s}", uid, mute?"true":"false"); + if (preset == TIMBRE_TRANSFORMATION_RESOUNDING) { + return m_parameter->setInt("che.audio.morph.voice_changer", 13); } - - - int muteAllRemoteAudioStreams(bool mute) { - return m_parameter ? m_parameter->setBool("rtc.audio.mute_peers", mute) : -ERR_NOT_INITIALIZED; + if (preset == TIMBRE_TRANSFORMATION_RINGING) { + return m_parameter->setInt("che.audio.morph.voice_changer", 14); } + return -ERR_INVALID_ARGUMENT; + } - - int setDefaultMuteAllRemoteAudioStreams(bool mute) { - return m_parameter ? m_parameter->setBool("rtc.audio.set_default_mute_peers", mute) : -ERR_NOT_INITIALIZED; + int setAudioEffectParameters(AUDIO_EFFECT_PRESET preset, int param1, int param2) { + if (!m_parameter) return -ERR_NOT_INITIALIZED; + if (preset == PITCH_CORRECTION) { + return setObject("che.audio.morph.electronic_voice", "{\"key\":%d,\"value\":%d}", param1, param2); } - - - int setExternalAudioSource(bool enabled, int sampleRate, int channels) { - if (enabled) - return setParameters("{\"che.audio.external_capture\":true,\"che.audio.external_capture.push\":true,\"che.audio.set_capture_raw_audio_format\":{\"sampleRate\":%d,\"channelCnt\":%d,\"mode\":%d}}", sampleRate, channels, RAW_AUDIO_FRAME_OP_MODE_TYPE::RAW_AUDIO_FRAME_OP_MODE_READ_WRITE); - else - return setParameters("{\"che.audio.external_capture\":false,\"che.audio.external_capture.push\":false}"); + if (preset == ROOM_ACOUSTICS_3D_VOICE) { + return m_parameter->setInt("che.audio.morph.threedim_voice", param1); } + return -ERR_INVALID_ARGUMENT; + } - - int setExternalAudioSink(bool enabled, int sampleRate, int channels) { - if (enabled) - return setParameters("{\"che.audio.external_render\":true,\"che.audio.external_render.pull\":true,\"che.audio.set_render_raw_audio_format\":{\"sampleRate\":%d,\"channelCnt\":%d,\"mode\":%d}}", sampleRate, channels, RAW_AUDIO_FRAME_OP_MODE_TYPE::RAW_AUDIO_FRAME_OP_MODE_READ_ONLY); - else - return setParameters("{\"che.audio.external_render\":false,\"che.audio.external_render.pull\":false}"); + int setVoiceBeautifierParameters(VOICE_BEAUTIFIER_PRESET preset, int param1, int param2) { + if (!m_parameter) return -ERR_NOT_INITIALIZED; + if (preset == SINGING_BEAUTIFIER) { + return setObject("che.audio.morph.beauty_sing", "{\"key\":%d,\"value\":%d}", param1, param2); } + return -ERR_INVALID_ARGUMENT; + } + /** **DEPRECATED** Use \ref IRtcEngine::disableAudio "disableAudio" instead. Disables the audio function in the channel. - int setLogFile(const char* filePath) { - if (!m_parameter) return -ERR_NOT_INITIALIZED; -#if defined(_WIN32) - util::AString path; - if (!m_parameter->convertPath(filePath, path)) - filePath = path->c_str(); - else if (!filePath) - filePath = ""; -#endif - return m_parameter->setString("rtc.log_file", filePath); - } - + @return + - 0: Success. + - < 0: Failure. + */ + int pauseAudio() { return m_parameter ? m_parameter->setBool("che.pause.audio", true) : -ERR_NOT_INITIALIZED; } - int setLogFilter(unsigned int filter) { - return m_parameter ? m_parameter->setUInt("rtc.log_filter", filter&LOG_FILTER_MASK) : -ERR_NOT_INITIALIZED; - } + int resumeAudio() { return m_parameter ? m_parameter->setBool("che.pause.audio", false) : -ERR_NOT_INITIALIZED; } + int setHighQualityAudioParameters(bool fullband, bool stereo, bool fullBitrate) { return setObject("che.audio.codec.hq", "{\"fullband\":%s,\"stereo\":%s,\"fullBitrate\":%s}", fullband ? "true" : "false", stereo ? "true" : "false", fullBitrate ? "true" : "false"); } - int setLogFileSize(unsigned int fileSizeInKBytes) { - return m_parameter ? m_parameter->setUInt("rtc.log_size", fileSizeInKBytes) : -ERR_NOT_INITIALIZED; - } + int adjustRecordingSignalVolume(int volume) { //[0, 400]: e.g. 50~0.5x 100~1x 400~4x + if (volume < 0) + volume = 0; + else if (volume > 400) + volume = 400; + return m_parameter ? m_parameter->setInt("che.audio.record.signal.volume", volume) : -ERR_NOT_INITIALIZED; + } + int adjustPlaybackSignalVolume(int volume) { //[0, 400] + if (volume < 0) + volume = 0; + else if (volume > 400) + volume = 400; + return m_parameter ? m_parameter->setInt("che.audio.playout.signal.volume", volume) : -ERR_NOT_INITIALIZED; + } - int setLocalRenderMode(RENDER_MODE_TYPE renderMode) { - return setRemoteRenderMode(0, renderMode); - } + int enableAudioVolumeIndication(int interval, int smooth, bool report_vad) { // in ms: <= 0: disable, > 0: enable, interval in ms + if (interval < 0) interval = 0; + return setObject("che.audio.volume_indication", "{\"interval\":%d,\"smooth\":%d,\"vad\":%d}", interval, smooth, report_vad); + } + int muteLocalAudioStream(bool mute) { return setParameters("{\"rtc.audio.mute_me\":%s}", mute ? "true" : "false"); } + // mute/unmute all peers. unmute will clear all muted peers specified mutePeer() interface - int setRemoteRenderMode(uid_t uid, RENDER_MODE_TYPE renderMode) { - return setParameters("{\"che.video.render_mode\":[{\"uid\":%u,\"renderMode\":%d}]}", uid, renderMode); - } + int muteRemoteAudioStream(uid_t uid, bool mute) { return setObject("rtc.audio.mute_peer", "{\"uid\":%u,\"mute\":%s}", uid, mute ? "true" : "false"); } + int muteAllRemoteAudioStreams(bool mute) { return m_parameter ? m_parameter->setBool("rtc.audio.mute_peers", mute) : -ERR_NOT_INITIALIZED; } - int setCameraCapturerConfiguration(const CameraCapturerConfiguration& config) { - if (!m_parameter) return -ERR_NOT_INITIALIZED; - return m_parameter->setInt("che.video.camera_capture_mode", (int)config.preference); + int setVoiceConversionPreset(VOICE_CONVERSION_PRESET preset) { + if (!m_parameter) return -ERR_NOT_INITIALIZED; + if (preset == VOICE_CONVERSION_OFF) { + return m_parameter->setInt("che.audio.morph.voice_changer", 0); } - - - int enableDualStreamMode(bool enabled) { - return setParameters("{\"rtc.dual_stream_mode\":%s,\"che.video.enableLowBitRateStream\":%d}", enabled ? "true" : "false", enabled ? 1 : 0); + if (preset == VOICE_CHANGER_NEUTRAL) { + return m_parameter->setInt("che.audio.morph.vocal_changer", 1); + } + if (preset == VOICE_CHANGER_SWEET) { + return m_parameter->setInt("che.audio.morph.vocal_changer", 2); } + if (preset == VOICE_CHANGER_SOLID) { + return m_parameter->setInt("che.audio.morph.vocal_changer", 3); + } + if (preset == VOICE_CHANGER_BASS) { + return m_parameter->setInt("che.audio.morph.vocal_changer", 4); + } + return -ERR_INVALID_ARGUMENT; + } + int setDefaultMuteAllRemoteAudioStreams(bool mute) { return m_parameter ? m_parameter->setBool("rtc.audio.set_default_mute_peers", mute) : -ERR_NOT_INITIALIZED; } - int setRemoteVideoStreamType(uid_t uid, REMOTE_VIDEO_STREAM_TYPE streamType) { - return setParameters("{\"rtc.video.set_remote_video_stream\":{\"uid\":%u,\"stream\":%d}, \"che.video.setstream\":{\"uid\":%u,\"stream\":%d}}", uid, streamType, uid, streamType); -// return setObject("rtc.video.set_remote_video_stream", "{\"uid\":%u,\"stream\":%d}", uid, streamType); - } + int setExternalAudioSource(bool enabled, int sampleRate, int channels) { + if (enabled) + return setParameters("{\"che.audio.external_capture\":true,\"che.audio.external_capture.push\":true,\"che.audio.set_capture_raw_audio_format\":{\"sampleRate\":%d,\"channelCnt\":%d,\"mode\":%d}}", sampleRate, channels, RAW_AUDIO_FRAME_OP_MODE_TYPE::RAW_AUDIO_FRAME_OP_MODE_READ_WRITE); + else + return setParameters("{\"che.audio.external_capture\":false,\"che.audio.external_capture.push\":false}"); + } + int setExternalAudioSink(bool enabled, int sampleRate, int channels) { + if (enabled) + return setParameters("{\"che.audio.external_render\":true,\"che.audio.external_render.pull\":true,\"che.audio.set_render_raw_audio_format\":{\"sampleRate\":%d,\"channelCnt\":%d,\"mode\":%d}}", sampleRate, channels, RAW_AUDIO_FRAME_OP_MODE_TYPE::RAW_AUDIO_FRAME_OP_MODE_READ_ONLY); + else + return setParameters("{\"che.audio.external_render\":false,\"che.audio.external_render.pull\":false}"); + } - int setRemoteDefaultVideoStreamType(REMOTE_VIDEO_STREAM_TYPE streamType) { - return m_parameter ? m_parameter->setInt("rtc.video.set_remote_default_video_stream_type", streamType) : -ERR_NOT_INITIALIZED; - } + int setLogFile(const char* filePath) { + if (!m_parameter) return -ERR_NOT_INITIALIZED; +#if defined(_WIN32) + util::AString path; + if (!m_parameter->convertPath(filePath, path)) + filePath = path->c_str(); + else if (!filePath) + filePath = ""; +#endif + return m_parameter->setString("rtc.log_file", filePath); + } + int setLogFilter(unsigned int filter) { return m_parameter ? m_parameter->setUInt("rtc.log_filter", filter & LOG_FILTER_MASK) : -ERR_NOT_INITIALIZED; } - int setRecordingAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall) { - return setObject("che.audio.set_capture_raw_audio_format", "{\"sampleRate\":%d,\"channelCnt\":%d,\"mode\":%d,\"samplesPerCall\":%d}", sampleRate, channel, mode, samplesPerCall); - } + int setLogFileSize(unsigned int fileSizeInKBytes) { return m_parameter ? m_parameter->setUInt("rtc.log_size", fileSizeInKBytes) : -ERR_NOT_INITIALIZED; } - int setPlaybackAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall) { - return setObject("che.audio.set_render_raw_audio_format", "{\"sampleRate\":%d,\"channelCnt\":%d,\"mode\":%d,\"samplesPerCall\":%d}", sampleRate, channel, mode, samplesPerCall); - } + int setLocalRenderMode(RENDER_MODE_TYPE renderMode) { return setRemoteRenderMode(0, renderMode); } - int setMixedAudioFrameParameters(int sampleRate, int samplesPerCall) { - return setObject("che.audio.set_mixed_raw_audio_format", "{\"sampleRate\":%d,\"samplesPerCall\":%d}", sampleRate, samplesPerCall); + int setRemoteRenderMode(uid_t uid, RENDER_MODE_TYPE renderMode) { return setParameters("{\"che.video.render_mode\":[{\"uid\":%u,\"renderMode\":%d}]}", uid, renderMode); } + + int setCameraCapturerConfiguration(const CameraCapturerConfiguration& config) { + if (!m_parameter) return -ERR_NOT_INITIALIZED; + if (config.preference == CAPTURER_OUTPUT_PREFERENCE_MANUAL) { + m_parameter->setInt("che.video.capture_width", config.captureWidth); + m_parameter->setInt("che.video.capture_height", config.captureHeight); } + return m_parameter->setInt("che.video.camera_capture_mode", (int)config.preference); + } + int enableDualStreamMode(bool enabled) { return setParameters("{\"rtc.dual_stream_mode\":%s,\"che.video.enableLowBitRateStream\":%d}", enabled ? "true" : "false", enabled ? 1 : 0); } - int enableWebSdkInteroperability(bool enabled) {//enable interoperability with zero-plugin web sdk - return setParameters("{\"rtc.video.web_h264_interop_enable\":%s,\"che.video.web_h264_interop_enable\":%s}", enabled ? "true" : "false", enabled ? "true" : "false"); - } + int setRemoteVideoStreamType(uid_t uid, REMOTE_VIDEO_STREAM_TYPE streamType) { + return setParameters("{\"rtc.video.set_remote_video_stream\":{\"uid\":%u,\"stream\":%d}, \"che.video.setstream\":{\"uid\":%u,\"stream\":%d}}", uid, streamType, uid, streamType); + // return setObject("rtc.video.set_remote_video_stream", "{\"uid\":%u,\"stream\":%d}", uid, streamType); + } - //only for live broadcast + int setRemoteDefaultVideoStreamType(REMOTE_VIDEO_STREAM_TYPE streamType) { return m_parameter ? m_parameter->setInt("rtc.video.set_remote_default_video_stream_type", streamType) : -ERR_NOT_INITIALIZED; } - int setVideoQualityParameters(bool preferFrameRateOverImageQuality) { - return setParameters("{\"rtc.video.prefer_frame_rate\":%s,\"che.video.prefer_frame_rate\":%s}", preferFrameRateOverImageQuality ? "true" : "false", preferFrameRateOverImageQuality ? "true" : "false"); - } + int setRecordingAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall) { return setObject("che.audio.set_capture_raw_audio_format", "{\"sampleRate\":%d,\"channelCnt\":%d,\"mode\":%d,\"samplesPerCall\":%d}", sampleRate, channel, mode, samplesPerCall); } + int setPlaybackAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall) { return setObject("che.audio.set_render_raw_audio_format", "{\"sampleRate\":%d,\"channelCnt\":%d,\"mode\":%d,\"samplesPerCall\":%d}", sampleRate, channel, mode, samplesPerCall); } - int setLocalVideoMirrorMode(VIDEO_MIRROR_MODE_TYPE mirrorMode) { - if (!m_parameter) return -ERR_NOT_INITIALIZED; - const char *value; - switch (mirrorMode) { - case VIDEO_MIRROR_MODE_AUTO: - value = "default"; - break; - case VIDEO_MIRROR_MODE_ENABLED: - value = "forceMirror"; - break; - case VIDEO_MIRROR_MODE_DISABLED: - value = "disableMirror"; - break; - default: - return -ERR_INVALID_ARGUMENT; - } - return m_parameter->setString("che.video.localViewMirrorSetting", value); - } + int setMixedAudioFrameParameters(int sampleRate, int samplesPerCall) { return setObject("che.audio.set_mixed_raw_audio_format", "{\"sampleRate\":%d,\"samplesPerCall\":%d}", sampleRate, samplesPerCall); } + int enableWebSdkInteroperability(bool enabled) { // enable interoperability with zero-plugin web sdk + return setParameters("{\"rtc.video.web_h264_interop_enable\":%s,\"che.video.web_h264_interop_enable\":%s}", enabled ? "true" : "false", enabled ? "true" : "false"); + } - int setLocalPublishFallbackOption(STREAM_FALLBACK_OPTIONS option) { - return m_parameter ? m_parameter->setInt("rtc.local_publish_fallback_option", option) : -ERR_NOT_INITIALIZED; + // only for live broadcast + + int setVideoQualityParameters(bool preferFrameRateOverImageQuality) { return setParameters("{\"rtc.video.prefer_frame_rate\":%s,\"che.video.prefer_frame_rate\":%s}", preferFrameRateOverImageQuality ? "true" : "false", preferFrameRateOverImageQuality ? "true" : "false"); } + + int setLocalVideoMirrorMode(VIDEO_MIRROR_MODE_TYPE mirrorMode) { + if (!m_parameter) return -ERR_NOT_INITIALIZED; + const char* value; + switch (mirrorMode) { + case VIDEO_MIRROR_MODE_AUTO: + value = "default"; + break; + case VIDEO_MIRROR_MODE_ENABLED: + value = "forceMirror"; + break; + case VIDEO_MIRROR_MODE_DISABLED: + value = "disableMirror"; + break; + default: + return -ERR_INVALID_ARGUMENT; } + return m_parameter->setString("che.video.localViewMirrorSetting", value); + } + int setLocalPublishFallbackOption(STREAM_FALLBACK_OPTIONS option) { return m_parameter ? m_parameter->setInt("rtc.local_publish_fallback_option", option) : -ERR_NOT_INITIALIZED; } - int setRemoteSubscribeFallbackOption(STREAM_FALLBACK_OPTIONS option) { - return m_parameter ? m_parameter->setInt("rtc.remote_subscribe_fallback_option", option) : -ERR_NOT_INITIALIZED; - } + int setRemoteSubscribeFallbackOption(STREAM_FALLBACK_OPTIONS option) { return m_parameter ? m_parameter->setInt("rtc.remote_subscribe_fallback_option", option) : -ERR_NOT_INITIALIZED; } #if (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE) || defined(_WIN32) - int enableLoopbackRecording(bool enabled, const char* deviceName = NULL) { - if (!deviceName) { - return setParameters("{\"che.audio.loopback.recording\":%s}", enabled ? "true" : "false"); - } - else { - return setParameters("{\"che.audio.loopback.deviceName\":\"%s\",\"che.audio.loopback.recording\":%s}", deviceName, enabled ? "true" : "false"); - } + int enableLoopbackRecording(bool enabled, const char* deviceName = NULL) { + if (!deviceName) { + return setParameters("{\"che.audio.loopback.recording\":%s}", enabled ? "true" : "false"); + } else { + return setParameters("{\"che.audio.loopback.deviceName\":\"%s\",\"che.audio.loopback.recording\":%s}", deviceName, enabled ? "true" : "false"); } + } #endif + int setInEarMonitoringVolume(int volume) { return m_parameter ? m_parameter->setInt("che.audio.headset.monitoring.parameter", volume) : -ERR_NOT_INITIALIZED; } + + protected: + AParameter& parameter() { return m_parameter; } + int setParameters(const char* format, ...) { + char buf[512]; + va_list args; + va_start(args, format); + vsnprintf(buf, sizeof(buf) - 1, format, args); + va_end(args); + return m_parameter ? m_parameter->setParameters(buf) : -ERR_NOT_INITIALIZED; + } + int setObject(const char* key, const char* format, ...) { + char buf[512]; + va_list args; + va_start(args, format); + vsnprintf(buf, sizeof(buf) - 1, format, args); + va_end(args); + return m_parameter ? m_parameter->setObject(key, buf) : -ERR_NOT_INITIALIZED; + } + int stopAllRemoteVideo() { return m_parameter ? m_parameter->setBool("che.video.peer.stop_render", true) : -ERR_NOT_INITIALIZED; } - int setInEarMonitoringVolume(int volume) { - return m_parameter ? m_parameter->setInt("che.audio.headset.monitoring.parameter", volume) : -ERR_NOT_INITIALIZED; - } - -protected: - AParameter& parameter() { - return m_parameter; - } - int setParameters(const char* format, ...) { - char buf[512]; - va_list args; - va_start(args, format); - vsnprintf(buf, sizeof(buf)-1, format, args); - va_end(args); - return m_parameter ? m_parameter->setParameters(buf) : -ERR_NOT_INITIALIZED; - } - int setObject(const char* key, const char* format, ...) { - char buf[512]; - va_list args; - va_start(args, format); - vsnprintf(buf, sizeof(buf)-1, format, args); - va_end(args); - return m_parameter ? m_parameter->setObject(key, buf) : -ERR_NOT_INITIALIZED; - } - int stopAllRemoteVideo() { - return m_parameter ? m_parameter->setBool("che.video.peer.stop_render", true) : -ERR_NOT_INITIALIZED; - } -private: - AParameter m_parameter; + private: + AParameter m_parameter; }; -} //namespace rtc -} // namespace agora - +} // namespace rtc +} // namespace agora #define getAgoraRtcEngineVersion getAgoraSdkVersion diff --git a/cpp/android/include/IAgoraService.h b/cpp/android/include/IAgoraService.h index 299158c..555ed88 100644 --- a/cpp/android/include/IAgoraService.h +++ b/cpp/android/include/IAgoraService.h @@ -8,47 +8,43 @@ #include "AgoraBase.h" namespace agora { - namespace rtc { - class IRtcEngine; - } - namespace rtm { - class IRtmService; - } +namespace rtc { +class IRtcEngine; +} +namespace rtm { +class IRtmService; +} namespace base { -struct AgoraServiceContext -{ -}; - +struct AgoraServiceContext {}; -class IAgoraService -{ -protected: - virtual ~IAgoraService(){} +class IAgoraService { + protected: + virtual ~IAgoraService() {} -public: - AGORA_CPP_API static void release (); + public: + AGORA_CPP_API static void release(); - /** Initializes the engine. + /** Initializes the engine. - @param context RtcEngine context. - @return - - 0: Success. - - < 0: Failure. - */ - virtual int initialize(const AgoraServiceContext& context) = 0; +@param context RtcEngine context. +@return +- 0: Success. +- < 0: Failure. +*/ + virtual int initialize(const AgoraServiceContext& context) = 0; - /** Retrieves the SDK version number. - * @param build Build number. - * @return The current SDK version in the string format. For example, 2.4.0 - */ - virtual const char* getVersion(int* build) = 0; + /** Gets the SDK version number. + * @param build Build number. + * @return The current SDK version in the string format. For example, 2.4.0 + */ + virtual const char* getVersion(int* build) = 0; - virtual rtm::IRtmService* createRtmService() = 0; + virtual rtm::IRtmService* createRtmService() = 0; }; -} //namespace base -} // namespace agora +} // namespace base +} // namespace agora /** Gets the SDK version number. @@ -60,16 +56,16 @@ class IAgoraService AGORA_API const char* AGORA_CALL getAgoraSdkVersion(int* build); /** -* Creates the RtcEngine object and returns the pointer. -* @param err Error code -* @return returns Description of the error code -*/ + * Creates the RtcEngine object and returns the pointer. + * @param err Error code + * @return returns Description of the error code + */ AGORA_API const char* AGORA_CALL getAgoraSdkErrorDescription(int err); /** -* Creates the Agora Service object and returns the pointer. -* @return returns Pointer of the Agora Service object -*/ + * Creates the Agora Service object and returns the pointer. + * @return returns Pointer of the Agora Service object + */ AGORA_API agora::base::IAgoraService* AGORA_CALL createAgoraService(); AGORA_API int AGORA_CALL setAgoraSdkExternalSymbolLoader(void* (*func)(const char* symname)); diff --git a/example/package.json b/example/package.json index c67a576..a97d6dc 100644 --- a/example/package.json +++ b/example/package.json @@ -11,7 +11,7 @@ "dependencies": { "react": "16.11.0", "react-native": "0.62.2", - "react-native-agora": "^3.2.2" + "react-native-agora": "^3.4.5-rc.0" }, "devDependencies": { "@babel/core": "^7.9.6",