Deprecated List

Member io.agora.rtc2.RtcEngine.setExternalAudioSource (boolean enabled, int sampleRate, int channels)

This method is deprecated. Use createCustomAudioTrack(Constants.AudioTrackType trackType, AudioTrackConfig config) instead.

Member io.agora.rtc2.RtcEngine.enableDualStreamMode (boolean enabled, SimulcastStreamConfig streamConfig)

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

Member io.agora.rtc2.RtcEngine.enableDualStreamMode (boolean enabled)

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

Member io.agora.rtc2.RtcEngine.addVideoWatermark (String watermarkUrl, WatermarkOptions options)

From v4.6.0. We recommend using the {addVideoWatermark}2 method instead.

Member io.agora.rtc2.RtcEngine.addVideoWatermark (AgoraImage watermark)

From v2.9.1. We recommend using the WatermarkOptions) addVideoWatermark2 method instead.

Member io.agora.rtc2.RtcEngine.pushExternalEncodedVideoFrame (ByteBuffer data, EncodedVideoFrameInfo frameInfo)

This method is deprecated.

Member io.agora.rtc2.RtcEngine.pushExternalVideoFrame (VideoFrame frame)

This method is deprecated.

Member io.agora.rtc2.RtcEngine.pushExternalAudioFrame (ByteBuffer data, long timestamp, int trackId)

This method is deprecated. Use pushExternalAudioFrame(ByteBuffer[] data, long timestamp, int sampleRate, int channels, Constants.BytesPerSample bytesPerSample, int trackId) instead.

Member io.agora.rtc2.RtcEngine.pushExternalAudioFrame (byte[] data, long timestamp)

This method is deprecated. Use pushExternalAudioFrame(byte[] data, long timestamp, int sampleRate, int channels, Constants.BytesPerSample bytesPerSample, int trackId) instead.

Member io.agora.rtc2.RtcEngine.setExternalAudioSource (boolean enabled, int sampleRate, int channels, boolean localPlayback, boolean publish)

This method is deprecated. Use createCustomAudioTrack(Constants.AudioTrackType trackType, AudioTrackConfig config) instead.

Member io.agora.rtc2.RtcEngine.setRemoteVideoStreamType (int uid, int streamType)

This method is deprecated. Use setRemoteVideoStreamType(int uid, Constants.VideoStreamType streamType) instead.

Member io.agora.rtc2.RtcEngine.startAudioMixing (String filePath, boolean loopback, int cycle)

This method is deprecated. Use startAudioMixing(String filePath, boolean loopback, int cycle) instead.

Member io.agora.rtc2.RtcEngine.setAudioProfile (int profile, int scenario)

This method is deprecated. Use setAudioProfile(int profile) to set the audio profile; use setAudioScenario(int scenario) to set the audio scenario.

Member io.agora.rtc2.RtcEngine.enableWebSdkInteroperability (boolean enabled)

The SDK enables interoperability with the RTC Web SDK by default.

Class io.agora.rtc2.PublisherParameters

Class io.agora.rtc2.PublisherConfiguration.Builder

Member io.agora.rtc2.live.LiveTranscoding.setBlue (int blue)

Sets the background color's blue component.

Member io.agora.rtc2.live.LiveTranscoding.setGreen (int green)

Sets the background color's green component.

Member io.agora.rtc2.live.LiveTranscoding.setRed (int red)

Sets the background color's red component.

Member io.agora.rtc2.live.LiveTranscoding.getBlue ()

Gets the background color's blue component.

Member io.agora.rtc2.RtcEngine.startDirectCdnStreaming (IDirectCdnStreamingEventHandler eventHandler, String publishUrl, DirectCdnStreamingMediaOptions options)

v4.6.0.

Member io.agora.rtm.RtmEventListener.onConnectionStateChanged (String channelName, RtmConnectionState state, RtmConnectionChangeReason reason)

This callback is deprecated. Use LinkStateEvent instead.

Member io.agora.rtc2.video.ContentInspectConfig.CONTENT_INSPECT_TYPE_MODERATION

Content inspect type moderation

Member io.agora.rtc2.RtcEngineEx.pauseAllChannelMediaRelayEx (RtcConnection connection)

This method is deprecated from v4.2.0. Use startOrUpdateChannelMediaRelayEx instead.

Member io.agora.rtc2.RtcEngineEx.addVideoWatermarkEx (String watermarkUrl, WatermarkOptions options, RtcConnection connection)

From v4.6.0. We recommend using the {addVideoWatermark}2 method instead.

Member io.agora.rtc2.RtcEngineEx.createDataStreamEx (boolean reliable, boolean ordered, RtcConnection connection)

Use createDataStreamEx(DataStreamConfig config, RtcConnection connection) instead.

Member io.agora.rtc2.RtcEngineEx.enableDualStreamModeEx (boolean enabled, SimulcastStreamConfig streamConfig, RtcConnection connection)

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

Member io.agora.rtc2.RtcEngineEx.setRemoteVideoStreamTypeEx (int uid, int streamType, RtcConnection connection)

This method is deprecated. Use setRemoteVideoStreamTypeEx(int uid, Constants.VideoStreamType streamType, RtcConnection connection) instead.

Member io.agora.rtc2.RtcEngine.updateDirectCdnStreamingMediaOptions (DirectCdnStreamingMediaOptions options)

v4.6.0.

Member io.agora.rtc2.RtcEngine.stopDirectCdnStreaming ()

v4.6.0.

Member io.agora.rtc2.live.LiveTranscoding.getGreen ()

Gets the background color's green component.

Member io.agora.rtc2.RtcEngine.setDirectCdnStreamingVideoConfiguration (VideoEncoderConfiguration config)

v4.6.0.

Member io.agora.rtc2.RtcEngine.setDirectCdnStreamingAudioConfiguration (int profile)

v4.6.0.

Member io.agora.rtc2.RtcEngine.setPreferHeadset (boolean enabled)

This method is deprecated.

Member io.agora.rtc2.RtcEngine.enableHighPerfWifiMode (boolean enable)

This method is deprecated.

Member io.agora.rtc2.RtcEngine.setLogLevel (int level)

Use config in create(config) to set the log level.

Member io.agora.rtc2.RtcEngine.setLogFilter (int filter)

Use logConfig in create(config) to set the log output level.

Member io.agora.rtc2.RtcEngine.getRecommendedEncoderType ()

This method is deprecated.

Member io.agora.rtc2.RtcEngine.setRemoteDefaultVideoStreamType (int streamType)

This method is deprecated. Use setRemoteDefaultVideoStreamType(Constants.VideoStreamType streamType) instead.

Member io.agora.musiccontentcenter.IAgoraMusicPlayer.destroy ()

use IAgoraMusicContentCenter#destroyMusicPlayer(IAgoraMusicPlayer player) instead.

Class io.agora.rtc2.IRtcEngineEventHandler.UserOfflineReason

Use the new Constants class with the same constants value

Class io.agora.rtc2.IRtcEngineEventHandler.ClientRole

Use the new Constants class with the same constants value

Class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile

Use the new Constants class with the same constants value

Class io.agora.rtc2.IRtcEngineEventHandler.Quality

Use the new Constants class with the same constants value

Class io.agora.rtc2.IDirectCdnStreamingEventHandler

v4.6.0.

Class io.agora.rtc2.DirectCdnStreamingStats

v4.6.0.

Class io.agora.rtc2.DirectCdnStreamingState

v4.6.0.

Class io.agora.rtc2.DirectCdnStreamingReason

v4.6.0.

Class io.agora.rtc2.DirectCdnStreamingMediaOptions

v4.6.0.

Member io.agora.rtc2.IRtcEngineEventHandler.onConnectionInterrupted ()

Use onConnectionStateChanged instead.

Member io.agora.musiccontentcenter.IAgoraMusicContentCenter.preload (long songCode, String jsonOption)

use preload(long songCode) instead.

Member io.agora.mediaplayer.IMediaPlayerObserver.onAgoraCDNTokenWillExpire ()

4.6.0

Member io.agora.mediaplayer.IMediaPlayer.switchAgoraCDNSrc (String src, boolean syncPts)

4.6.0

Member io.agora.mediaplayer.IMediaPlayer.renewAgoraCDNSrcToken (String token, long ts)

4.6.0

Member io.agora.mediaplayer.IMediaPlayer.enableAutoSwitchAgoraCDN (boolean enable)

4.6.0

Member io.agora.mediaplayer.IMediaPlayer.getCurrentAgoraCDNIndex ()

4.6.0

Member io.agora.mediaplayer.IMediaPlayer.switchAgoraCDNLineByIndex (int index)

4.6.0

Member io.agora.mediaplayer.IMediaPlayer.getAgoraCDNLineCount ()

4.6.0

Member io.agora.rtc2.IRtcEngineEventHandler.onLocalVideoStat (int sentBitrate, int sentFrameRate)

The statistics of the uploading local video streams once every two seconds.

Member io.agora.rtc2.live.LiveTranscoding.getRed ()

Gets the background color's red component.

Member io.agora.rtc2.live.LiveTranscoding.metadata

This parameter is deprecated.

Member io.agora.rtc2.live.LiveTranscoding.backgroundColor

This parameter is deprecated. We recommend using the {setBackgroundColor} method to set the background color.

Member io.agora.rtc2.live.LiveTranscoding.userCount

This parameter is deprecated. We recommend using the {getUserCount} method.

Member io.agora.rtc2.live.LiveTranscoding.lowLatency

Deprecated as of v2.8.0. Agora does not recommend using this parameter.

Member io.agora.rtc2.IRtcEngineEventHandler.onAudioMixingFinished ()

Use onAudioMixingStateChanged instead.

Member io.agora.rtc2.IRtcEngineEventHandler.onRemoteVideoTransportStats (int uid, int delay, int lost, int rxKBitRate)

Use onRemoteVideoStats instead.

Member io.agora.rtc2.IRtcEngineEventHandler.onRemoteAudioTransportStats (int uid, int delay, int lost, int rxKBitRate)

Use onRemoteAudioStats instead.

Member io.agora.rtc2.IRtcEngineEventHandler.onRemoteVideoStat (int uid, int delay, int receivedBitrate, int receivedFrameRate)

The statistics of receiving remote video streams once every two seconds.

Member io.agora.mediaplayer.IMediaPlayer.openWithAgoraCDNSrc (String src, long startPos)

4.6.0

Member io.agora.rtc2.IRtcEngineEventHandler.onAudioQuality (int uid, int quality, short delay, short lost)

This callback is deprecated. Use onRemoteAudioStats instead.

Member io.agora.rtc2.IRtcEngineEventHandler.onCameraReady ()

Use onLocalVideoStateChanged instead.

Member io.agora.rtc2.IRtcEngineEventHandler.onFirstRemoteAudioDecoded (int uid, int elapsed)

This method is deprecated. Use onRemoteAudioStateChanged instead.

Member io.agora.rtc2.IRtcEngineEventHandler.onFirstRemoteAudioFrame (int uid, int elapsed)

This method is deprecated. Use onRemoteAudioStateChanged instead.

Member io.agora.rtc2.IRtcEngineEventHandler.onUserEnableLocalVideo (int uid, boolean enabled)

This callback is deprecated and replaced by the onRemoteVideoStateChanged callback with the following parameters:

• 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 io.agora.rtc2.IRtcEngineEventHandler.onFirstRemoteVideoDecoded (int uid, int width, int height, int elapsed)

This callback is deprecated. Use REMOTE_VIDEO_STATE_STARTING(1) or REMOTE_VIDEO_STATE_DECODING(2) in the onRemoteVideoStateChanged callback instead.

Member io.agora.rtc2.IRtcEngineEventHandler.onVideoStopped ()

Use onLocalVideoStateChanged instead.

Member io.agora.rtc2.IRtcEngineEventHandler.onConnectionLost ()

Use onConnectionStateChanged instead.