Deprecated List

Member agora::rtc::IRtcEngine::startAudioMixing (const char *filePath, bool loopback, int cycle)=0

This method is deprecated. Use startAudioMixing(const char* filePath, bool loopback, int cycle, int startPos) instead.

Member agora::rtc::IRtcEngine::addVideoWatermark (const char *watermarkUrl, const WatermarkOptions &options)=0

Use addVideoWatermark(const WatermarkConfig& configs) instead.

Member agora::rtc::IRtcEngine::enableDualStreamMode (bool enabled, const SimulcastStreamConfig &streamConfig) __deprecated=0

This method is deprecated since v4.2.0. Use setDualStreamMode instead.

Member agora::rtc::IRtcEngine::enableDualStreamMode (bool enabled) __deprecated=0

This method is deprecated since v4.2.0. Use setDualStreamMode instead.

Member agora::rtc::IRtcEngine::setLocalVideoMirrorMode (VIDEO_MIRROR_MODE_TYPE mirrorMode) __deprecated=0

This method is deprecated. Use setupLocalVideo or setLocalRenderMode instead.

Member agora::rtc::IRtcEngine::setLocalRenderMode (media::base::RENDER_MODE_TYPE renderMode) __deprecated=0

This method is deprecated since v4.0.0. Use setLocalRenderMode(RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) instead.

Member agora::rtc::IRtcEngine::setLogFileSize (unsigned int fileSizeInKBytes)=0

Use logConfig in initialize to set the log file size.

Member agora::rtc::IRtcEngine::setLogLevel (commons::LOG_LEVEL level)=0

Use context in initialize to set the log level.

Member agora::rtc::IRtcEngine::setLogFilter (unsigned int filter)=0

Use logConfig in initialize to set the log filter.

Member agora::rtc::IRtcEngine::setLogFile (const char *filePath)=0

Use context in initialize to set up the log file path.

Member agora::rtc::IRtcEngine::pauseAudio () __deprecated=0

Use disableAudio() 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(AUDIO_PROFILE_TYPE profile) = 0 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::IRtcEngineEventHandler::onRemoteVideoTransportStats (uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated

Use onRemoteVideoStats 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::onFirstRemoteAudioFrame (uid_t uid, int elapsed) __deprecated

Use onRemoteAudioStateChanged instead.

Member agora::rtc::IRtcEngineEventHandler::onFirstRemoteAudioDecoded (uid_t uid, int elapsed) __deprecated

Use onRemoteAudioStateChanged instead.

Member agora::rtc::IRtcEngineEventHandler::onConnectionBanned () __deprecated

Use onConnectionStateChanged instead.

Member agora::rtc::IRtcEngineEventHandler::onConnectionInterrupted () __deprecated

Use onConnectionStateChanged instead.

Member agora::rtc::IRtcEngineEventHandler::onRhythmPlayerStateChanged (RHYTHM_PLAYER_STATE_TYPE state, RHYTHM_PLAYER_REASON reason)

v4.6.0

Member agora::rtc::IRtcEngine::stopRhythmPlayer ()=0

v4.6.0

Member agora::rtc::IRtcEngineEx::enableDualStreamModeEx (bool enabled, const SimulcastStreamConfig &streamConfig, const RtcConnection &connection)=0

v4.2.0. This method is deprecated. Use setDualStreamModeEx instead.

Member agora::rtc::IRtcEngineEx::addVideoWatermarkEx (const char *watermarkUrl, const WatermarkOptions &options, const RtcConnection &connection)=0

v4.6.0. This method is deprecated. Use addVideoWatermarkEx(const WatermarkConfig& config, const RtcConnection& connection) 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::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::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::onFirstRemoteAudioFrame (const RtcConnection &connection, uid_t userId, int elapsed) __deprecated

Use onRemoteAudioStateChanged instead.

Member agora::rtc::IRtcEngineEventHandlerEx::onConnectionInterrupted (const RtcConnection &connection) __deprecated

Use onConnectionStateChanged instead.

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::IRtcEngine::configRhythmPlayer (const AgoraRhythmPlayerConfig &config)=0

v4.6.0

Member agora::rtc::IRtcEngineEventHandler::onVideoStopped () __deprecated

Use LOCAL_VIDEO_STREAM_STATE_STOPPED(0) in the onLocalVideoStateChanged callback instead.

Member agora::rtc::IRtcEngine::startRhythmPlayer (const char *sound1, const char *sound2, const AgoraRhythmPlayerConfig &config)=0

v4.6.0

Member agora::rtc::IRtcEngine::updateDirectCdnStreamingMediaOptions (const DirectCdnStreamingMediaOptions &options)=0

v4.6.0.

Member agora::rtc::IRtcEngine::stopDirectCdnStreaming ()=0

v4.6.0.

Member agora::rtc::IRtcEngine::startDirectCdnStreaming (IDirectCdnStreamingEventHandler *eventHandler, const char *publishUrl, const DirectCdnStreamingMediaOptions &options)=0

v4.6.0.

Member agora::rtc::IRtcEngine::setDirectCdnStreamingVideoConfiguration (const VideoEncoderConfiguration &config)=0

v4.6.0.

Member agora::rtc::IRtcEngine::setDirectCdnStreamingAudioConfiguration (AUDIO_PROFILE_TYPE profile)=0

v4.6.0.

Member agora::rtc::IRtcEngine::enableWebSdkInteroperability (bool enabled) __deprecated=0

By default, the Agora RTC SDK enables the interoperablity with the Web SDK.

Member agora::rtc::IRtcEngine::resumeAudio () __deprecated=0

Use enableAudio() instead.

"

This codec type is deprecated.

Member agora::rtc::IMediaPlayerSource::enableAutoSwitchAgoraCDN (bool enable)=0

4.6.0

Member agora::rtc::IMediaPlayerSource::getCurrentAgoraCDNIndex ()=0

4.6.0

Member agora::rtc::IMediaPlayerSource::switchAgoraCDNLineByIndex (int index)=0

4.6.0

Member agora::rtc::IMediaPlayerSource::getAgoraCDNLineCount ()=0

4.6.0

Member agora::rtc::IMediaPlayerSource::openWithAgoraCDNSrc (const char *src, int64_t startPos)=0

4.6.0

"

Content inspect type moderation

This reason is deprecated.

This reason is deprecated.

Member agora::rtc::IMediaPlayerSource::renewAgoraCDNSrcToken (const char *token, int64_t ts)=0

4.6.0

"

This member is deprecated.

This profile is deprecated.

This profile is deprecated.

This profile is deprecated.

Member agora::rtc::IRtmpLocalUserObserver::onVideoTrackUnpublished (agora_refptr< rtc::ILocalVideoTrack > videoTrack)=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::onAudioTrackUnpublished (agora_refptr< rtc::ILocalAudioTrack > audioTrack)=0

This method will not be called back

Member agora::rtc::IRtmpLocalUserObserver::onAudioTrackPublishStart (agora_refptr< rtc::ILocalAudioTrack > audioTrack)=0

This method will not be called back

"

v4.6.0.

Member agora::rtc::IRtcEngineEventHandler::onCameraReady () __deprecated

Use LOCAL_VIDEO_STREAM_STATE_CAPTURING(1) in onLocalVideoStateChanged instead.

Member agora::rtc::IRtcEngineEventHandler::onUserEnableLocalVideo (uid_t uid, bool enabled) __deprecated

This method is deprecated. Use the following enumerators from onRemoteVideoStateChanged:

• 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).

Member agora::rtc::IRtcEngineEventHandler::onAudioMixingFinished () __deprecated

This method is deprecated, use onAudioMixingStateChanged instead.

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::RemoteVideoStats::__deprecated

Time delay (ms).

Class agora::rtc::DirectCdnStreamingMediaOptions

v4.6.0.

Class agora::rtc::IDirectCdnStreamingEventHandler

v4.6.0.

Class agora::rtc::DirectCdnStreamingStats

v4.6.0.

"

v4.6.0.

Member agora::base::AgoraServiceConfiguration::__deprecated

Thread priority for SDK common threads

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.

Class agora::rtc::IMediaStreamingSourceObserver

Since version 4.6.0, this feature has been turned off by default.

Class agora::rtc::IMediaStreamingSource

Since version 4.6.0, this feature has been turned off by default.

Class agora::rtc::InputSeiData

Since version 4.6.0, this feature has been turned off by default.

" </dt><dd> \anchor _deprecated000024 Since version 4.6.0, this feature has been turned off by default.<p> \anchor _deprecated000023 Since version 4.6.0, this feature has been turned off by default.</dd> <dt> \_setscope agora::rtc::IMediaPlayerSourceObserver Member \_internalref classagora_1_1rtc_1_1_i_media_player_source_observer#a68df2caa6e3d70015f2203f715a05964 "agora::rtc::IMediaPlayerSourceObserver::onAgoraCDNTokenWillExpire" ()=0</dt><dd> \anchor _deprecated000022 4.6.0</dd> <dt> \_setscope agora::rtc::IMediaPlayerSource Member \_internalref classagora_1_1rtc_1_1_i_media_player_source#af4727bc8345b5e7c152628bd28f89c5e "agora::rtc::IMediaPlayerSource::switchAgoraCDNSrc" (const char *src, bool syncPts=false)=0

4.6.0