Deprecated List

Global IMediaRelayObserver::onChannelMediaRelayEvent (CHANNEL_MEDIA_RELAY_EVENT code)

v4.2.0. This callback is not recommended and will be removed in future releases.

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::media::CONTENT_INSPECT_MODERATION

Content inspect type moderation

Global agora::media::base::RENDER_MODE_ADAPTIVE

3: This mode is deprecated.

Global IMediaPlayerSource::openWithCustomSource (int64_t startPos, media::base::IMediaPlayerCustomDataProvider *provider) 1=0

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 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::onCameraReady () 1

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.

Global IRtcEngineEventHandler::onVideoStopped () 1

Use LOCAL_VIDEO_STREAM_STATE_STOPPED(0) in the onLocalVideoStateChanged callback instead.

Global IRtcEngineEventHandler::onConnectionInterrupted () 1

Use onConnectionStateChanged instead.

Global IRtcEngineEventHandler::onConnectionBanned () 1

Use onConnectionStateChanged instead.

Global IRtcEngineEventHandler::onFirstRemoteAudioFrame (uid_t uid, int elapsed) 1

Use onRemoteAudioStateChanged instead.

Global IRtcEngineEventHandler::onFirstRemoteAudioDecoded (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 IRtcEngineEventHandler::onAudioRoutingChanged (int routing) 1

This callback is deprecated. Use onAudioRoutingChanged with 2 params instead.

Global IRtcEngineEventHandler::onChannelMediaRelayEvent (int code) 1

v4.2.0. This callback is not recommended and will be removed in future releases.

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 method instead. To set the audio scenario, call the initialize method and pass value in the audioScenario member in the RtcEngineContext struct.

Global IRtcEngine::setDefaultMuteAllRemoteAudioStreams (bool mute) 1=0

This method is deprecated. To set whether to receive remote audio streams by default, call muteAllRemoteAudioStreams before calling joinChannel

Global IRtcEngine::setDefaultMuteAllRemoteVideoStreams (bool mute) 1=0

This method is deprecated. To set whether to receive remote video streams by default, call muteAllRemoteVideoStreams before calling joinChannel.

Global IRtcEngine::enableDualStreamMode (bool enabled) 1=0

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

Global IRtcEngine::enableDualStreamMode (bool enabled, const SimulcastStreamConfig &streamConfig) 1=0

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

Global IRtcEngine::enableWebSdkInteroperability (bool enabled) 1=0

The Agora NG SDK enables the interoperablity with the Web SDK.

Global IRtcEngine::startChannelMediaRelay (const ChannelMediaRelayConfiguration &configuration) 1=0

v4.2.0 Use startOrUpdateChannelMediaRelay instead.

Global IRtcEngine::updateChannelMediaRelay (const ChannelMediaRelayConfiguration &configuration) 1=0

v4.2.0 Use startOrUpdateChannelMediaRelay instead.

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::startChannelMediaRelayEx (const ChannelMediaRelayConfiguration &configuration, const RtcConnection &connection) 1=0

v4.2.0 Use startOrUpdateChannelMediaRelayEx instead.

Global IRtcEngineEx::updateChannelMediaRelayEx (const ChannelMediaRelayConfiguration &configuration, const RtcConnection &connection) 1=0

v4.2.0 Use startOrUpdateChannelMediaRelayEx instead.

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

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

Global AgoraChannelProfileGame

2: Gaming.

Global AgoraChannelProfileCloudGaming

3: Cloud Gaming.

Global AgoraChannelProfileCommunication_1v1

4：1-to-1 communication.

Global AgoraVideoRenderModeAdaptive

Adaptive(3)：This mode is obsolete.

Global AgoraContentInspectTypeModeration

content inspect type moderation

Global [AgoraMusicContentCenter preloadWithSongCode:jsonOption:]

This method is deprecated. Use preload(songCode:) instead.

Global AgoraVideoFrame::stride

Use strideInPixels instead.

Global [AgoraRtcEngineDelegate-p rtcEngine:didReceiveChannelMediaRelayEvent:]

v4.2.0. This callback is not recommended and will be removed in future releases.

Global [AgoraRtcEngineKit startChannelMediaRelay:]

v4.2.0 Use startOrUpdateChannelMediaRelay instead.

Global [AgoraRtcEngineKit updateChannelMediaRelay:]

v4.2.0 Use startOrUpdateChannelMediaRelay instead.

Global [AgoraRtcEngineKit enableWebSdkInteroperability:]

Web SDK interoperability is by default enabled.

Global [AgoraRtcEngineKit setLocalRenderMode:mode:]

Global [AgoraRtcEngineKit setDefaultMuteAllRemoteVideoStreams:]

To set whether to receive remote video streams by default, call muteAllRemoteVideoStreams: (AgoraRtcEngineKit) muteAllRemoteVideoStreams before calling joinChannelByToken.

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

(Ex) Global [AgoraRtcEngineKit(Ex) enableDualStreamModeEx:streamConfig:connection:]

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

(Ex) Global [AgoraRtcEngineKit(Ex) startChannelMediaRelayEx:connection:]

v4.2.0 Use startOrUpdateChannelMediaRelayEx instead.

(Ex) Global [AgoraRtcEngineKit(Ex) updateChannelMediaRelayEx:connection:]

v4.2.0 Use startOrUpdateChannelMediaRelayEx instead.

Global [AgoraRtcMediaPlayerProtocol-p openWithCustomSourceAtStartPos:withPlayerOnReadData:andPlayerOnSeek:]

Open media file or stream with custom soucrce. The custom data source provides a data stream input callback, and the player will continue to call back this interface, requesting the user to fill in the data that needs to be played.