Agora RTC Objective-C API Reference  Refactor
Deprecated List
Global AgoraServiceConfiguration::threadPriority
Thread priority for SDK common threads
Global IRtmpLocalUserObserver::onAudioTrackPublishStart (agora_refptr< rtc::ILocalAudioTrack > audioTrack)=0
This method will not be called back
Global IRtmpLocalUserObserver::onAudioTrackUnpublished (agora_refptr< rtc::ILocalAudioTrack > audioTrack)=0
This method will not be called back
Global IRtmpLocalUserObserver::onVideoTrackPublishStart (agora_refptr< rtc::ILocalVideoTrack > videoTrack)=0
This method will not be called back
Global IRtmpLocalUserObserver::onVideoTrackUnpublished (agora_refptr< rtc::ILocalVideoTrack > videoTrack)=0
This method will not be called back
Global agora::CHANNEL_PROFILE_GAME
This profile is deprecated.
Global agora::CHANNEL_PROFILE_CLOUD_GAMING
This profile is deprecated.
Global agora::CHANNEL_PROFILE_COMMUNICATION_1v1
This profile is deprecated.
Global agora::rtc::QUALITY_UNKNOWN
This member is deprecated.
Global agora::rtc::VIDEO_CODEC_GENERIC_H264
This codec type is deprecated.
Global agora::rtc::CLIENT_ROLE_CHANGE_FAILED_REQUEST_TIME_OUT
This reason is deprecated.
Global agora::rtc::CLIENT_ROLE_CHANGE_FAILED_CONNECTION_FAILED
This reason is deprecated.
Global agora::media::base::RENDER_MODE_ADAPTIVE
Global agora::media::CONTENT_INSPECT_MODERATION
Content inspect type moderation
Global IMediaPlayerSource::openWithAgoraCDNSrc (const char *src, int64_t startPos)=0
4.6.0
Global IMediaPlayerSource::getAgoraCDNLineCount ()=0
4.6.0
Global IMediaPlayerSource::switchAgoraCDNLineByIndex (int index)=0
4.6.0
Global IMediaPlayerSource::getCurrentAgoraCDNIndex ()=0
4.6.0
Global IMediaPlayerSource::enableAutoSwitchAgoraCDN (bool enable)=0
4.6.0
Global IMediaPlayerSource::renewAgoraCDNSrcToken (const char *token, int64_t ts)=0
4.6.0
Global IMediaPlayerSource::switchAgoraCDNSrc (const char *src, bool syncPts=false)=0
4.6.0
Global IMediaPlayerSourceObserver::onAgoraCDNTokenWillExpire ()=0
4.6.0
Global agora::rtc::STREAMING_SRC_ERR
Since version 4.6.0, this feature has been turned off by default.
Global agora::rtc::STREAMING_SRC_STATE
Since version 4.6.0, this feature has been turned off by default.
Class InputSeiData
Since version 4.6.0, this feature has been turned off by default.
Class IMediaStreamingSource
Since version 4.6.0, this feature has been turned off by default.
Class IMediaStreamingSourceObserver
Since version 4.6.0, this feature has been turned off by default.
Global IMediaEngine::setExternalAudioSource (bool enabled, int sampleRate, int channels, bool localPlayback=false, bool publish=true) 1=0
This method is deprecated. Use createCustomAudioTrack(rtc::AUDIO_TRACK_TYPE trackType, const rtc::AudioTrackConfig& config) instead.
Global agora::rtc::DIRECT_CDN_STREAMING_REASON
v4.6.0.
Global agora::rtc::DIRECT_CDN_STREAMING_STATE
v4.6.0.
Class DirectCdnStreamingStats
v4.6.0.
Class IDirectCdnStreamingEventHandler
v4.6.0.
Class DirectCdnStreamingMediaOptions
v4.6.0.
Global RemoteVideoStats::delay
Time delay (ms).
Global IRtcEngineEventHandler::onAudioQuality (uid_t uid, int quality, unsigned short delay, unsigned short lost) 1
This callback is deprecated. Use onRemoteAudioStats instead.
Global IRtcEngineEventHandler::onUserEnableLocalVideo (uid_t uid, bool enabled) 1
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).
Global IRtcEngineEventHandler::onCameraReady () 1
Use LOCAL_VIDEO_STREAM_STATE_CAPTURING(1) in onLocalVideoStateChanged instead.
Global IRtcEngineEventHandler::onVideoStopped () 1
Use LOCAL_VIDEO_STREAM_STATE_STOPPED(0) in the onLocalVideoStateChanged callback instead.
Global IRtcEngineEventHandler::onRhythmPlayerStateChanged (RHYTHM_PLAYER_STATE_TYPE state, RHYTHM_PLAYER_REASON reason)
v4.6.0
Global IRtcEngineEventHandler::onConnectionInterrupted () 1
Use onConnectionStateChanged instead.
Global IRtcEngineEventHandler::onConnectionBanned () 1
Use onConnectionStateChanged instead.
Global IRtcEngineEventHandler::onFirstRemoteAudioDecoded (uid_t uid, int elapsed) 1
Use onRemoteAudioStateChanged instead.
Global IRtcEngineEventHandler::onFirstRemoteAudioFrame (uid_t uid, int elapsed) 1
Use onRemoteAudioStateChanged instead.
Global IRtcEngineEventHandler::onRemoteAudioTransportStats (uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) 1
Use onRemoteAudioStats instead.
Global IRtcEngineEventHandler::onRemoteVideoTransportStats (uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) 1
Use onRemoteVideoStats instead.
Global IRtcEngine::setAudioProfile (AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario) 1=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.
Global IRtcEngine::setLogFile (const char *filePath)=0
Use context in initialize to set up the log file path.
Global IRtcEngine::setLogFilter (unsigned int filter)=0
Use logConfig in initialize to set the log filter.
Global IRtcEngine::setLogLevel (commons::LOG_LEVEL level)=0
Use context in initialize to set the log level.
Global IRtcEngine::setLogFileSize (unsigned int fileSizeInKBytes)=0
Use logConfig in initialize to set the log file size.
Global IRtcEngine::setLocalRenderMode (media::base::RENDER_MODE_TYPE renderMode) 1=0
This method is deprecated since v4.0.0. Use setLocalRenderMode(RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) instead.
Global IRtcEngine::setLocalVideoMirrorMode (VIDEO_MIRROR_MODE_TYPE mirrorMode) 1=0
This method is deprecated. Use setupLocalVideo or setLocalRenderMode instead.
Global IRtcEngine::enableDualStreamMode (bool enabled) 1=0
This method is deprecated since v4.2.0. Use setDualStreamMode instead.
Global IRtcEngine::enableDualStreamMode (bool enabled, const SimulcastStreamConfig &streamConfig) 1=0
This method is deprecated since v4.2.0. Use setDualStreamMode instead.
Global IRtcEngine::addVideoWatermark (const char *watermarkUrl, const WatermarkOptions &options)=0
Use addVideoWatermark(const WatermarkConfig& configs) instead.
Global IRtcEngine::enableWebSdkInteroperability (bool enabled) 1=0
By default, the Agora RTC SDK enables the interoperablity with the Web SDK.
Global IRtcEngine::setDirectCdnStreamingAudioConfiguration (AUDIO_PROFILE_TYPE profile)=0
v4.6.0.
Global IRtcEngine::setDirectCdnStreamingVideoConfiguration (const VideoEncoderConfiguration &config)=0
v4.6.0.
Global IRtcEngine::startDirectCdnStreaming (IDirectCdnStreamingEventHandler *eventHandler, const char *publishUrl, const DirectCdnStreamingMediaOptions &options)=0
v4.6.0.
Global IRtcEngine::stopDirectCdnStreaming ()=0
v4.6.0.
Global IRtcEngine::updateDirectCdnStreamingMediaOptions (const DirectCdnStreamingMediaOptions &options)=0
v4.6.0.
Global IRtcEngine::startRhythmPlayer (const char *sound1, const char *sound2, const AgoraRhythmPlayerConfig &config)=0
v4.6.0
Global IRtcEngine::stopRhythmPlayer ()=0
v4.6.0
Global IRtcEngine::configRhythmPlayer (const AgoraRhythmPlayerConfig &config)=0
v4.6.0
Global IRtcEngineEventHandlerEx::onAudioQuality (const RtcConnection &connection, uid_t remoteUid, int quality, unsigned short delay, unsigned short lost) 1
This callback is deprecated. Use onRemoteAudioStats instead.
Global IRtcEngineEventHandlerEx::onConnectionInterrupted (const RtcConnection &connection) 1
Use onConnectionStateChanged instead.
Global IRtcEngineEventHandlerEx::onFirstRemoteAudioFrame (const RtcConnection &connection, uid_t userId, int elapsed) 1
Use onRemoteAudioStateChanged instead.
Global IRtcEngineEventHandlerEx::onFirstRemoteAudioDecoded (const RtcConnection &connection, uid_t uid, int elapsed) 1
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.
Global IRtcEngineEventHandlerEx::onRemoteAudioTransportStats (const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) 1
Use onRemoteAudioStats instead.
Global IRtcEngineEventHandlerEx::onRemoteVideoTransportStats (const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) 1
Use onRemoteVideoStats instead.
Global 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.
Global IRtcEngineEx::enableDualStreamModeEx (bool enabled, const SimulcastStreamConfig &streamConfig, const RtcConnection &connection)=0
v4.2.0. This method is deprecated. Use setDualStreamModeEx instead.
Class <AgoraDirectCdnStreamingEventDelegate>
v4.6.0.
Global AgoraDirectCdnStreamingState
v4.6.0.
Global AgoraDirectCdnStreamingReason
v4.6.0.
Global AgoraChannelProfileGame
Global AgoraChannelProfileCloudGaming
Global AgoraChannelProfileCommunication_1v1
4：1-to-1 communication.
Global AgoraVideoRenderModeAdaptive
Adaptive(3)：This mode is obsolete.
Global AgoraDegradationMaintainQuality
Global AgoraContentInspectTypeModeration
content inspect type moderation
Global [AgoraMusicContentCenter preloadWithSongCode:jsonOption:]
This method is deprecated. Use preload(songCode:) instead.
Class AgoraDirectCdnStreamingStats
v4.6.0.
Class AgoraDirectCdnStreamingMediaOptions
v4.6.0.
Global AgoraVideoFrame::stride
Use strideInPixels instead.
Global [AgoraRtcEngineKit enableDualStreamMode:]
v4.2.0. This method is deprecated. Use setDualStreamMode instead.
Global [AgoraRtcEngineKit enableDualStreamMode:streamConfig:]
v4.2.0. This method is deprecated. Use setDualStreamMode instead.
Global [AgoraRtcEngineKit setLogFile:]
Use config in sharedEngineWithConfig:delegate: to set the log file instead.
Global [AgoraRtcEngineKit setLogFilter:]
Use logconfig in sharedEngineWithConfig instead.
Global [AgoraRtcEngineKit setLogFileSize:]
Use logconfig in sharedEngineWithConfig:delegate: to set the log file size instead.
Global [AgoraRtcEngineKit setDirectCdnStreamingAudioConfiguration:]
v4.6.0.
Global [AgoraRtcEngineKit setDirectCdnStreamingVideoConfiguration:]
v4.6.0.
Global [AgoraRtcEngineKit startDirectCdnStreaming:publishUrl:mediaOptions:]
v4.6.0.
Global [AgoraRtcEngineKit stopDirectCdnStreaming]
v4.6.0.
Global [AgoraRtcEngineKit updateDirectCdnStreamingMediaOptions:]
v4.6.0.
Global [AgoraRtcEngineKit setLogLevel:]
Global [AgoraRtcEngineKit enableWebSdkInteroperability:]
Web SDK interoperability is by default enabled. scenarios).
Global [AgoraRtcEngineKit setAudioProfile:scenario:]
This method is deprecated. You can use the setAudioProfile: (AgoraRtcEngineKit) setAudioProfile method instead.
Global [AgoraRtcEngineKit setExternalAudioSource:sampleRate:channels:]
This method is deprecated. Use createCustomAudioTrack:(AgoraAudioTrackType)trackType config:(AgoraAudioTrackConfig* _Nonnull)config instead.
Global [AgoraRtcEngineKit setExternalAudioSource:sampleRate:channels:localPlayback:publish:]
This method is deprecated. Use createCustomAudioTrack:(AgoraAudioTrackType)trackType config:(AgoraAudioTrackConfig* _Nonnull)config instead.
Global [AgoraRtcEngineKit setLocalRenderMode:mode:]
(Ex) Global [AgoraRtcEngineKit(Ex) enableDualStreamModeEx:streamConfig:connection:]
v4.2.0. This method is deprecated. Use setDualStreamModeEx instead.
Global [AgoraRtcMediaPlayerDelegate-p onAgoraCDNTokenWillExpire]
4.6.0
Global [AgoraRtcMediaPlayerProtocol-p openWithAgoraCDNSrc:startPos:]
4.6.0
Global [AgoraRtcMediaPlayerProtocol-p getAgoraCDNLineCount]
4.6.0
Global [AgoraRtcMediaPlayerProtocol-p switchAgoraCDNLineByIndex:]
4.6.0
Global [AgoraRtcMediaPlayerProtocol-p getCurrentAgoraCDNIndex]
4.6.0
Global [AgoraRtcMediaPlayerProtocol-p enableAutoSwitchAgoraCDN:]
4.6.0
Global [AgoraRtcMediaPlayerProtocol-p renewAgoraCDNSrcToken:ts:]
4.6.0
Global [AgoraRtcMediaPlayerProtocol-p switchAgoraCDNSrc:syncPts:]
4.6.0
Generated by doxygen 1.8.20