Documentation
Interactive Live Streaming Premium (Legacy)
Console 官网 Community Technical support
English
search-icon

Agora Java API Reference for Android

Overview RtcEngine IRtcEngineEventHandler RtcChannel IRtcChannelEventHandler
Member io.agora.rtc.Constants.AUDIO_ELECTRONIC_VOICE
Deprecated from v3.2.0. A pitch correction effect that corrects the user's pitch based on the pitch of the natural C major scale.
Member io.agora.rtc.Constants.AUDIO_REVERB_FX_KTV
Deprecated from v3.2.0. The reverberation style typical of a KTV venue (enhanced).
Member io.agora.rtc.Constants.AUDIO_REVERB_FX_PHONOGRAPH
Deprecated from v3.2.0. The reverberation style typical of the vintage phonograph.
Member io.agora.rtc.Constants.AUDIO_REVERB_FX_POPULAR
Deprecated from v3.2.0. The reverberation style typical of popular music (enhanced).
Member io.agora.rtc.Constants.AUDIO_REVERB_FX_RNB
Deprecated from v3.2.0. The reverberation style typical of R&B music (enhanced).
Member io.agora.rtc.Constants.AUDIO_REVERB_FX_SISTER
Deprecated from v3.2.0. The reverberation style typical of a little sister's voice.
Member io.agora.rtc.Constants.AUDIO_REVERB_FX_STUDIO
Deprecated from v3.2.0. The reverberation style typical of a recording studio (enhanced).
Member io.agora.rtc.Constants.AUDIO_REVERB_FX_UNCLE
Deprecated from v3.2.0. The reverberation style typical of an uncle's voice.
Member io.agora.rtc.Constants.AUDIO_REVERB_FX_VOCAL_CONCERT
Deprecated from v3.2.0. The reverberation style typical of a concert hall (enhanced).
Member io.agora.rtc.Constants.AUDIO_REVERB_HIPHOP
Deprecated from v3.2.0. The reverberation style typical of hip-hop music.
Member io.agora.rtc.Constants.AUDIO_REVERB_KTV
Deprecated from v3.2.0. The reverberation style typical of a KTV venue.
Member io.agora.rtc.Constants.AUDIO_REVERB_OFF
Deprecated from v3.2.0. Turn off local voice reverberation, that is, to use the original voice.
Member io.agora.rtc.Constants.AUDIO_REVERB_POPULAR
Deprecated from v3.2.0. The reverberation style typical of popular music.
Member io.agora.rtc.Constants.AUDIO_REVERB_RNB
Deprecated from v3.2.0. The reverberation style typical of R&B music.
Member io.agora.rtc.Constants.AUDIO_REVERB_ROCK
Deprecated from v3.2.0. The reverberation style typical of rock music.
Member io.agora.rtc.Constants.AUDIO_REVERB_STUDIO
Deprecated from v3.2.0. The reverberation style typical of a recording studio.
Member io.agora.rtc.Constants.AUDIO_REVERB_VOCAL_CONCERT
Deprecated from v3.2.0. The reverberation style typical of a concert hall.
Member io.agora.rtc.Constants.AUDIO_THREEDIM_VOICE
Deprecated from v3.2.0. A 3D voice effect that makes the voice appear to be moving around the user.
Member io.agora.rtc.Constants.AUDIO_VIRTUAL_STEREO
Deprecated from v3.2.0. The reverberation of the virtual stereo. The virtual stereo is an effect that renders the monophonic audio as the stereo audio, so that all users in the channel can hear the stereo voice effect. To achieve better virtual stereo reverberation, Agora recommends setting profile in setAudioProfile as AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO.
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.GENERAL_BEAUTY_VOICE_FEMALE_FRESH
Deprecated from v3.2.0. (For female only) A fresher voice. Do not use it when the speaker is a male; otherwise, voice distortion occurs.
Member io.agora.rtc.Constants.GENERAL_BEAUTY_VOICE_FEMALE_VITALITY
Deprecated from v3.2.0. (For female only) A more vital voice. Do not use it when the speaker is a male; otherwise, voice distortion occurs.
Member io.agora.rtc.Constants.GENERAL_BEAUTY_VOICE_MALE_MAGNETIC
Deprecated from v3.2.0. (For male only) A more magnetic voice. Do not use it when the speaker is a female; otherwise, voice distortion occurs.
Member io.agora.rtc.Constants.MEDIA_ENGINE_AUDIO_ERROR_MIXING_INTERRUPTED_EOF
Deprecated from v3.4.0. Use related constants prefixed with AUDIO_MIXING_REASON instead.
Member io.agora.rtc.Constants.MEDIA_ENGINE_AUDIO_ERROR_MIXING_OPEN
Deprecated from v3.4.0. Use related constants prefixed with AUDIO_MIXING_REASON instead.
Member io.agora.rtc.Constants.MEDIA_ENGINE_AUDIO_ERROR_MIXING_TOO_FREQUENT
Deprecated from v3.4.0. Use related constants prefixed with AUDIO_MIXING_REASON instead.
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 or RTMPS 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 or RTMPS stream lifecycle to the owner of the RTMP or RTMPS 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.VOICE_BEAUTY_CLEAR
Deprecated from v3.2.0. A clearer voice.
Member io.agora.rtc.Constants.VOICE_BEAUTY_DEEP
Deprecated from v3.2.0. A deeper voice.
Member io.agora.rtc.Constants.VOICE_BEAUTY_FALSETTO
Deprecated from v3.2.0. Falsetto.
Member io.agora.rtc.Constants.VOICE_BEAUTY_FULL
Deprecated from v3.2.0. A fuller voice.
Member io.agora.rtc.Constants.VOICE_BEAUTY_MELLOW
Deprecated from v3.2.0. A mellower voice.
Member io.agora.rtc.Constants.VOICE_BEAUTY_RESOUNDING
Deprecated from v3.2.0. A more resounding voice.
Member io.agora.rtc.Constants.VOICE_BEAUTY_RINGING
Deprecated from v3.2.0. A more ringing voice.
Member io.agora.rtc.Constants.VOICE_BEAUTY_SPACIAL
Deprecated from v3.2.0. A more spatially resonant voice.
Member io.agora.rtc.Constants.VOICE_BEAUTY_VIGOROUS
Deprecated from v3.2.0. A more vigorous voice.
Member io.agora.rtc.Constants.VOICE_CHANGER_BABYBOY
Deprecated from v3.2.0. The voice of a little boy.
Member io.agora.rtc.Constants.VOICE_CHANGER_BABYGIRL
Deprecated from v3.2.0. The voice of a little girl.
Member io.agora.rtc.Constants.VOICE_CHANGER_ETHEREAL
Deprecated from v3.2.0. The ethereal voice.
Member io.agora.rtc.Constants.VOICE_CHANGER_HULK
Deprecated from v3.2.0. The voice of Hulk.
Member io.agora.rtc.Constants.VOICE_CHANGER_OFF
Deprecated from v3.2.0. Turn off the local voice changer, that is, to use the original voice.
Member io.agora.rtc.Constants.VOICE_CHANGER_OLDMAN
Deprecated from v3.2.0. The voice of an old man.
Member io.agora.rtc.Constants.VOICE_CHANGER_ZHUBAJIE
Deprecated from v3.2.0. The voice of Zhu Bajie, a character in Journey to the West who has a voice like that of a growling bear.
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.Constants.WARN_SET_CLIENT_ROLE_NOT_AUTHORIZED
Deprecated as of v3.7.0. Use reason reported in onClientRoleChangeFailed instead.
Member io.agora.rtc.IAudioEffectManager.playEffect (int soundId, String filePath, int loopCount, double pitch, double pan, double gain, boolean publish)
Deprecated from v3.4.0. Use playEffect[3/3] instead.
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 playEffect[3/3] 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.ErrorCode.ERR_VCM_ENCODER_SET_ERROR
This error code is deprecated. 1603: Video Device Module: Error in setting the video encoder.
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.onFirstLocalAudioFrame (int elapsed)
Deprecated as of v3.1.0. Use IRtcEngineEventHandler#onFirstLocalAudioFramePublished() instead.
Member io.agora.rtc.IRtcEngineEventHandler.onFirstRemoteAudioDecoded (int uid, int elapsed)
v3.0.0. Use REMOTE_AUDIO_STATE_DECODING(2) in onRemoteAudioStateChanged instead.
Member io.agora.rtc.IRtcEngineEventHandler.onFirstRemoteAudioFrame (int uid, int elapsed)
v3.0.0. Use REMOTE_AUDIO_STATE_STARTING(1) in onRemoteAudioStateChanged 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)
v2.9.0. This callback is deprecated. Use LOCAL_AUDIO_STREAM_STATE_STOPPED(0) or LOCAL_AUDIO_STREAM_STATE_CAPTURING(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.onStreamPublished (String url, int error)
v3.0.0. Use onRtmpStreamingStateChanged instead.
Member io.agora.rtc.IRtcEngineEventHandler.onStreamUnpublished (String url)
v3.0.0. Use onRtmpStreamingStateChanged instead.
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). In scenarios where audio and video is synchronized, you can use the value of networkTransportDelay and jitterBufferDelay in RemoteAudioStats to know the delay statistics of the remote video.
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.backgroundImage
Deprecated from v3.6.0. Use addBackgroundImage instead.
Member io.agora.rtc.live.LiveTranscoding.getBlue ()
Gets the background color's blue component.
Member io.agora.rtc.live.LiveTranscoding.getGreen ()
Gets the background color's green component.
Member io.agora.rtc.live.LiveTranscoding.getRed ()
Gets 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.
Member io.agora.rtc.live.LiveTranscoding.watermark
Deprecated from v3.6.0. Use addWatermark instead.
Member io.agora.rtc.RtcChannel.addPublishStreamUrl (String url, boolean transcodingEnabled)
This method is deprecated as of v3.6.0. See Release Notes for an alternative solution.
Member io.agora.rtc.RtcChannel.createDataStream (boolean reliable, boolean ordered)
This method is deprecated from v3.3.0. Use the createDataStream[2/2] method instead.
Member io.agora.rtc.RtcChannel.enableRemoteSuperResolution (int uid, boolean enable)
This method is deprecated as of v3.7.1. Use enableRemoteSuperResolution[2/2] instead.
Member io.agora.rtc.RtcChannel.publish ()
This method is deprecated as of v3.4.5. Use muteLocalAudioStream(false) or muteLocalVideoStream(false) instead.
Member io.agora.rtc.RtcChannel.removePublishStreamUrl (String url)
This method is deprecated as of v3.6.0. See Release Notes for an alternative solution.
Member io.agora.rtc.RtcChannel.setDefaultMuteAllRemoteAudioStreams (boolean muted)
This method is deprecated from v3.3.0.
Member io.agora.rtc.RtcChannel.setDefaultMuteAllRemoteVideoStreams (boolean muted)
This method is deprecated from v3.3.0.
Member io.agora.rtc.RtcChannel.setEncryptionMode (String encryptionMode)
Deprecated as of v3.1.0. Use enableEncryption instead.
Member io.agora.rtc.RtcChannel.setEncryptionSecret (String secret)
Deprecated as of v3.1.0. Use enableEncryption instead.
Member io.agora.rtc.RtcChannel.setLiveTranscoding (LiveTranscoding transcoding)
This method is deprecated as of v3.6.0. See Release Notes for an alternative solution.
Member io.agora.rtc.RtcChannel.unpublish ()
This method is deprecated as of v3.4.5. Use muteLocalAudioStream(true) or muteLocalVideoStream(true) instead.
Member io.agora.rtc.RtcEngine.addPublishStreamUrl (String url, boolean transcodingEnabled)
This method is deprecated as of v3.6.0. See Release Notes for an alternative solution.
Member io.agora.rtc.RtcEngine.addVideoWatermark (AgoraImage watermark)
From v2.9.1. We recommend using the addVideoWatermark2 method instead.
Member io.agora.rtc.RtcEngine.createDataStream (boolean reliable, boolean ordered)
This method is deprecated from v3.3.0. Use the createDataStream[2/2] method instead.
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.enableRemoteSuperResolution (int uid, boolean enable)
This method is deprecated as of v3.7.1. Use enableRemoteSuperResolution[2/2] instead.
Member io.agora.rtc.RtcEngine.enableWebSdkInteroperability (boolean enabled)
v3.0.0. As of v3.0.0, the Native SDK automatically enables interoperability with the Web SDK, so you no longer need to call this method.
Member io.agora.rtc.RtcEngine.getAudioMixingDuration ()
This method is deprecated as of v3.5.1. Use getAudioFileInfo instead.
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.pushExternalAudioFrame (byte[] data, long timestamp)
This method is deprecated as of v3.5.1. Use pushExternalAudioFrame [2/2] instead.
Member io.agora.rtc.RtcEngine.removePublishStreamUrl (String url)
This method is deprecated as of v3.6.0. See Release Notes for an alternative solution.
Member io.agora.rtc.RtcEngine.resumeAudio ()
This method is deprecated. We recommend using the disableAudio method instead.
Member io.agora.rtc.RtcEngine.setDefaultMuteAllRemoteAudioStreams (boolean muted)
This method is deprecated from v3.3.0.
Member io.agora.rtc.RtcEngine.setDefaultMuteAllRemoteVideoStreams (boolean muted)
This method is deprecated from v3.3.0.
Member io.agora.rtc.RtcEngine.setEncryptionMode (String encryptionMode)
Deprecated as of v3.1.0. Use enableEncryption instead.
Member io.agora.rtc.RtcEngine.setEncryptionSecret (String secret)
Deprecated as of v3.1.0. Use enableEncryption 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.setLiveTranscoding (LiveTranscoding transcoding)
This method is deprecated as of v3.6.0. See Release Notes for an alternative solution.
Member io.agora.rtc.RtcEngine.setLocalRenderMode (int renderMode)
v3.0.0. Use setLocalRenderMode2 instead.
Member io.agora.rtc.RtcEngine.setLocalVideoMirrorMode (int mode)
From v3.0.0. Use setupLocalVideo or setLocalRenderMode instead.
Member io.agora.rtc.RtcEngine.setLocalVoiceChanger (int voiceChanger)
Deprecated from v3.2.0. Use the following methods instead:
  • setAudioEffectPreset: Audio effects.
  • setVoiceBeautifierPreset: Voice beautifier effects.
  • setVoiceConversionPreset: Voice conversion effects.
Member io.agora.rtc.RtcEngine.setLocalVoiceReverbPreset (int preset)
Deprecated from v3.2.0. Use setAudioEffectPreset or setVoiceBeautifierPreset instead.
Member io.agora.rtc.RtcEngine.setLogFile (String filePath)
This method is deprecated from v3.3.0. Use the mLogConfig parameter in create[2/2] to set the log file path instead.
Member io.agora.rtc.RtcEngine.setLogFileSize (int fileSizeInKBytes)
This method is deprecated from v3.3.0. Use the mLogConfig parameter in the create[2/2] method instead.
Member io.agora.rtc.RtcEngine.setLogFilter (int filter)
This method is deprecated from v3.3.0. Use the mLogConfig parameter in the create[2/2] method instead.
Member io.agora.rtc.RtcEngine.setPreferHeadset (boolean enabled)
This method is deprecated.
Member io.agora.rtc.RtcEngine.setRemoteRenderMode (int uid, int renderMode)
v3.0.0. Use setRemoteRenderMode2 instead.
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.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.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.startAudioMixing (String filePath, boolean loopback, boolean replace, int cycle)
Deprecated from v3.4.0. Use startAudioMixing[2/2] instead.
Member io.agora.rtc.RtcEngine.startAudioRecording (String filePath, int quality)
Deprecated from v2.9.1. Use startAudioRecording[3/3] instead.
Member io.agora.rtc.RtcEngine.startAudioRecording (String filePath, int sampleRate, int quality)
Deprecated from v2.9.1. Use startAudioRecording[3/3] instead.
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.