Agora C++ API Reference for All Platforms
Deprecated List
Member agora::base::AgoraServiceConfiguration::__deprecated
Thread priority for SDK common threads
Member agora::rtc::IRtmpLocalUserObserver::onAudioTrackPublishStart (agora_refptr< rtc::ILocalAudioTrack > audioTrack)=0
This method will not be called back
Member agora::rtc::IRtmpLocalUserObserver::onAudioTrackUnpublished (agora_refptr< rtc::ILocalAudioTrack > audioTrack)=0
This method will not be called back
Member agora::rtc::IRtmpLocalUserObserver::onVideoTrackPublishStart (agora_refptr< rtc::ILocalVideoTrack > videoTrack)=0
This method will not be called back
Member agora::rtc::IRtmpLocalUserObserver::onVideoTrackUnpublished (agora_refptr< rtc::ILocalVideoTrack > videoTrack)=0
This method will not be called back
Member agora::__deprecated

This profile is deprecated.

This profile is deprecated.

This profile is deprecated.

Member agora::rtc::__deprecated

This member is deprecated.

This reason is deprecated.

This reason is deprecated.

Member agora::media::__deprecated
Content inspect type moderation
Member agora::media::base::__deprecated
3: This mode is deprecated.
Member agora::media::IMediaEngine::setExternalAudioSource (bool enabled, int sampleRate, int channels, bool localPlayback=false, bool publish=true) __deprecated=0
This method is deprecated. Use createCustomAudioTrack(rtc::AUDIO_TRACK_TYPE trackType, const rtc::AudioTrackConfig& config) instead.
Member agora::rtc::RemoteVideoStats::__deprecated
Time delay (ms).
Member agora::rtc::IRtcEngineEventHandler::onAudioQuality (uid_t uid, int quality, unsigned short delay, unsigned short lost) __deprecated
This callback is deprecated. Use onRemoteAudioStats instead.
Member agora::rtc::IRtcEngineEventHandler::onAudioMixingFinished () __deprecated
This method is deprecated, use onAudioMixingStateChanged instead.
Member agora::rtc::IRtcEngineEventHandler::onCameraReady () __deprecated
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 () __deprecated
Use LOCAL_VIDEO_STREAM_STATE_STOPPED(0) in the onLocalVideoStateChanged callback instead.
Member agora::rtc::IRtcEngineEventHandler::onConnectionInterrupted () __deprecated
Use onConnectionStateChanged instead.
Member agora::rtc::IRtcEngineEventHandler::onConnectionBanned () __deprecated
Use onConnectionStateChanged instead.
Member agora::rtc::IRtcEngineEventHandler::onFirstRemoteAudioDecoded (uid_t uid, int elapsed) __deprecated
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::onFirstRemoteAudioFrame (uid_t uid, int elapsed) __deprecated
Use onRemoteAudioStateChanged instead.
Member agora::rtc::IRtcEngineEventHandler::onRemoteAudioTransportStats (uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated
Use onRemoteAudioStats instead.
Member agora::rtc::IRtcEngineEventHandler::onRemoteVideoTransportStats (uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated
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::startScreenCaptureByScreenRect (const Rectangle &screenRect, const Rectangle &regionRect, const ScreenCaptureParameters &captureParams) __deprecated=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::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) __deprecated
This callback is deprecated. Use onRemoteAudioStats instead.
Member agora::rtc::IRtcEngineEventHandlerEx::onConnectionInterrupted (const RtcConnection &connection) __deprecated
Use onConnectionStateChanged instead.
Member agora::rtc::IRtcEngineEventHandlerEx::onFirstRemoteAudioFrame (const RtcConnection &connection, uid_t userId, int elapsed) __deprecated
Use onRemoteAudioStateChanged instead.
Member agora::rtc::IRtcEngineEventHandlerEx::onFirstRemoteAudioDecoded (const RtcConnection &connection, uid_t uid, int elapsed) __deprecated
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) __deprecated
Use onRemoteAudioStats instead.
Member agora::rtc::IRtcEngineEventHandlerEx::onRemoteVideoTransportStats (const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated
Use onRemoteVideoStats instead.
Member agora::rtc::IRtcEngineEx::enableDualStreamModeEx (bool enabled, const SimulcastStreamConfig &streamConfig, const RtcConnection &connection)=0
v4.2.0. This method is deprecated. Use setDualStreamModeEx instead