Deprecated API

Contents

• Interfaces
• Classes
• Enum Classes
• Fields
• Methods

Deprecated Interfaces

Interface	Description
io.agora.rtc2.IDirectCdnStreamingEventHandler	v4.6.0.

Deprecated Classes

Class	Description
io.agora.rtc2.DirectCdnStreamingMediaOptions	v4.6.0.
io.agora.rtc2.DirectCdnStreamingStats	v4.6.0.
io.agora.rtc2.IRtcEngineEventHandler.ClientRole	Use the new Constants class with the same constants value
io.agora.rtc2.IRtcEngineEventHandler.Quality	Use the new Constants class with the same constants value
io.agora.rtc2.IRtcEngineEventHandler.UserOfflineReason	Use the new Constants class with the same constants value
io.agora.rtc2.IRtcEngineEventHandler.VideoProfile	Use the new Constants class with the same constants value
io.agora.rtc2.PublisherConfiguration.Builder	If you want to configure the push-stream, Agora recommends using the setLiveTranscoding method.
io.agora.rtc2.PublisherParameters
io.agora.rtc2.video.VideoCompositingLayout

Deprecated Enum Classes

Enum Class	Description
io.agora.rtc2.DirectCdnStreamingReason	v4.6.0.
io.agora.rtc2.DirectCdnStreamingState	v4.6.0.

Deprecated Fields

Field	Description
io.agora.rtc2.Constants.VIDEO_PROFILE_1080P
io.agora.rtc2.Constants.VIDEO_PROFILE_1080P_3
io.agora.rtc2.Constants.VIDEO_PROFILE_1080P_5
io.agora.rtc2.Constants.VIDEO_PROFILE_120P
io.agora.rtc2.Constants.VIDEO_PROFILE_120P_3
io.agora.rtc2.Constants.VIDEO_PROFILE_1440P
io.agora.rtc2.Constants.VIDEO_PROFILE_1440P_2
io.agora.rtc2.Constants.VIDEO_PROFILE_180P
io.agora.rtc2.Constants.VIDEO_PROFILE_180P_3
io.agora.rtc2.Constants.VIDEO_PROFILE_180P_4
io.agora.rtc2.Constants.VIDEO_PROFILE_240P
io.agora.rtc2.Constants.VIDEO_PROFILE_240P_3
io.agora.rtc2.Constants.VIDEO_PROFILE_240P_4
io.agora.rtc2.Constants.VIDEO_PROFILE_360P
io.agora.rtc2.Constants.VIDEO_PROFILE_360P_10
io.agora.rtc2.Constants.VIDEO_PROFILE_360P_11
io.agora.rtc2.Constants.VIDEO_PROFILE_360P_3
io.agora.rtc2.Constants.VIDEO_PROFILE_360P_4
io.agora.rtc2.Constants.VIDEO_PROFILE_360P_6
io.agora.rtc2.Constants.VIDEO_PROFILE_360P_7
io.agora.rtc2.Constants.VIDEO_PROFILE_360P_8
io.agora.rtc2.Constants.VIDEO_PROFILE_360P_9
io.agora.rtc2.Constants.VIDEO_PROFILE_480P
io.agora.rtc2.Constants.VIDEO_PROFILE_480P_10
io.agora.rtc2.Constants.VIDEO_PROFILE_480P_3
io.agora.rtc2.Constants.VIDEO_PROFILE_480P_4
io.agora.rtc2.Constants.VIDEO_PROFILE_480P_6
io.agora.rtc2.Constants.VIDEO_PROFILE_480P_8
io.agora.rtc2.Constants.VIDEO_PROFILE_480P_9
io.agora.rtc2.Constants.VIDEO_PROFILE_4K
io.agora.rtc2.Constants.VIDEO_PROFILE_4K_3
io.agora.rtc2.Constants.VIDEO_PROFILE_720P
io.agora.rtc2.Constants.VIDEO_PROFILE_720P_3
io.agora.rtc2.Constants.VIDEO_PROFILE_720P_5
io.agora.rtc2.Constants.VIDEO_PROFILE_720P_6
io.agora.rtc2.Constants.VIDEO_PROFILE_DEFAULT
io.agora.rtc2.live.LiveTranscoding.backgroundColor	This parameter is deprecated. We recommend using the setBackgroundColor method to set the background color.
io.agora.rtc2.live.LiveTranscoding.lowLatency	Deprecated as of v2.8.0. Agora does not recommend using this parameter.
io.agora.rtc2.live.LiveTranscoding.metadata	This parameter is deprecated.
io.agora.rtc2.live.LiveTranscoding.userCount	This parameter is deprecated. We recommend using the getUserCount method.
io.agora.rtc2.video.ContentInspectConfig.CONTENT_INSPECT_TYPE_MODERATION	Content inspect type moderation

Deprecated Methods

Method	Description
io.agora.mediaplayer.IMediaPlayer.enableAutoSwitchAgoraCDN(boolean)	4.6.0
io.agora.mediaplayer.IMediaPlayer.getAgoraCDNLineCount()	4.6.0
io.agora.mediaplayer.IMediaPlayer.getCurrentAgoraCDNIndex()	4.6.0
io.agora.mediaplayer.IMediaPlayer.openWithAgoraCDNSrc(String, long)	4.6.0
io.agora.mediaplayer.IMediaPlayer.renewAgoraCDNSrcToken(String, long)	4.6.0
io.agora.mediaplayer.IMediaPlayer.switchAgoraCDNLineByIndex(int)	4.6.0
io.agora.mediaplayer.IMediaPlayer.switchAgoraCDNSrc(String, boolean)	4.6.0
io.agora.mediaplayer.IMediaPlayerObserver.onAgoraCDNTokenWillExpire()	4.6.0
io.agora.rtc2.IRtcEngineEventHandler.onAudioMixingFinished()	Use onAudioMixingStateChanged instead.
io.agora.rtc2.IRtcEngineEventHandler.onCameraReady()	Use onLocalVideoStateChanged instead.
io.agora.rtc2.IRtcEngineEventHandler.onFirstRemoteVideoDecoded(int, int, int, int)	This callback is deprecated. Use `REMOTE_VIDEO_STATE_STARTING(1)` or `REMOTE_VIDEO_STATE_DECODING(2)` in the onRemoteVideoStateChanged callback instead.
io.agora.rtc2.IRtcEngineEventHandler.onLocalVideoStat(int, int)	The statistics of the uploading local video streams once every two seconds.
io.agora.rtc2.IRtcEngineEventHandler.onRemoteAudioTransportStats(int, int, int, int)	Use onRemoteAudioStats instead.
io.agora.rtc2.IRtcEngineEventHandler.onRemoteVideoStat(int, int, int, int)	The statistics of receiving remote video streams once every two seconds.
io.agora.rtc2.IRtcEngineEventHandler.onRemoteVideoTransportStats(int, int, int, int)	Use onRemoteVideoStats instead.
io.agora.rtc2.IRtcEngineEventHandler.onUserEnableLocalVideo(int, boolean)	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)`.
io.agora.rtc2.IRtcEngineEventHandler.onVideoStopped()	Use onLocalVideoStateChanged instead.
io.agora.rtc2.live.LiveTranscoding.getBlue()	Gets the background color's blue component.
io.agora.rtc2.live.LiveTranscoding.getGreen()	Gets the background color's green component.
io.agora.rtc2.live.LiveTranscoding.getRed()	Gets the background color's red component.
io.agora.rtc2.live.LiveTranscoding.setBlue(int)	Sets the background color's blue component.
io.agora.rtc2.live.LiveTranscoding.setGreen(int)	Sets the background color's green component.
io.agora.rtc2.live.LiveTranscoding.setRed(int)	Sets the background color's red component.
io.agora.rtc2.RtcEngine.addVideoWatermark(AgoraImage)	From v2.9.1. We recommend using the addVideoWatermark2 method instead.
io.agora.rtc2.RtcEngine.addVideoWatermark(String, WatermarkOptions)	From v4.6.0. We recommend using the addVideoWatermark2 method instead.
io.agora.rtc2.RtcEngine.enableDualStreamMode(boolean)	v4.2.0. This method is deprecated. Use setDualStreamMode instead.
io.agora.rtc2.RtcEngine.enableDualStreamMode(boolean, SimulcastStreamConfig)	v4.2.0. This method is deprecated. Use setDualStreamMode instead.
io.agora.rtc2.RtcEngine.enableHighPerfWifiMode(boolean)	This method is deprecated.
io.agora.rtc2.RtcEngine.getMediaEngineVersion()
io.agora.rtc2.RtcEngine.getRecommendedEncoderType()	This method is deprecated.
io.agora.rtc2.RtcEngine.monitorBluetoothHeadsetEvent(boolean)
io.agora.rtc2.RtcEngine.monitorHeadsetEvent(boolean)
io.agora.rtc2.RtcEngine.pushExternalAudioFrame(byte[], long)	This method is deprecated. Use pushExternalAudioFrame(byte[] data, long timestamp, int sampleRate, int channels, Constants.BytesPerSample bytesPerSample, int trackId) instead.
io.agora.rtc2.RtcEngine.pushExternalAudioFrame(ByteBuffer, long, int)	This method is deprecated. Use pushExternalAudioFrame(ByteBuffer[] data, long timestamp, int sampleRate, int channels, Constants.BytesPerSample bytesPerSample, int trackId) instead.
io.agora.rtc2.RtcEngine.pushExternalEncodedVideoFrame(ByteBuffer, EncodedVideoFrameInfo)	This method is deprecated.
io.agora.rtc2.RtcEngine.pushExternalVideoFrame(VideoFrame)	This method is deprecated.
io.agora.rtc2.RtcEngine.setDirectCdnStreamingAudioConfiguration(int)	v4.6.0.
io.agora.rtc2.RtcEngine.setDirectCdnStreamingVideoConfiguration(VideoEncoderConfiguration)	v4.6.0.
io.agora.rtc2.RtcEngine.setExternalAudioSource(boolean, int, int)	This method is deprecated. Use createCustomAudioTrack(Constants.AudioTrackType trackType, AudioTrackConfig config) instead.
io.agora.rtc2.RtcEngine.setExternalAudioSource(boolean, int, int, boolean, boolean)	This method is deprecated. Use createCustomAudioTrack(Constants.AudioTrackType trackType, AudioTrackConfig config) instead.
io.agora.rtc2.RtcEngine.setLocalRenderMode(int)
io.agora.rtc2.RtcEngine.setLocalVideoMirrorMode(int)
io.agora.rtc2.RtcEngine.setPreferHeadset(boolean)	This method is deprecated.
io.agora.rtc2.RtcEngine.setRemoteDefaultVideoStreamType(int)
io.agora.rtc2.RtcEngine.setRemoteRenderMode(int, int)
io.agora.rtc2.RtcEngine.setRemoteSubscribeFallbackOption(int)
io.agora.rtc2.RtcEngine.setRemoteVideoStreamType(int, int)
io.agora.rtc2.RtcEngine.startDirectCdnStreaming(IDirectCdnStreamingEventHandler, String, DirectCdnStreamingMediaOptions)	v4.6.0.
io.agora.rtc2.RtcEngine.stopDirectCdnStreaming()	v4.6.0.
io.agora.rtc2.RtcEngine.updateDirectCdnStreamingMediaOptions(DirectCdnStreamingMediaOptions)	v4.6.0.
io.agora.rtc2.RtcEngineEx.addVideoWatermarkEx(String, WatermarkOptions, RtcConnection)	From v4.6.0. We recommend using the addVideoWatermark2 method instead.
io.agora.rtc2.RtcEngineEx.enableDualStreamModeEx(boolean, SimulcastStreamConfig, RtcConnection)	v4.2.0. This method is deprecated. Use setDualStreamModeEx instead.
io.agora.rtc2.RtcEngineEx.pauseAllChannelMediaRelayEx(RtcConnection)	This method is deprecated from v4.2.0. Use `startOrUpdateChannelMediaRelayEx` instead.
io.agora.rtc2.RtcEngineEx.setRemoteVideoStreamTypeEx(int, int, RtcConnection)