Member io.agora.rtc.Constants.ERR_INVALID_TOKEN
From v2.4.1. Use CONNECTION_CHANGED_INVALID_TOKEN(8) in the onConnectionStateChanged callback instead.
Member io.agora.rtc.Constants.ERR_START_CAMERA
From v2.4.1. Use LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE(4) in the onLocalVideoStateChanged callback instead.
Member io.agora.rtc.Constants.ERR_TOKEN_EXPIRED
From v2.4.1. Use CONNECTION_CHANGED_TOKEN_EXPIRED(9) in the onConnectionStateChanged callback instead.
Member io.agora.rtc.Constants.ERR_VCM_ENCODER_SET_ERROR
This error code is deprecated. 1603: Video Device Module: Error in setting the video encoder.
Member io.agora.rtc.Constants.RENDER_MODE_ADAPTIVE
3: Adaptive mode: If both callers use the same screen orientation, such as both use vertical screens or both use horizontal screens, the RENDER_MODE_HIDDEN mode applies; if they use different screen orientations, such as one vertical and one horizontal, the RENDER_MODE_FIT mode applies.
Member io.agora.rtc.Constants.STREAM_LIFE_CYCLE_BIND2CHANNEL
1: Binds the RTMP stream lifecycle to the channel lifecycle. If all hosts leave the channel, CDN live streaming stops after 30 seconds.
Member io.agora.rtc.Constants.STREAM_LIFE_CYCLE_BIND2OWNER
2: Binds the RTMP stream lifecycle to the owner of the RTMP stream. If the owner leaves the channel, CDN live streaming stops immediately.
Member io.agora.rtc.Constants.VIDEO_PROFILE_120P
0: Resolution: 160 × 120; Frame rate: 15 fps; Bitrate: 65 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_120P_3
2: Resolution: 120 × 120; Frame rate: 15 fps; Bitrate 50 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_180P
10: Resolution: 320 × 180; Frame rate: 15 fps; Bitrate: 140 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_180P_3
12: Resolution: 180 × 180; Frame rate: 15 fps; Bitrate: 100 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_180P_4
13: Resolution: 240 × 180; Frame rate: 15 fps; Bitrate: 120 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_240P
20: Resolution: 320 × 240; Frame rate: 15 fps; Bitrate: 200 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_240P_3
22: Resolution: 240 × 240; Frame rate: 15 fps; Bitrate: 140 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_240P_4
23: Resolution: 424 × 240; Frame rate: 15 fps; Bitrate: 220 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_360P
30: Resolution: 640 × 360; Frame rate: 15 fps; Bitrate: 400 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_360P_10
39: Resolution: 640 × 360; Frame rate: 24 fps; Bitrate: 800 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_360P_11
100: Resolution: 640 × 360; Frame rate: 24 fps; Bitrate: 1000 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_360P_3
32: Resolution: 360 × 360; Frame rate: 15 fps; Bitrate: 260 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_360P_4
33: Resolution: 640 × 360; Frame rate: 30 fps; Bitrate: 600 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_360P_6
35: Resolution: 360 × 360; Frame rate: 30 fps; Bitrate: 400 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_360P_7
36: Resolution: 480 × 360; Frame rate: 15 fps; Bitrate: 320 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_360P_8
37: Resolution: 480 × 360; Frame rate: 30 fps; Bitrate: 490 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_360P_9
38: Resolution: 640 × 360; Frame rate: 15 fps; Bitrate: 800 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_480P
40: Resolution: 640 × 480; Frame rate: 15 fps; Bitrate: 500 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_480P_10
49: Resolution: 640 × 480; Frame rate: 10 fps; Bitrate: 400 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_480P_3
42: Resolution: 480 × 480; Frame rate: 15 fps; Bitrate: 400 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_480P_4
43: Resolution: 640 × 480; Frame rate: 30 fps; Bitrate: 750 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_480P_6
45: Resolution: 480 × 480; Frame rate: 30 fps; Bitrate: 600 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_480P_8
47: Resolution: 848 × 480; Frame rate: 15 fps; Bitrate: 610 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_480P_9
48: Resolution: 848 × 480; Frame rate: 30 fps; Bitrate: 930 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_720P
50: Resolution: 1280 × 720; Frame rate: 15 fps; Bitrate: 1130 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_720P_3
52: Resolution: 1280 × 720; Frame rate: 30 fps; Bitrate: 1710 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_720P_5
54: Resolution: 960 × 720; Frame rate: 15 fps; Bitrate: 910 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_720P_6
55: Resolution: 960 × 720; Frame rate: 30 fps; Bitrate: 1380 Kbps
Member io.agora.rtc.Constants.VIDEO_PROFILE_DEFAULT
Default video profile: Resolution: 640 × 360; Frame rate: 15 fps; Bitrate: 400 Kbps
Member io.agora.rtc.Constants.WARN_LOOKUP_CHANNEL_REJECTED
This error code is deprecated. Use CONNECTION_CHANGED_REJECTED_BY_SERVER(10) in the onConnectionStateChanged callback instead. 105: The server rejects the request to look up the channel. The server cannot process this request or the request is illegal.
Member io.agora.rtc.IAudioEffectManager.playEffect (int soundId, String filePath, int loop, double pitch, double pan, double gain)
This method is deprecated. We recommend using the playEffect2 method to play the local audio effect.
Member io.agora.rtc.IRtcEngineEventHandler.ErrorCode.ERR_INVALID_TOKEN
From v2.4.1. Use CONNECTION_CHANGED_INVALID_TOKEN(8) in the onConnectionStateChanged callback instead.
Member io.agora.rtc.IRtcEngineEventHandler.ErrorCode.ERR_START_CAMERA
From v2.4.1. Use LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE(4) in the onLocalVideoStateChanged callback instead.
Member io.agora.rtc.IRtcEngineEventHandler.ErrorCode.ERR_TOKEN_EXPIRED
From v2.4.1. Use CONNECTION_CHANGED_TOKEN_EXPIRED(9) in the onConnectionStateChanged callback instead.
Member io.agora.rtc.IRtcEngineEventHandler.onAudioMixingFinished ()
This callback is deprecated. Use onAudioMixingStateChanged instead.
Member io.agora.rtc.IRtcEngineEventHandler.onAudioQuality (int uid, int quality, short delay, short lost)
From v2.3.2. Use onRemoteAudioStats instead.
Member io.agora.rtc.IRtcEngineEventHandler.onCameraReady ()
From v2.4.1. Use LOCAL_VIDEO_STREAM_STATE_CAPTURING(1) in the onLocalVideoStateChanged callback instead. If the camera fails to turn on, fix the error reported in the onError callback.
Member io.agora.rtc.IRtcEngineEventHandler.onConnectionBanned ()
From v2.3.2. Use onConnectionStateChanged instead.
Member io.agora.rtc.IRtcEngineEventHandler.onConnectionInterrupted ()
From v2.3.2. Use onConnectionStateChanged instead.
Member io.agora.rtc.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.rtc.IRtcEngineEventHandler.onLocalVideoStat (int sentBitrate, int sentFrameRate)
This method is deprecated. We recommend using onLocalVideoStats to get the local video statistics.
Member io.agora.rtc.IRtcEngineEventHandler.onMicrophoneEnabled (boolean enabled)
This callback is deprecated. Use LOCAL_AUDIO_STREAM_STATE_STOPPED(0) or LOCAL_AUDIO_STREAM_STATE_RECORDING(1) in the onLocalAudioStateChanged callback instead.
Member io.agora.rtc.IRtcEngineEventHandler.onRemoteAudioTransportStats (int uid, int delay, int lost, int rxKBitRate)
This callback is deprecated. Use onRemoteAudioStats instead.
Member io.agora.rtc.IRtcEngineEventHandler.onRemoteVideoStat (int uid, int delay, int receivedBitrate, int receivedFrameRate)
This method is deprecated. We recommend using onRemoteVideoStats to get the remote video statistics.
Member io.agora.rtc.IRtcEngineEventHandler.onRemoteVideoTransportStats (int uid, int delay, int lost, int rxKBitRate)
This callback is deprecated. Use onRemoteVideoStats instead.
Member io.agora.rtc.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.rtc.IRtcEngineEventHandler.onUserEnableVideo (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.rtc.IRtcEngineEventHandler.onVideoStopped ()
From v2.4.1. Use LOCAL_VIDEO_STREAM_STATE_STOPPED(0) in the onLocalVideoStateChanged callback instead. The application can use this callback to change the configuration of the view (for example, displaying other pictures in the view) after the video stops playing.
Member io.agora.rtc.IRtcEngineEventHandler.RemoteVideoStats.delay
Time delay (ms).
Class io.agora.rtc.IRtcEngineEventHandler.VideoProfile
This class is deprecated.
Member io.agora.rtc.IRtcEngineEventHandler.WarnCode.WARN_LOOKUP_CHANNEL_REJECTED
From v2.4.1. Use CONNECTION_CHANGED_REJECTED_BY_SERVER(10) in the onConnectionStateChanged callback instead.
Member io.agora.rtc.live.LiveTranscoding.backgroundColor
This parameter is deprecated. We recommend using the setBackgroundColor method to set the background color.
Member io.agora.rtc.live.LiveTranscoding.getBlue ()
Retrieves the background color's blue component.
Member io.agora.rtc.live.LiveTranscoding.getGreen ()
Retrieves the background color's green component.
Member io.agora.rtc.live.LiveTranscoding.getRed ()
Retrieves the background color's red component.
Member io.agora.rtc.live.LiveTranscoding.lowLatency
Deprecated as of v2.8.0. Agora does not recommend using this parameter. Latency mode:
Member io.agora.rtc.live.LiveTranscoding.metadata
This parameter is deprecated.
Member io.agora.rtc.live.LiveTranscoding.setBlue (int blue)
Sets the background color's blue component.
Member io.agora.rtc.live.LiveTranscoding.setGreen (int green)
Sets the background color's green component.
Member io.agora.rtc.live.LiveTranscoding.setRed (int red)
Sets the background color's red component.
Member io.agora.rtc.live.LiveTranscoding.userCount
This parameter is deprecated. We recommend using the getUserCount method.
Class io.agora.rtc.PublisherParameters
Member io.agora.rtc.RtcEngine.enableAudioQualityIndication (boolean enabled)
From v2.4.1.
Member io.agora.rtc.RtcEngine.enableHighPerfWifiMode (boolean enable)
This method is deprecated.
Member io.agora.rtc.RtcEngine.getMediaEngineVersion ()
This method is deprecated.
Member io.agora.rtc.RtcEngine.getRecommendedEncoderType ()
This method is deprecated.
Member io.agora.rtc.RtcEngine.monitorBluetoothHeadsetEvent (boolean monitor)
This method is deprecated.
Member io.agora.rtc.RtcEngine.monitorHeadsetEvent (boolean monitor)
This method is deprecated.
Member io.agora.rtc.RtcEngine.pauseAudio ()
This method is deprecated. We recommend using the enableAudio method instead.
Member io.agora.rtc.RtcEngine.resumeAudio ()
This method is deprecated. We recommend using the disableAudio method instead.
Member io.agora.rtc.RtcEngine.setHighQualityAudioParameters (boolean fullband, boolean stereo, boolean fullBitrate)
This method is deprecated. Agora does not recommend using this method. If you want to set the audio profile, use the setAudioProfile method. Call this method and set all parameters before joining a channel. Do not call this method again after joining a channel.
Member io.agora.rtc.RtcEngine.setPreferHeadset (boolean enabled)
This method is deprecated.
Member io.agora.rtc.RtcEngine.setVideoProfile (int profile, boolean swapWidthAndHeight)
From v2.3.0. We recommend using the setVideoEncoderConfiguration method to set the video profile.
Member io.agora.rtc.RtcEngine.setVideoProfile (int width, int height, int frameRate, int bitrate)
From v2.3.0. We recommend using the setVideoEncoderConfiguration method to set the video profile.
Member io.agora.rtc.RtcEngine.setVideoQualityParameters (boolean preferFrameRateOverImageQuality)
From v2.4.0. We recommend using the degradationPrefer parameter in the VideoEncoderConfiguration Class to set the video preference.
Member io.agora.rtc.RtcEngine.startEchoTest ()
Since v2.4.0. We recommend using startEchoTest to start an audio call test.
Member io.agora.rtc.RtcEngine.useExternalAudioDevice ()
This method is deprecated.
Member io.agora.rtc.video.VideoCanvas.RENDER_MODE_ADAPTIVE
3: This mode is deprecated and Agora does not recommend using it.