Agora C++ API Reference for All Platforms
Deprecated List
Member agora::rtc::IRtcConnectionObserver::onApiCallExecuted (int err, const char *api, const char *result) __deprecated
This callback is deprecated. Use other specific event callbacks instead.
Member agora::__deprecated

This profile is deprecated.

This profile is deprecated.

This profile is deprecated.

Member agora::rtc::__deprecated
This member is deprecated.
Member agora::media::base::__deprecated
3: This mode is deprecated.
Member agora::rtc::IMediaPlayerSource::openWithCustomSource (int64_t startPos, media::base::IMediaPlayerCustomDataProvider *provider)=0
Member agora::rtc::RemoteVideoStats::__deprecated
Time delay (ms).
Member agora::rtc::IRtcEngineEventHandler::onAudioQuality (uid_t uid, int quality, unsigned short delay, unsigned short lost)
This callback is deprecated. Use onRemoteAudioStats instead.
Member agora::rtc::IRtcEngineEventHandler::onAudioMixingFinished () __deprecated
This method is deprecated, use onAudioMixingStateChanged instead.
Member agora::rtc::IRtcEngineEventHandler::onApiCallExecuted (int err, const char *api, const char *result) __deprecated
This callback is deprecated. Use other specific event callbacks instead.
Member agora::rtc::IRtcEngineEventHandler::onCameraReady ()
Use LOCAL_VIDEO_STREAM_STATE_CAPTURING(1) in onLocalVideoStateChanged instead. This callback indicates that the camera has been successfully turned on and you can start to capture video.
Member agora::rtc::IRtcEngineEventHandler::onVideoStopped ()
Use LOCAL_VIDEO_STREAM_STATE_STOPPED(0) in the onLocalVideoStateChanged callback instead.
Member agora::rtc::IRtcEngineEventHandler::onConnectionInterrupted ()
Use onConnectionStateChanged instead.
Member agora::rtc::IRtcEngineEventHandler::onConnectionBanned ()
Use onConnectionStateChanged instead.
Member agora::rtc::IRtcEngineEventHandler::onFirstRemoteAudioFrame (uid_t uid, int elapsed)
Use onRemoteAudioStateChanged instead.
Member agora::rtc::IRtcEngineEventHandler::onFirstRemoteAudioDecoded (uid_t uid, int elapsed)
Use onRemoteAudioStateChanged instead. The SDK triggers this callback under one of the following circumstances:
  • The remote user joins the channel and sends the audio stream for the first time.
  • The remote user's audio is offline and then goes online to re-send audio. It means the local user cannot receive audio in 15 seconds. Reasons for such an interruption include:
    • The remote user leaves channel.
    • The remote user drops offline.
    • The remote user calls muteLocalAudioStream to stop sending the audio stream.
    • The remote user calls disableAudio to disable audio.
Member agora::rtc::IRtcEngineEventHandler::onRemoteAudioTransportStats (uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Use onRemoteAudioStats instead.
Member agora::rtc::IRtcEngineEventHandler::onRemoteVideoTransportStats (uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Use onRemoteVideoStats instead.
Member agora::rtc::IRtcEngine::setAudioProfile (AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario) __deprecated=0
This method is deprecated. You can use the setAudioProfile method instead. To set the audio scenario, call the initialize method and pass value in the audioScenario member in the RtcEngineContext struct.
Member agora::rtc::IRtcEngine::setDefaultMuteAllRemoteAudioStreams (bool mute) __deprecated=0
This method is deprecated. To set whether to receive remote audio streams by default, call muteAllRemoteAudioStreams before calling joinChannel
Member agora::rtc::IRtcEngine::setDefaultMuteAllRemoteVideoStreams (bool mute) __deprecated=0
This method is deprecated. To set whether to receive remote video streams by default, call muteAllRemoteVideoStreams before calling joinChannel.
Member agora::rtc::IRtcEngine::startScreenCaptureByScreenRect (const Rectangle &screenRect, const Rectangle &regionRect, const ScreenCaptureParameters &captureParams)=0
This method is deprecated, use startScreenCaptureByDisplayId instead. Agora strongly recommends using startScreenCaptureByDisplayId if you need to start screen sharing on a device connected to another display.
Member agora::rtc::IRtcEngine::setEncryptionMode (const char *encryptionMode) __deprecated=0
This method is deprecated. Use enableEncryption(bool enabled, const EncryptionConfig&) instead.
Member agora::rtc::IRtcEngine::setEncryptionSecret (const char *secret) __deprecated=0
This method is deprecated. Use enableEncryption(bool enabled, const EncryptionConfig&) instead.
Member agora::rtc::IRtcEngine::pauseAudio () __deprecated=0
Use disableAudio() instead.
Member agora::rtc::IRtcEngine::resumeAudio () __deprecated=0
Use enableAudio() instead.
Member agora::rtc::IRtcEngine::enableWebSdkInteroperability (bool enabled) __deprecated=0
The Agora NG SDK enables the interoperablity with the Web SDK.
Member agora::rtc::IRtcEngineEventHandlerEx::onAudioQuality (const RtcConnection &connection, uid_t remoteUid, int quality, unsigned short delay, unsigned short lost)
This callback is deprecated. Use onRemoteAudioStats instead.
Member agora::rtc::IRtcEngineEventHandlerEx::onFirstLocalVideoFrame (const RtcConnection &connection, int width, int height, int elapsed)
4.0.0 This callback is deprecated, use void onFirstLocalVideoFrame(VIDEO_SOURCE_TYPE source, int width, int height, int elapsed) instead.
Member agora::rtc::IRtcEngineEventHandlerEx::onConnectionInterrupted (const RtcConnection &connection)
Use onConnectionStateChanged instead.
Member agora::rtc::IRtcEngineEventHandlerEx::onFirstRemoteAudioFrame (const RtcConnection &connection, uid_t userId, int elapsed)
Use onRemoteAudioStateChanged instead.
Member agora::rtc::IRtcEngineEventHandlerEx::onFirstRemoteAudioDecoded (const RtcConnection &connection, uid_t uid, int elapsed)
Use onRemoteAudioStateChanged instead. The SDK triggers this callback under one of the following circumstances:
  • The remote user joins the channel and sends the audio stream for the first time.
  • The remote user's audio is offline and then goes online to re-send audio. It means the local user cannot receive audio in 15 seconds. Reasons for such an interruption include:
    • The remote user leaves channel.
    • The remote user drops offline.
    • The remote user calls muteLocalAudioStream to stop sending the audio stream.
    • The remote user calls disableAudio to disable audio.
Member agora::rtc::IRtcEngineEventHandlerEx::onRemoteAudioTransportStats (const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Use onRemoteAudioStats instead.
Member agora::rtc::IRtcEngineEventHandlerEx::onRemoteVideoTransportStats (const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Use onRemoteVideoStats instead.