Index

A B C D E F G H I J L M N O P Q R S T U V W X Y Z 
All Classes and Interfaces|All Packages|Constant Field Values

A

activePathNum - Variable in class io.agora.rtc2.IRtcEngineEventHandler.MultipathStats
The number of currently active transmission paths.
addBackgroundImage(AgoraImage) - Method in class io.agora.rtc2.live.LiveTranscoding
add background image to backgroundImageList
addExtension(String) - Method in class io.agora.rtc2.RtcEngineConfig
 
addHandler(IRtcEngineEventHandler) - Method in class io.agora.rtc2.RtcEngine
 
addHandlerEx(IRtcEngineEventHandler, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Adds the IRtcEngineEventHandler.
addOrUpdateVideoEffect(int, String) - Method in interface io.agora.rtc2.IVideoEffectObject
 
addUser(LiveTranscoding.TranscodingUser) - Method in class io.agora.rtc2.live.LiveTranscoding
Adds a user displaying the video in CDN live.
addVideoWatermark(AgoraImage) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
From v2.9.1. We recommend using the addVideoWatermark2 method instead.
addVideoWatermark(WatermarkConfig) - Method in class io.agora.rtc2.RtcEngine
 
addVideoWatermark(String, WatermarkOptions) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
From v4.6.0. We recommend using the addVideoWatermark2 method instead.
addVideoWatermarkEx(WatermarkConfig, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
addVideoWatermarkEx(String, WatermarkOptions, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Deprecated.
From v4.6.0. We recommend using the addVideoWatermark2 method instead.
addWatermark(AgoraImage) - Method in class io.agora.rtc2.live.LiveTranscoding
add watermark to list
addWindow(VideoCompositingLayout.Region) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Builder
Deprecated.
 
adjustAudioMixingPlayoutVolume(int) - Method in class io.agora.rtc2.RtcEngine
 
adjustAudioMixingPublishVolume(int) - Method in class io.agora.rtc2.RtcEngine
 
adjustAudioMixingVolume(int) - Method in class io.agora.rtc2.RtcEngine
 
adjustCustomAudioPlayoutVolume(int, int) - Method in class io.agora.rtc2.RtcEngine
 
adjustCustomAudioPublishVolume(int, int) - Method in class io.agora.rtc2.RtcEngine
 
adjustPlaybackSignalVolume(int) - Method in class io.agora.rtc2.RtcEngine
 
adjustPlayoutVolume(int) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
adjustPublishSignalVolume(int) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
adjustRecordingSignalVolume(int) - Method in class io.agora.rtc2.RtcEngine
 
adjustRecordingSignalVolumeEx(int, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Adjusts the recording volume.
adjustUserPlaybackSignalVolume(int, int) - Method in class io.agora.rtc2.RtcEngine
 
adjustUserPlaybackSignalVolumeEx(int, int, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
AdvancedAudioOptions - Class in io.agora.rtc2.audio
 
AdvancedAudioOptions() - Constructor for class io.agora.rtc2.audio.AdvancedAudioOptions
 
AdvancedAudioOptions(AdvancedAudioOptions.AudioProcessingChannelsEnum) - Constructor for class io.agora.rtc2.audio.AdvancedAudioOptions
 
AdvancedAudioOptions.AudioProcessingChannelsEnum - Enum Class in io.agora.rtc2.audio
 
advancedConfig - Variable in class io.agora.rtc2.proxy.LocalAccessPointConfiguration
Advanced options for the Local Access Point.
AdvancedConfigInfo() - Constructor for class io.agora.rtc2.proxy.LocalAccessPointConfiguration.AdvancedConfigInfo
 
advanceOptions - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
Advanced options for video encoding.
AdvanceOptions() - Constructor for class io.agora.rtc2.video.VideoEncoderConfiguration.AdvanceOptions
 
AdvanceOptions(VideoEncoderConfiguration.ENCODING_PREFERENCE, VideoEncoderConfiguration.COMPRESSION_PREFERENCE, boolean) - Constructor for class io.agora.rtc2.video.VideoEncoderConfiguration.AdvanceOptions
 
aecEstimatedDelay - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalAudioStats
Acoustic echo cancellation (AEC) module estimated delay (ms), which is the signal delay between when audio is played locally before being locally captured.
AGORA_AUDIO_MONO_PROCESSING - Enum constant in enum class io.agora.rtc2.audio.AdvancedAudioOptions.AudioProcessingChannelsEnum
1: (Default) Mono.
AGORA_AUDIO_STEREO_PROCESSING - Enum constant in enum class io.agora.rtc2.audio.AdvancedAudioOptions.AudioProcessingChannelsEnum
2: Stereo.
AgoraFacePositionInfo() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.AgoraFacePositionInfo
 
AgoraFocalLengthInfo - Class in io.agora.rtc2.video
 
AgoraFocalLengthInfo(int, int) - Constructor for class io.agora.rtc2.video.AgoraFocalLengthInfo
 
AgoraImage - Class in io.agora.rtc2.video
 
AgoraImage() - Constructor for class io.agora.rtc2.video.AgoraImage
 
AgoraImage(String) - Constructor for class io.agora.rtc2.video.AgoraImage
 
AgoraMediaRecorder - Class in io.agora.rtc2
The `AgoraMediaRecorder` class, for recording the audio and video on the client.
AgoraMediaRecorder(RtcEngineImpl, RecorderStreamInfo) - Constructor for class io.agora.rtc2.AgoraMediaRecorder
 
AgoraMediaRecorder.MediaRecorderConfiguration - Class in io.agora.rtc2
 
AgoraMetadata - Class in io.agora.rtc2.video
 
AgoraMetadata() - Constructor for class io.agora.rtc2.video.AgoraMetadata
 
AgoraMetadata(String, int, byte[], long) - Constructor for class io.agora.rtc2.video.AgoraMetadata
 
AgoraRhythmPlayerConfig - Class in io.agora.rtc2.audio
 
AgoraRhythmPlayerConfig() - Constructor for class io.agora.rtc2.audio.AgoraRhythmPlayerConfig
 
AgoraVideoFrame - Class in io.agora.rtc2.video
 
AgoraVideoFrame() - Constructor for class io.agora.rtc2.video.AgoraVideoFrame
 
allowCaptureCurrentApp - Variable in class io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters
Whether to capture audio from the current app: - `true`: (Default) Caputre audio from the current app.
alpha - Variable in class io.agora.rtc2.live.LiveTranscoding.TranscodingUser
The transparency of the host's video.
alpha - Variable in class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
The transparency of the video for local video mixing.
alpha - Variable in class io.agora.rtc2.video.AgoraImage
The transparency of the watermark or background image.
alpha - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
alpha(double) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
alphaStitchMode - Variable in class io.agora.rtc2.video.AgoraVideoFrame
When the video frame contains alpha channel data, it represents the relative position of `alphaBuffer` and the video frame.
appData - Variable in class io.agora.rtc2.video.VideoCompositingLayout
Deprecated.
 
appData - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Builder
Deprecated.
 
APPLICATION_SCENARIO_1V1 - Enum constant in enum class io.agora.rtc2.Constants.VideoScenario
2: 1v1 video call scenario.
APPLICATION_SCENARIO_GENERAL - Enum constant in enum class io.agora.rtc2.Constants.VideoScenario
0: (Default) The general scenario.
APPLICATION_SCENARIO_LIVESHOW - Enum constant in enum class io.agora.rtc2.Constants.VideoScenario
3.
APPLICATION_SCENARIO_MEETING - Enum constant in enum class io.agora.rtc2.Constants.VideoScenario
1: The meeting scenario.
AREA_CODE_AS - Static variable in class io.agora.rtc2.RtcEngineConfig.AreaCode
Asia, excluding Mainland China.
AREA_CODE_CN - Static variable in class io.agora.rtc2.RtcEngineConfig.AreaCode
Mainland China.
AREA_CODE_EU - Static variable in class io.agora.rtc2.RtcEngineConfig.AreaCode
Europe.
AREA_CODE_GLOB - Static variable in class io.agora.rtc2.RtcEngineConfig.AreaCode
Global.
AREA_CODE_IN - Static variable in class io.agora.rtc2.RtcEngineConfig.AreaCode
India.
AREA_CODE_JP - Static variable in class io.agora.rtc2.RtcEngineConfig.AreaCode
Japan.
AREA_CODE_NA - Static variable in class io.agora.rtc2.RtcEngineConfig.AreaCode
North America.
AREA_CODE_NONE - Static variable in class io.agora.rtc2.RtcEngineConfig.AreaCode
 
AREA_CODE_RU - Static variable in class io.agora.rtc2.RtcEngineConfig.AreaCode
Russia
AssetsFileReader - Class in io.agora.mediaplayer
 
AssetsFileReader() - Constructor for class io.agora.mediaplayer.AssetsFileReader
 
AUDIENCE_LATENCY_LEVEL_LOW_LATENCY - Static variable in class io.agora.rtc2.Constants
1: Low latency.
AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY - Static variable in class io.agora.rtc2.Constants
2: Ultra low latency.
audienceLatencyLevel - Variable in class io.agora.rtc2.ChannelMediaOptions
The latency level of an audience member in interactive live streaming.
audienceLatencyLevel - Variable in class io.agora.rtc2.ClientRoleOptions
The latency level of an audience member in interactive live streaming.
AUDIO_AND_VIDEO - Enum constant in enum class io.agora.rtc2.Constants.MediaType
Audio and video.
AUDIO_CODEC_AACLC - Static variable in class io.agora.rtc2.Constants
 
AUDIO_CODEC_HEAAC - Static variable in class io.agora.rtc2.Constants
 
AUDIO_CODEC_HEAAC2 - Static variable in class io.agora.rtc2.Constants
 
AUDIO_CODEC_OPUS - Static variable in class io.agora.rtc2.Constants
 
AUDIO_DUAL_MONO_L - Enum constant in enum class io.agora.mediaplayer.Constants.AudioDualMonoMode
1: Left channel mode.
AUDIO_DUAL_MONO_MIX - Enum constant in enum class io.agora.mediaplayer.Constants.AudioDualMonoMode
3: Mixed channel mode.
AUDIO_DUAL_MONO_R - Enum constant in enum class io.agora.mediaplayer.Constants.AudioDualMonoMode
2: Right channel mode.
AUDIO_DUAL_MONO_STEREO - Enum constant in enum class io.agora.mediaplayer.Constants.AudioDualMonoMode
0: Original mode.
AUDIO_EFFECT_OFF - Static variable in class io.agora.rtc2.Constants
Turn off audio effects and use the original voice.
AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIC - Static variable in class io.agora.rtc2.Constants
1: mic audio frame observer
AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED - Static variable in class io.agora.rtc2.Constants
3: mixed audio frame observer
AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK - Static variable in class io.agora.rtc2.Constants
2: playback audio frame observer
AUDIO_ENCODING_TYPE_AAC_16000_LOW - Static variable in class io.agora.rtc2.Constants
1: codecType AAC; sampleRate 16000; quality low which around 1.2 MB after 10 minutes
AUDIO_ENCODING_TYPE_AAC_16000_MEDIUM - Static variable in class io.agora.rtc2.Constants
2: codecType AAC; sampleRate 16000; quality medium which around 2 MB after 10 minutes
AUDIO_ENCODING_TYPE_AAC_32000_HIGH - Static variable in class io.agora.rtc2.Constants
5: codecType AAC; sampleRate 32000; quality high which around 3.5 MB after 10 minutes
AUDIO_ENCODING_TYPE_AAC_32000_LOW - Static variable in class io.agora.rtc2.Constants
3: codecType AAC; sampleRate 32000; quality low which around 1.2 MB after 10 minutes
AUDIO_ENCODING_TYPE_AAC_32000_MEDIUM - Static variable in class io.agora.rtc2.Constants
4: codecType AAC; sampleRate 32000; quality medium which around 2 MB after 10 minutes
AUDIO_ENCODING_TYPE_AAC_48000_HIGH - Static variable in class io.agora.rtc2.Constants
7: codecType AAC; sampleRate 48000; quality high which around 3.5 MB after 10 minutes
AUDIO_ENCODING_TYPE_AAC_48000_MEDIUM - Static variable in class io.agora.rtc2.Constants
6: codecType AAC; sampleRate 48000; quality medium which around 2 MB after 10 minutes
AUDIO_ENCODING_TYPE_OPUS_16000_LOW - Static variable in class io.agora.rtc2.Constants
11: codecType OPUS; sampleRate 16000; quality low which around 1.2 MB after 10 minutes
AUDIO_ENCODING_TYPE_OPUS_16000_MEDIUM - Static variable in class io.agora.rtc2.Constants
12: codecType OPUS; sampleRate 16000; quality medium which around 2 MB after 10 minutes
AUDIO_ENCODING_TYPE_OPUS_48000_HIGH - Static variable in class io.agora.rtc2.Constants
14: codecType OPUS; sampleRate 48000; quality high which around 3.5 MB after 10 minutes
AUDIO_ENCODING_TYPE_OPUS_48000_MEDIUM - Static variable in class io.agora.rtc2.Constants
13: codecType OPUS; sampleRate 48000; quality medium which around 2 MB after 10 minutes
AUDIO_EQUALIZATION_BAND_125 - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY
2: 125 Hz.
AUDIO_EQUALIZATION_BAND_16K - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY
9: 16 kHz.
AUDIO_EQUALIZATION_BAND_1K - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY
5: 1 kHz.
AUDIO_EQUALIZATION_BAND_250 - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY
3: 250 Hz.
AUDIO_EQUALIZATION_BAND_2K - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY
6: 2 kHz.
AUDIO_EQUALIZATION_BAND_31 - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY
0: 31 Hz.
AUDIO_EQUALIZATION_BAND_4K - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY
7: 4 kHz.
AUDIO_EQUALIZATION_BAND_500 - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY
4: 500 Hz.
AUDIO_EQUALIZATION_BAND_62 - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY
1: 62 Hz.
AUDIO_EQUALIZATION_BAND_8K - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY
8: 8 kHz.
AUDIO_FILE_RECORDING_MIC - Static variable in class io.agora.rtc2.Constants
1: mic audio file recording.
AUDIO_FILE_RECORDING_MIXED - Static variable in class io.agora.rtc2.Constants
3: mixed audio file recording, include mic and playback.
AUDIO_FILE_RECORDING_PLAYBACK - Static variable in class io.agora.rtc2.Constants
2: playback audio file recording.
AUDIO_MIXING_DUAL_MONO_AUTO - Enum constant in enum class io.agora.rtc2.Constants.AudioMixingDualMonoMode
0: Original mode.
AUDIO_MIXING_DUAL_MONO_L - Enum constant in enum class io.agora.rtc2.Constants.AudioMixingDualMonoMode
1: Left channel mode.
AUDIO_MIXING_DUAL_MONO_MIX - Enum constant in enum class io.agora.rtc2.Constants.AudioMixingDualMonoMode
3: Mixed channel mode.
AUDIO_MIXING_DUAL_MONO_R - Enum constant in enum class io.agora.rtc2.Constants.AudioMixingDualMonoMode
2: Right channel mode.
AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED - Static variable in class io.agora.rtc2.Constants
723: The audio mixing file is all played out.
AUDIO_MIXING_REASON_CAN_NOT_OPEN - Static variable in class io.agora.rtc2.Constants
701: An error occurs in opening the audio mixing file.
AUDIO_MIXING_REASON_INTERRUPTED_EOF - Static variable in class io.agora.rtc2.Constants
703: The audio mixing file playback is interrupted.
AUDIO_MIXING_REASON_OK - Static variable in class io.agora.rtc2.Constants
0: No error.
AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED - Static variable in class io.agora.rtc2.Constants
721: The audio mixing file is played once.
AUDIO_MIXING_REASON_RESUMED_BY_USER - Static variable in class io.agora.rtc2.Constants
726: The audio mixing playback has resumed by user
AUDIO_MIXING_REASON_STOPPED_BY_USER - Static variable in class io.agora.rtc2.Constants
724: The audio mixing file stopped by user
AUDIO_MIXING_REASON_TOO_FREQUENT_CALL - Static variable in class io.agora.rtc2.Constants
702: The SDK opens the audio mixing file too frequently.
AUDIO_MIXING_STATE_FAILED - Static variable in class io.agora.rtc2.Constants
714: An exception occurs when playing the audio mixing file.
AUDIO_MIXING_STATE_PAUSED - Static variable in class io.agora.rtc2.Constants
711: The audio mixing file pauses playing.
AUDIO_MIXING_STATE_PLAYING - Static variable in class io.agora.rtc2.Constants
710: The audio mixing file is playing.
AUDIO_MIXING_STATE_STOPPED - Static variable in class io.agora.rtc2.Constants
713: The audio mixing file stops playing.
AUDIO_ONLY - Enum constant in enum class io.agora.rtc2.Constants.MediaType
Audio only.
AUDIO_PLAYOUT_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
0: Audio playback device.
AUDIO_PROFILE_DEFAULT - Static variable in class io.agora.rtc2.Constants
0: The default audio profile.
AUDIO_PROFILE_MUSIC_HIGH_QUALITY - Static variable in class io.agora.rtc2.Constants
4: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 96 Kbps.
AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO - Static variable in class io.agora.rtc2.Constants
5: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 128 Kbps.
AUDIO_PROFILE_MUSIC_STANDARD - Static variable in class io.agora.rtc2.Constants
2: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps.
AUDIO_PROFILE_MUSIC_STANDARD_STEREO - Static variable in class io.agora.rtc2.Constants
3: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 80 Kbps.
AUDIO_PROFILE_SPEECH_STANDARD - Static variable in class io.agora.rtc2.Constants
1: A sample rate of 32 kHz, audio encoding, mono, and a bitrate up to 18 Kbps.
AUDIO_PUBLICATION - Enum constant in enum class io.agora.rtc2.DirectCdnStreamingReason
Deprecated.
2: An error occurs when pushing audio streams.
AUDIO_RECORDING_QUALITY_HIGH - Static variable in class io.agora.rtc2.Constants
High quality, file size is around 3.75 MB after 10 minutes of recording.
AUDIO_RECORDING_QUALITY_LOW - Static variable in class io.agora.rtc2.Constants
Low quality, file size is around 1.2 MB after 10 minutes of recording.
AUDIO_RECORDING_QUALITY_MEDIUM - Static variable in class io.agora.rtc2.Constants
Medium quality, file size is around 2 MB after 10 minutes of recording.
AUDIO_RECORDING_QUALITY_ULTRA_HIGH - Static variable in class io.agora.rtc2.Constants
3: Ultra High quality.
AUDIO_RECORDING_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
1: Audio capturing device.
AUDIO_REVERB_DRY_LEVEL - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_REVERB_TYPE
0: The level of the dry signal (dB).
AUDIO_REVERB_ROOM_SIZE - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_REVERB_TYPE
2: The room size of the reflection.
AUDIO_REVERB_STRENGTH - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_REVERB_TYPE
4: The reverberation strength.
AUDIO_REVERB_WET_DELAY - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_REVERB_TYPE
3: The length of the initial delay of the wet signal (ms).
AUDIO_REVERB_WET_LEVEL - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_REVERB_TYPE
1: The level of the early reflection signal (wet signal) (dB).
AUDIO_ROUTE_BLUETOOTH_DEVICE_A2DP - Static variable in class io.agora.rtc2.Constants
10: Bluetooth Device A2DP.
AUDIO_ROUTE_BLUETOOTH_DEVICE_HFP - Static variable in class io.agora.rtc2.Constants
5: Bluetooth Device HFP.
AUDIO_ROUTE_DEFAULT - Static variable in class io.agora.rtc2.Constants
-1: The default audio route.
AUDIO_ROUTE_EARPIECE - Static variable in class io.agora.rtc2.Constants
1: Earpiece.
AUDIO_ROUTE_HDMI - Static variable in class io.agora.rtc2.Constants
7: HDMI device.
AUDIO_ROUTE_HEADSET - Static variable in class io.agora.rtc2.Constants
0: Headset.
AUDIO_ROUTE_HEADSETNOMIC - Static variable in class io.agora.rtc2.Constants
2: Headset with no microphone.
AUDIO_ROUTE_LOUDSPEAKER - Static variable in class io.agora.rtc2.Constants
4: Loudspeaker
AUDIO_ROUTE_SPEAKERPHONE - Static variable in class io.agora.rtc2.Constants
3: Speakerphone.
AUDIO_ROUTE_USB_HEADSET - Static variable in class io.agora.rtc2.Constants
8: USB headset.
AUDIO_ROUTE_USBDEVICE - Static variable in class io.agora.rtc2.Constants
6: USB device.
AUDIO_SCENARIO_AI_CLIENT - Static variable in class io.agora.rtc2.Constants
10: The AI client scenario.
AUDIO_SCENARIO_AI_SERVER - Static variable in class io.agora.rtc2.Constants
9: The AI server scenario.
AUDIO_SCENARIO_CHATROOM - Static variable in class io.agora.rtc2.Constants
5: The chatroom scenario, which needs to keep recording when setClientRole to audience.
AUDIO_SCENARIO_CHORUS - Static variable in class io.agora.rtc2.Constants
7: The chorus scenario.
AUDIO_SCENARIO_DEFAULT - Static variable in class io.agora.rtc2.Constants
0: (Recommended) The default audio scenario.
AUDIO_SCENARIO_GAME_STREAMING - Static variable in class io.agora.rtc2.Constants
3: (Recommended) The live gaming scenario, which needs to enable the gaming audio effects in the speaker mode in a live broadcast scenario.
AUDIO_SCENARIO_MEETING - Static variable in class io.agora.rtc2.Constants
8: The Meeting scenario.
AUDIO_SOURCE_CUSTOM - Enum constant in enum class io.agora.rtc2.Constants.AudioSourceType
1: Custom audio stream.
AUDIO_SOURCE_LOOPBACK_RECORDING - Enum constant in enum class io.agora.rtc2.Constants.AudioSourceType
3: System audio stream captured during screen sharing.
AUDIO_SOURCE_MEDIA_PLAYER - Enum constant in enum class io.agora.rtc2.Constants.AudioSourceType
2: Media player.
AUDIO_SOURCE_MICROPHONE - Enum constant in enum class io.agora.rtc2.Constants.AudioSourceType
0: (Default) Microphone.
AUDIO_SOURCE_MIXED_STREAM - Enum constant in enum class io.agora.rtc2.Constants.AudioSourceType
4: Audio of mixed stream from the local client.
AUDIO_SOURCE_REMOTE_CHANNEL - Enum constant in enum class io.agora.rtc2.Constants.AudioSourceType
6: Mixed audio streams from all users in the current channel.
AUDIO_SOURCE_REMOTE_USER - Enum constant in enum class io.agora.rtc2.Constants.AudioSourceType
5: Audio stream from a specified remote user.
AUDIO_SOURCE_UNKNOWN - Enum constant in enum class io.agora.rtc2.Constants.AudioSourceType
100: An unknown audio source.
AUDIO_TRACK_DIRECT - Enum constant in enum class io.agora.rtc2.Constants.AudioTrackType
1: Direct audio tracks.
AUDIO_TRACK_MIXABLE - Enum constant in enum class io.agora.rtc2.Constants.AudioTrackType
0: Mixable audio tracks.
audioAttenuation - Variable in class io.agora.spatialaudio.SpatialAudioZone
The sound attenuation coefficient when users within the sound insulation area communicate with external users.
audioBitrate - Variable in class io.agora.rtc2.DirectCdnStreamingStats
Deprecated.
The bitrate (bps) of the current audio frame.
audioBitrate - Variable in class io.agora.rtc2.live.LiveInjectStreamConfig
 
audioBitrate - Variable in class io.agora.rtc2.live.LiveTranscoding
Bitrate (Kbps) of the audio output stream for Media Push.
audioBitsPerSample - Variable in class io.agora.mediaplayer.data.PlayerUpdatedInfo
The number of bits per audio sample point.
audioCaptureParameters - Variable in class io.agora.rtc2.ScreenCaptureParameters
The audio configuration for the shared screen stream.
AudioCaptureParameters() - Constructor for class io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters
 
audioChannel - Variable in class io.agora.rtc2.live.LiveTranscoding.TranscodingUser
The audio channel used by the host's audio in the output audio.
audioChannels - Variable in class io.agora.mediaplayer.data.PlayerUpdatedInfo
The number of audio channels.
audioChannels - Variable in class io.agora.rtc2.live.LiveInjectStreamConfig
 
audioChannels - Variable in class io.agora.rtc2.live.LiveTranscoding
The number of audio channels for Media Push.
audioCodecProfile - Variable in class io.agora.rtc2.live.LiveTranscoding
Audio codec profile type for Media Push.
audioDelayMs - Variable in class io.agora.rtc2.ChannelMediaOptions
Delay (in milliseconds) for sending audio frames.
audioDeviceDelay - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalAudioStats
The audio device module delay (ms) when playing or recording audio.
AudioFrame - Class in io.agora.base
 
AudioFrame(ByteBuffer, int, int, int, int, long) - Constructor for class io.agora.base.AudioFrame
 
audioInputStreams - Variable in class io.agora.rtc2.LocalAudioMixerConfiguration
The source of the audio streams that are mixed locally.
audioLossRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
The frame loss rate (%) of the remote audio stream in the reported interval.
AudioParams - Class in io.agora.rtc2.audio
 
AudioParams(int, int, int, int) - Constructor for class io.agora.rtc2.audio.AudioParams
 
audioPlayoutDelay - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalAudioStats
The playout delay of the device
audioProcessingChannels - Variable in class io.agora.rtc2.audio.AdvancedAudioOptions
The number of channels for audio preprocessing.
audioSampleRate - Variable in class io.agora.mediaplayer.data.PlayerUpdatedInfo
Audio sample rate (Hz).
audioSampleRate - Variable in class io.agora.rtc2.live.LiveInjectStreamConfig
 
audioSampleRate - Variable in class io.agora.rtc2.live.LiveTranscoding
The audio sampling rate (Hz) of the output media stream.
AudioSpectrumInfo - Class in io.agora.rtc2.audio
 
AudioSpectrumInfo(float[], int) - Constructor for class io.agora.rtc2.audio.AudioSpectrumInfo
 
AudioTrackConfig - Class in io.agora.rtc2.audio
 
AudioTrackConfig() - Constructor for class io.agora.rtc2.audio.AudioTrackConfig
 
AudioVolumeInfo() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo
 
AUTO_SIMULCAST_STREAM - Enum constant in enum class io.agora.rtc2.Constants.SimulcastStreamMode
-1: By default, do not send the low-quality video stream until a subscription request for the low-quality video stream is received from the receiving end, then automatically start sending low-quality video stream.
autoSubscribeAudio - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to automatically subscribe to all remote audio streams when the user joins a channel: - `true`: Subscribe to all remote audio streams.
autoSubscribeVideo - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to automatically subscribe to all remote video streams when the user joins the channel: - `true`: Subscribe to all remote video streams.
availableBandwidth - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LastmileProbeResult.LastmileProbeOneWayResult
The estimated available bandwidth (bps).
avSyncTimeMs - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
The amount of time (ms) that the audio is ahead of the video.

B

BACKGROUND_BLUR - Static variable in class io.agora.rtc2.video.VirtualBackgroundSource
3: Background blur.
BACKGROUND_COLOR - Static variable in class io.agora.rtc2.video.VirtualBackgroundSource
1: The background is a solid color(eg: Oxffffff).
BACKGROUND_IMG - Static variable in class io.agora.rtc2.video.VirtualBackgroundSource
2: Image source in PNG or JPG format.
BACKGROUND_NONE - Static variable in class io.agora.rtc2.video.VirtualBackgroundSource
0: Enable segementation with the captured video frame without replacing the background.
BACKGROUND_VIDEO - Static variable in class io.agora.rtc2.video.VirtualBackgroundSource
4: Video source in MP4, AVI, MKV, FLV format.
backgroundColor - Variable in class io.agora.rtc2.live.LiveTranscoding
Deprecated.
This parameter is deprecated. We recommend using the setBackgroundColor method to set the background color.
backgroundColor - Variable in class io.agora.rtc2.video.VideoCanvas
The background color of the video canvas in RGBA format.
backgroundColor - Variable in class io.agora.rtc2.video.VideoCompositingLayout
Deprecated.
 
backgroundSourceType - Variable in class io.agora.rtc2.video.VirtualBackgroundSource
The custom background.
BAD - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.Quality
Deprecated.
 
BAD_NAME - Enum constant in enum class io.agora.rtc2.DirectCdnStreamingReason
Deprecated.
5: The URL is already being used.
bandwidth_estimation_bps - Variable in class io.agora.rtc2.IRtcEngineEventHandler.DownlinkNetworkInfo
The bandwidth estimation bitrate in bps.
BASELINE - Enum constant in enum class io.agora.rtc2.live.LiveTranscoding.VideoCodecProfileType
66: Baseline video codec profile; generally used for video calls on mobile phones.
beatsPerMeasure - Variable in class io.agora.rtc2.audio.AgoraRhythmPlayerConfig
The number of beats per measure, which ranges from 1 to 9.
beatsPerMinute - Variable in class io.agora.rtc2.audio.AgoraRhythmPlayerConfig
The beat speed (beats/minute), which ranges from 60 to 360.
BEAUTY - Enum constant in enum class io.agora.rtc2.IVideoEffectObject.VIDEO_EFFECT_NODE_ID
(1): Beauty effect node.
BeautyOptions - Class in io.agora.rtc2.video
 
BeautyOptions() - Constructor for class io.agora.rtc2.video.BeautyOptions
 
BeautyOptions(int, float, float, float, float) - Constructor for class io.agora.rtc2.video.BeautyOptions
The image enhancement options.
bgColor - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Canvas
Deprecated.
 
bitrate - Variable in class io.agora.rtc2.PublisherParameters
Deprecated.
 
bitrate - Variable in class io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters
The video encoding bitrate (Kbps).
bitrate - Variable in class io.agora.rtc2.SimulcastStreamConfig
Video bitrate (Kbps).
bitrate - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
The encoding bitrate (Kbps) of the video.
bitRate(int) - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
Sets the stream's bitrate.
BLUR_DEGREE_HIGH - Static variable in class io.agora.rtc2.video.VirtualBackgroundSource
blur degree high, blur default, hard to find background
BLUR_DEGREE_LOW - Static variable in class io.agora.rtc2.video.VirtualBackgroundSource
blur degree low, have few blur effect
BLUR_DEGREE_MEDIUM - Static variable in class io.agora.rtc2.video.VirtualBackgroundSource
blur degree medium, blur more than level 1
blurDegree - Variable in class io.agora.rtc2.video.VirtualBackgroundSource
The degree of blurring applied to the custom background image.
buf - Variable in class io.agora.rtc2.video.AgoraVideoFrame
Video frame buffer.
buffer - Variable in class io.agora.base.AudioFrame
The data buffer of the audio frame.
buffer - Variable in class io.agora.rtc2.video.WatermarkBuffer
Stores the watermark image data.
buffer - Variable in class io.agora.rtc2.video.WatermarkConfig
Buffer containing watermark image data.
BUFFER_TYPE_ARRAY - Static variable in class io.agora.rtc2.video.AgoraVideoFrame
2: The buffer type is array.
BUFFER_TYPE_BUFFER - Static variable in class io.agora.rtc2.video.AgoraVideoFrame
1: The buffer type is buffer.
BUFFER_TYPE_NONE - Static variable in class io.agora.rtc2.video.AgoraVideoFrame
-1: No buffer type.
BUFFER_TYPE_TEXTURE - Static variable in class io.agora.rtc2.video.AgoraVideoFrame
3: The buffer type is texture.
build() - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
 
Builder() - Constructor for class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
 
Builder() - Constructor for class io.agora.rtc2.video.VideoCompositingLayout.Builder
Deprecated.
 
bytesPerSample - Variable in class io.agora.base.AudioFrame
The number of bytes per sample.

C

CacheStatistics - Class in io.agora.mediaplayer.data
 
CacheStatistics() - Constructor for class io.agora.mediaplayer.data.CacheStatistics
 
CAMERA - Static variable in class io.agora.rtc2.Constants
 
CAMERA_EXTRAL - Enum constant in enum class io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_DIRECTION
2: The external camera.
CAMERA_FOCAL_LENGTH_DEFAULT - Enum constant in enum class io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE
0: (Default) Standard lens.
CAMERA_FOCAL_LENGTH_TELEPHOTO - Enum constant in enum class io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE
Telephoto lens.
CAMERA_FOCAL_LENGTH_ULTRA_WIDE - Enum constant in enum class io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE
2: Ultra-wide-angle lens.
CAMERA_FOCAL_LENGTH_WIDE_ANGLE - Enum constant in enum class io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE
1: Wide-angle lens.
CAMERA_FRONT - Enum constant in enum class io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_DIRECTION
1: (Default) The front camera.
CAMERA_REAR - Enum constant in enum class io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_DIRECTION
0: The rear camera.
CameraCapturerConfiguration - Class in io.agora.rtc2.video
 
CameraCapturerConfiguration(CameraCapturerConfiguration.CAMERA_DIRECTION) - Constructor for class io.agora.rtc2.video.CameraCapturerConfiguration
The camera capture configuration.
CameraCapturerConfiguration(CameraCapturerConfiguration.CAMERA_DIRECTION, CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE) - Constructor for class io.agora.rtc2.video.CameraCapturerConfiguration
 
CameraCapturerConfiguration(CameraCapturerConfiguration.CAMERA_DIRECTION, CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE, CameraCapturerConfiguration.CaptureFormat) - Constructor for class io.agora.rtc2.video.CameraCapturerConfiguration
 
CameraCapturerConfiguration(CameraCapturerConfiguration.CAMERA_DIRECTION, CameraCapturerConfiguration.CaptureFormat) - Constructor for class io.agora.rtc2.video.CameraCapturerConfiguration
The camera capture configuration.
CameraCapturerConfiguration(CameraCapturerConfiguration.CaptureFormat) - Constructor for class io.agora.rtc2.video.CameraCapturerConfiguration
The camera capture configuration.
CameraCapturerConfiguration.CAMERA_DIRECTION - Enum Class in io.agora.rtc2.video
 
CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE - Enum Class in io.agora.rtc2.video
 
CameraCapturerConfiguration.CaptureFormat - Class in io.agora.rtc2.video
 
cameraDirection - Variable in class io.agora.rtc2.video.AgoraFocalLengthInfo
The camera direction.
cameraDirection - Variable in class io.agora.rtc2.video.CameraCapturerConfiguration
(Optional) The camera direction.
cameraFocalLengthType - Variable in class io.agora.rtc2.video.CameraCapturerConfiguration
(Optional) The camera focal length type.
cameraId - Variable in class io.agora.rtc2.video.CameraCapturerConfiguration
(Optional) The camera ID.
canvas - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Builder
Deprecated.
 
Canvas() - Constructor for class io.agora.rtc2.video.VideoCompositingLayout.Canvas
Deprecated.
 
canvasHeight - Variable in class io.agora.rtc2.video.VideoCompositingLayout
Deprecated.
 
canvasWidth - Variable in class io.agora.rtc2.video.VideoCompositingLayout
Deprecated.
 
CAPTURE_BRIGHTNESS_LEVEL_BRIGHT - Static variable in class io.agora.rtc2.Constants
1: The brightness level of the video image is too bright.
CAPTURE_BRIGHTNESS_LEVEL_DARK - Static variable in class io.agora.rtc2.Constants
2: The brightness level of the video image is too dark.
CAPTURE_BRIGHTNESS_LEVEL_INVALID - Static variable in class io.agora.rtc2.Constants
-1: The SDK does not detect the brightness level of the video image.
CAPTURE_BRIGHTNESS_LEVEL_NORMAL - Static variable in class io.agora.rtc2.Constants
0: The brightness level of the video image is normal.
captureAudio - Variable in class io.agora.rtc2.ScreenCaptureParameters
Determines whether to capture system audio during screen sharing: - `true`: Capture system audio.
captureBrightnessLevel - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The brightness level of the video image captured by the local camera.
captureFormat - Variable in class io.agora.rtc2.video.CameraCapturerConfiguration
(Optional) The format of the video frame.
CaptureFormat() - Constructor for class io.agora.rtc2.video.CameraCapturerConfiguration.CaptureFormat
 
CaptureFormat(int, int, int) - Constructor for class io.agora.rtc2.video.CameraCapturerConfiguration.CaptureFormat
 
captureFrameHeight - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The height (px) for capturing the local video stream.
captureFrameRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The frame rate (fps) for capturing the local video stream.
captureFrameWidth - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The width (px) for capturing the local video stream.
captureSignalVolume - Variable in class io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters
The volume of the captured system audio.
captureTimeMs - Variable in class io.agora.rtc2.video.EncodedVideoFrameInfo
The Unix timestamp (ms) for capturing the external encoded video frames.
captureVideo - Variable in class io.agora.rtc2.ScreenCaptureParameters
Whether to capture the screen when screen sharing: - `true`: (Default) Capture the screen.
ccMode - Variable in class io.agora.rtc2.EncodedVideoTrackOptions
Whether to enable CC mode.
channel - Variable in class io.agora.rtc2.audio.AudioParams
The number of audio channels, which can be set as either of the following values: - 1: (Default) Mono.
channel_num - Variable in class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
Number of channels for audio capturing: - 1: Mono - 2: Stereo This parameter is required only when you call `createMediaRecorder` and set the `recorderStreamType` in `RecorderStreamInfo` to 1.
CHANNEL_PROFILE_CLOUD_GAMING - Static variable in class io.agora.rtc2.Constants
3: Cloud Gaming.
CHANNEL_PROFILE_COMMUNICATION - Static variable in class io.agora.rtc2.Constants
0: Communication.
CHANNEL_PROFILE_COMMUNICATION_1v1 - Static variable in class io.agora.rtc2.Constants
4: Communication 1v1.
CHANNEL_PROFILE_GAME - Static variable in class io.agora.rtc2.Constants
2: Gaming.
CHANNEL_PROFILE_LIVE_BROADCASTING - Static variable in class io.agora.rtc2.Constants
1: (Default) Live Broadcast.
channelId - Variable in class io.agora.rtc2.EchoTestConfiguration
The channel name that identifies each audio and video call loop.
channelId - Variable in class io.agora.rtc2.ExtensionInfo
The unique channel name for the AgoraRTC session in the string format.
channelId - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayout
The channel name to which the sub-video stream belongs.
channelId - Variable in class io.agora.rtc2.LocalAudioMixerConfiguration.MixedAudioStream
The channel name.
channelId - Variable in class io.agora.rtc2.RecorderStreamInfo
The name of the channel to be recorded.
channelId - Variable in class io.agora.rtc2.RtcConnection
The channel name.
channelId - Variable in class io.agora.rtc2.video.AgoraMetadata
The channel name.
ChannelMediaInfo - Class in io.agora.rtc2.video
 
ChannelMediaInfo(String, String, int) - Constructor for class io.agora.rtc2.video.ChannelMediaInfo
 
ChannelMediaOptions - Class in io.agora.rtc2
 
ChannelMediaOptions() - Constructor for class io.agora.rtc2.ChannelMediaOptions
 
ChannelMediaOptions(Integer) - Constructor for class io.agora.rtc2.ChannelMediaOptions
 
ChannelMediaRelayConfiguration - Class in io.agora.rtc2.video
 
ChannelMediaRelayConfiguration() - Constructor for class io.agora.rtc2.video.ChannelMediaRelayConfiguration
The configuration of the channel media relay.
channelName - Variable in class io.agora.rtc2.video.ChannelMediaInfo
The channel name.
channelNums - Variable in class io.agora.base.AudioFrame
The number of audio channels (the data are interleaved if it is stereo).
channelProfile - Variable in class io.agora.rtc2.ChannelMediaOptions
The channel profile.
channels - Variable in class io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters
The number of audio channels.
CHAT_BEAUTIFIER_FRESH - Static variable in class io.agora.rtc2.Constants
A fresher voice.
CHAT_BEAUTIFIER_MAGNETIC - Static variable in class io.agora.rtc2.Constants
A more magnetic voice.
CHAT_BEAUTIFIER_VITALITY - Static variable in class io.agora.rtc2.Constants
A more vital voice.
CHATROOM - Enum constant in enum class io.agora.rtc2.Constants.AudioScenario
5: The chatroom scenario, which needs to keep recording when setClientRole to audience.
checkBackground() - Method in class io.agora.rtc2.internal.gdp.GDPAndroid
 
checkEglError(String) - Method in class io.agora.rtc2.internal.gdp.EglCore
Checks for EGL errors.
clearRemotePositions() - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
 
clearRemotePositionsEx(RtcConnection) - Method in class io.agora.spatialaudio.ILocalSpatialAudioEngine
 
clearVideoWatermarkEx(RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
clearVideoWatermarks() - Method in class io.agora.rtc2.RtcEngine
 
CLIENT_ROLE_AUDIENCE - Static variable in class io.agora.rtc2.Constants
The audience.
CLIENT_ROLE_AUDIENCE - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ClientRole
Deprecated.
The audience in a live broadcast.
CLIENT_ROLE_BROADCASTER - Static variable in class io.agora.rtc2.Constants
The broadcaster.
CLIENT_ROLE_BROADCASTER - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ClientRole
Deprecated.
The host in a live broadcast.
ClientRole() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.ClientRole
Deprecated.
 
ClientRoleOptions - Class in io.agora.rtc2
 
ClientRoleOptions() - Constructor for class io.agora.rtc2.ClientRoleOptions
 
clientRoleType - Variable in class io.agora.rtc2.ChannelMediaOptions
The user role: - CLIENT_ROLE_BROADCASTER (1): Host.
closeFile() - Method in class io.agora.mediaplayer.AssetsFileReader
 
closeFile() - Method in class io.agora.mediaplayer.ContentFileReader
 
CODEC_CAP_MASK_HW_DEC - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.CODEC_CAP_MASK
bit 1: Hardware decoder support flag
CODEC_CAP_MASK_HW_ENC - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.CODEC_CAP_MASK
bit 2: Hardware encoder support flag
CODEC_CAP_MASK_NONE - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.CODEC_CAP_MASK
codec cap mask
CODEC_CAP_MASK_SW_DEC - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.CODEC_CAP_MASK
bit 3: Software decoder support flag
CODEC_CAP_MASK_SW_ENC - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.CODEC_CAP_MASK
bit 4: Software encoder support flag
CODEC_CAPABILITY_LEVEL_1080P30FPS - Static variable in class io.agora.rtc2.Constants
Can process 1080p video at a rate of approximately 30 fps.
CODEC_CAPABILITY_LEVEL_1080P60FPS - Static variable in class io.agora.rtc2.Constants
Can process 1080p video at a rate of approximately 60 fps.
CODEC_CAPABILITY_LEVEL_4K60FPS - Static variable in class io.agora.rtc2.Constants
Can process 4k video at a rate of approximately 30 fps.
CODEC_CAPABILITY_LEVEL_BASIC_SUPPORT - Static variable in class io.agora.rtc2.Constants
Only provide basic support for the codec type
CODEC_CAPABILITY_LEVEL_UNSPECIFIED - Static variable in class io.agora.rtc2.Constants
No specified level
CodecCapInfo - Class in io.agora.rtc2.video
 
CodecCapInfo(int, int, CodecCapLevels) - Constructor for class io.agora.rtc2.video.CodecCapInfo
 
CodecCapLevels - Class in io.agora.rtc2.video
 
CodecCapLevels() - Constructor for class io.agora.rtc2.video.CodecCapLevels
 
CodecCapLevels(int, int) - Constructor for class io.agora.rtc2.video.CodecCapLevels
 
codecCapMask - Variable in class io.agora.rtc2.video.CodecCapInfo
The bit mask of the codec type: - (0): The device does not support encoding or decoding.
codecLevels - Variable in class io.agora.rtc2.video.CodecCapInfo
Codec capability of the SDK.
codecType - Variable in class io.agora.rtc2.EncodedVideoTrackOptions
The codec type used for the encoded images.
codecType - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The codec type of the local video.
codecType - Variable in class io.agora.rtc2.video.CodecCapInfo
The video codec types: - 1: VP8 - 2: H.264.
codecType - Variable in class io.agora.rtc2.video.EncodedVideoFrameInfo
The codec type of the video: - VIDEO_CODEC_VP8 (1): VP8.
codecType - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
The codec type of the local video stream.
color - Variable in class io.agora.rtc2.video.VirtualBackgroundSource
The type of the custom background image.
ColorEnhanceOptions - Class in io.agora.rtc2.video
 
ColorEnhanceOptions() - Constructor for class io.agora.rtc2.video.ColorEnhanceOptions
 
ColorEnhanceOptions(float, float) - Constructor for class io.agora.rtc2.video.ColorEnhanceOptions
 
COMPATIBLE_BITRATE - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
-1: The compatible bitrate mode.
complain(String, String) - Method in class io.agora.rtc2.RtcEngine
 
compressionPreference - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration.AdvanceOptions
Compression preference for video encoding.
configRhythmPlayer(AgoraRhythmPlayerConfig) - Method in class io.agora.rtc2.RtcEngine
 
configs - Variable in class io.agora.rtc2.SimulcastConfig
Configurations for multi-layer streaming: `StreamLayerConfig`.
CONFLICTED - Enum constant in enum class io.agora.rtc2.IH265TranscoderObserver.H265TranscodeResult
6: The request encountered a conflict, please try again.
CONNECTION_CHANGED_BANNED_BY_SERVER - Static variable in class io.agora.rtc2.Constants
3: The connection between the SDK and Agora edge server is banned by Agora edge server.
CONNECTION_CHANGED_CERTIFICATION_VERYFY_FAILURE - Static variable in class io.agora.rtc2.Constants
22: The connection is failed due to certification verify failure.
CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED - Static variable in class io.agora.rtc2.Constants
13: The client IP address has changed, probably due to a change of the network type, IP address, or network port.
CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED_BY_USER - Static variable in class io.agora.rtc2.Constants
18: The local IP Address is changed by user.
CONNECTION_CHANGED_CONNECTING - Static variable in class io.agora.rtc2.Constants
0: The SDK is connecting to Agora edge server.
CONNECTION_CHANGED_ECHO_TEST - Static variable in class io.agora.rtc2.Constants
17: The change of connection state is caused by echo test.
CONNECTION_CHANGED_INTERRUPTED - Static variable in class io.agora.rtc2.Constants
2: The connection between the SDK and Agora edge server is interrupted.
CONNECTION_CHANGED_INVALID_APP_ID - Static variable in class io.agora.rtc2.Constants
6: The specified App ID is invalid.
CONNECTION_CHANGED_INVALID_CHANNEL_NAME - Static variable in class io.agora.rtc2.Constants
7: The specified channel name is invalid.
CONNECTION_CHANGED_INVALID_TOKEN - Static variable in class io.agora.rtc2.Constants
8: The generated token is invalid probably due to the following reasons: The App Certificate for the project is enabled in Console, but you do not use the token.
CONNECTION_CHANGED_JOIN_FAILED - Static variable in class io.agora.rtc2.Constants
4: The SDK fails to join the channel for more than 20 minutes and stops reconnecting to the channel.
CONNECTION_CHANGED_JOIN_SUCCESS - Static variable in class io.agora.rtc2.Constants
1: The SDK has joined the channel successfully.
CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT - Static variable in class io.agora.rtc2.Constants
14: Timeout for the keep-alive of the connection between the SDK and Agora edge server.
CONNECTION_CHANGED_LEAVE_CHANNEL - Static variable in class io.agora.rtc2.Constants
5: The SDK has left the channel.
CONNECTION_CHANGED_LICENSE_VALIDATION_FAILURE - Static variable in class io.agora.rtc2.Constants
21: The connection is failed due to license validation failure.
CONNECTION_CHANGED_LOST - Static variable in class io.agora.rtc2.Constants
16: The connection between the SDK and the server is lost.
CONNECTION_CHANGED_REJECTED_BY_SERVER - Static variable in class io.agora.rtc2.Constants
10: The user is banned by the server.
CONNECTION_CHANGED_REJOIN_SUCCESS - Static variable in class io.agora.rtc2.Constants
15: The SDK has rejoined the channel successfully.
CONNECTION_CHANGED_RENEW_TOKEN - Static variable in class io.agora.rtc2.Constants
12: The token renews.
CONNECTION_CHANGED_SAME_UID_LOGIN - Static variable in class io.agora.rtc2.Constants
/* 19: There is a disconnection due to joining channel on another device with the same uid.
CONNECTION_CHANGED_SETTING_PROXY_SERVER - Static variable in class io.agora.rtc2.Constants
11: The SDK tries to reconnect after setting a proxy server.
CONNECTION_CHANGED_TOKEN_EXPIRED - Static variable in class io.agora.rtc2.Constants
9: The token has expired.
CONNECTION_CHANGED_TOO_MANY_BROADCASTERS - Static variable in class io.agora.rtc2.Constants
20: The connection is failed due to too many broadcasters in the channel.
CONNECTION_STATE_CONNECTED - Enum constant in enum class io.agora.rtc2.RtcConnection.CONNECTION_STATE_TYPE
3: The SDK is connected to Agora's edge server and has joined a channel.
CONNECTION_STATE_CONNECTED - Static variable in class io.agora.rtc2.Constants
3: The SDK is connected to Agora edge server and has joined a channel.
CONNECTION_STATE_CONNECTING - Enum constant in enum class io.agora.rtc2.RtcConnection.CONNECTION_STATE_TYPE
2: The SDK is connecting to Agora's edge server.
CONNECTION_STATE_CONNECTING - Static variable in class io.agora.rtc2.Constants
2: The SDK is connecting to Agora edge server.
CONNECTION_STATE_DISCONNECTED - Enum constant in enum class io.agora.rtc2.RtcConnection.CONNECTION_STATE_TYPE
1: The SDK is disconnected from Agora's edge server.
CONNECTION_STATE_DISCONNECTED - Static variable in class io.agora.rtc2.Constants
1: The SDK is disconnected from Agora edge server.
CONNECTION_STATE_FAILED - Enum constant in enum class io.agora.rtc2.RtcConnection.CONNECTION_STATE_TYPE
5: The SDK fails to connect to Agora's edge server or join the channel.
CONNECTION_STATE_FAILED - Static variable in class io.agora.rtc2.Constants
5: The SDK fails to connect to Agora edge server or join the channel.
CONNECTION_STATE_NOT_INITIALIZED - Enum constant in enum class io.agora.rtc2.RtcConnection.CONNECTION_STATE_TYPE
0: The SDK has not been initialized.
CONNECTION_STATE_RECONNECTING - Enum constant in enum class io.agora.rtc2.RtcConnection.CONNECTION_STATE_TYPE
4: The SDK keeps rejoining the channel after being disconnected from a joined channel because of network issues.
CONNECTION_STATE_RECONNECTING - Static variable in class io.agora.rtc2.Constants
4: The SDK keeps rejoining the channel after being disconnected from a joined channel because of network issues.
connectTimeMs - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The duration (ms) between the SDK starts connecting and the connection is established.
Constants - Class in io.agora.mediaplayer
 
Constants - Class in io.agora.rtc2
Rating of the media or network quality.
Constants() - Constructor for class io.agora.mediaplayer.Constants
 
Constants() - Constructor for class io.agora.rtc2.Constants
 
Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY - Enum Class in io.agora.rtc2
 
Constants.AUDIO_REVERB_TYPE - Enum Class in io.agora.rtc2
 
Constants.AudioDualMonoMode - Enum Class in io.agora.mediaplayer
 
Constants.AudioMixingDualMonoMode - Enum Class in io.agora.rtc2
 
Constants.AudioProfile - Enum Class in io.agora.rtc2
 
Constants.AudioScenario - Enum Class in io.agora.rtc2
Sets the audio application scenarios.
Constants.AudioSourceType - Enum Class in io.agora.rtc2
 
Constants.AudioTrackType - Enum Class in io.agora.rtc2
 
Constants.BytesPerSample - Enum Class in io.agora.rtc2
Bytes per sample
Constants.ExternalVideoSourceType - Enum Class in io.agora.rtc2
 
Constants.LogLevel - Enum Class in io.agora.rtc2
 
Constants.MEDIA_TRACE_EVENT - Enum Class in io.agora.rtc2
 
Constants.MediaPlayerEvent - Enum Class in io.agora.mediaplayer
 
Constants.MediaPlayerMetadataType - Enum Class in io.agora.mediaplayer
 
Constants.MediaPlayerPreloadEvent - Enum Class in io.agora.mediaplayer
 
Constants.MediaPlayerReason - Enum Class in io.agora.mediaplayer
 
Constants.MediaPlayerState - Enum Class in io.agora.mediaplayer
 
Constants.MediaSourceType - Enum Class in io.agora.rtc2
 
Constants.MediaStreamType - Enum Class in io.agora.mediaplayer
 
Constants.MediaType - Enum Class in io.agora.rtc2
Media type.
Constants.MultipathMode - Enum Class in io.agora.rtc2
 
Constants.MultipathType - Enum Class in io.agora.rtc2
 
Constants.QoEPreference - Enum Class in io.agora.rtc2
Sets the video qoe preference.
Constants.RenewTokenErrorCode - Enum Class in io.agora.rtc2
 
Constants.ScreenScenarioType - Enum Class in io.agora.rtc2
 
Constants.SimulcastStreamMode - Enum Class in io.agora.rtc2
 
Constants.StreamFallbackOptions - Enum Class in io.agora.rtc2
 
Constants.ThreadPriorityType - Enum Class in io.agora.rtc2
Thread priority type.
Constants.VIDEO_MODULE_TYPE - Enum Class in io.agora.rtc2
 
Constants.VideoModulePosition - Enum Class in io.agora.rtc2
 
Constants.VideoScenario - Enum Class in io.agora.rtc2
 
Constants.VideoSourceType - Enum Class in io.agora.rtc2
 
Constants.VideoStreamType - Enum Class in io.agora.rtc2
 
Constants.VOICE_AI_TUNER_TYPE - Enum Class in io.agora.rtc2
 
CONTAINER_MP4 - Static variable in class io.agora.rtc2.AgoraMediaRecorder
1: MP4 format.
containerFormat - Variable in class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
The format of the recording file.
CONTENT_INSPECT_NEUTRAL - Static variable in class io.agora.rtc2.Constants
 
CONTENT_INSPECT_PORN - Static variable in class io.agora.rtc2.Constants
 
CONTENT_INSPECT_SEXY - Static variable in class io.agora.rtc2.Constants
 
CONTENT_INSPECT_TYPE_IMAGE_MODERATION - Static variable in class io.agora.rtc2.video.ContentInspectConfig
3: Video screenshot and upload via extensions from Agora Extensions Marketplace.
CONTENT_INSPECT_TYPE_INVALID - Static variable in class io.agora.rtc2.video.ContentInspectConfig
0: (Default) No actual function.
CONTENT_INSPECT_TYPE_MODERATION - Static variable in class io.agora.rtc2.video.ContentInspectConfig
Deprecated.
Content inspect type moderation
CONTENT_INSPECT_TYPE_SUPERVISE - Static variable in class io.agora.rtc2.video.ContentInspectConfig
2: Video screenshot and upload via Agora self-developed extension.
ContentFileReader - Class in io.agora.mediaplayer
 
ContentFileReader() - Constructor for class io.agora.mediaplayer.ContentFileReader
 
contentHint - Variable in class io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters
The content hint for screen sharing.
ContentInspectConfig - Class in io.agora.rtc2.video
 
ContentInspectConfig() - Constructor for class io.agora.rtc2.video.ContentInspectConfig
 
ContentInspectConfig.ContentInspectModule - Class in io.agora.rtc2.video
 
ContentInspectModule() - Constructor for class io.agora.rtc2.video.ContentInspectConfig.ContentInspectModule
 
cpuAppUsage - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
Application CPU usage (%).
cpuTotalUsage - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The system CPU usage (%).
create() - Static method in class io.agora.mediaplayer.gl.PlayerTextureHelper
Construct a new SurfaceTextureHelperTest sharing OpenGL resources with |sharedContext|.
create() - Method in class io.agora.rtc2.video.VideoCompositingLayout.Builder
Deprecated.
 
create() - Static method in class io.agora.spatialaudio.ILocalSpatialAudioEngine
 
create(Context, String, IRtcEngineEventHandler) - Static method in class io.agora.rtc2.RtcEngine
 
create(RtcEngineConfig) - Static method in class io.agora.rtc2.RtcEngine
 
createCustomAudioTrack(Constants.AudioTrackType, AudioTrackConfig) - Method in class io.agora.rtc2.RtcEngine
 
createCustomEncodedVideoTrack(EncodedVideoTrackOptions) - Method in class io.agora.rtc2.RtcEngine
Get an custom encoded video track id created by internal,which could used to publish or preview
createCustomVideoTrack() - Method in class io.agora.rtc2.RtcEngine
 
createDataStream(boolean, boolean) - Method in class io.agora.rtc2.RtcEngine
 
createDataStream(DataStreamConfig) - Method in class io.agora.rtc2.RtcEngine
 
createDataStreamEx(boolean, boolean, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
createDataStreamEx(DataStreamConfig, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
createMediaPlayer() - Method in class io.agora.rtc2.RtcEngine
 
createMediaRecorder(RecorderStreamInfo) - Method in class io.agora.rtc2.RtcEngine
 
createOffscreenSurface(int, int) - Method in class io.agora.rtc2.internal.gdp.EglCore
Creates an EGL surface associated with an offscreen buffer.
createOffscreenSurface(int, int) - Method in class io.agora.rtc2.internal.gdp.EglSurfaceBase
Creates an off-screen surface.
createVideoEffectObject(String, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
 
CRITICAL - Enum constant in enum class io.agora.rtc2.Constants.ThreadPriorityType
5.
cropBottom - Variable in class io.agora.rtc2.video.AgoraVideoFrame
Raw data related parameter.
cropLeft - Variable in class io.agora.rtc2.video.AgoraVideoFrame
Raw data related parameter.
cropRight - Variable in class io.agora.rtc2.video.AgoraVideoFrame
Raw data related parameter.
cropTop - Variable in class io.agora.rtc2.video.AgoraVideoFrame
Raw data related parameter.
CUSTOM_VIDEO_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
6: Custom video source.
customVideoTrackId - Variable in class io.agora.rtc2.ChannelMediaOptions
The video track ID returned by calling the `createCustomVideoTrack` method.
customVideoTrackId - Variable in class io.agora.rtc2.DirectCdnStreamingMediaOptions
Deprecated.
The video track ID returned by calling the `createCustomVideoTrack` method.

D

data - Variable in class io.agora.rtc2.video.AgoraMetadata
The buffer address of the received `AgoraMetadata`.
DataStreamConfig - Class in io.agora.rtc2
 
DataStreamConfig() - Constructor for class io.agora.rtc2.DataStreamConfig
 
decoderOutputFrameRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
The frame rate (fps) of decoding the remote video.
decodeTimeMs - Variable in class io.agora.rtc2.video.EncodedVideoFrameInfo
This is a output parameter which means timestamp for decoding the video frame.
DEFAULT - Enum constant in enum class io.agora.rtc2.Constants.AudioProfile
0: The default audio profile.
DEFAULT - Enum constant in enum class io.agora.rtc2.Constants.AudioScenario
0: (Recommended) The default audio scenario.
DEFAULT_CONNECTION_ID - Static variable in class io.agora.rtc2.Constants
The default connection ID.
DEFAULT_MIN_BITRATE - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
(For future use) Use the default minimum bitrate.
DEFAULT_MIN_BITRATE_EQUAL_TO_TARGET_BITRATE - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
-2: (For future use) Set minimum bitrate the same as target bitrate.
DEFAULT_MIN_FRAMERATE - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
(For future use) The default minimum frame rate.
defaultLayout - Variable in class io.agora.rtc2.PublisherParameters
Deprecated.
 
defaultLayout(int) - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
Sets the default layout.
defaultVideoStreamType - Variable in class io.agora.rtc2.ChannelMediaOptions
The default video-stream type: - VIDEO_STREAM_HIGH (0): High-quality stream, that is, a high-resolution and high-bitrate video stream.
degradationPrefer - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
Video degradation preference under limited bandwidth.
delay - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
Deprecated: In scenarios where audio and video are synchronized, you can get the video delay data from `networkTransportDelay` and `jitterBufferDelay` in `RemoteAudioStats`.
denoiserLevel - Variable in class io.agora.rtc2.video.VideoDenoiserOptions
Video noise reduction level.
denoiserMode - Variable in class io.agora.rtc2.video.VideoDenoiserOptions
Video noise reduction mode.
destroy() - Method in interface io.agora.mediaplayer.IMediaPlayer
 
destroy() - Static method in class io.agora.rtc2.RtcEngine
 
destroy() - Static method in class io.agora.spatialaudio.ILocalSpatialAudioEngine
 
destroy(IRtcEngineReleaseCallback) - Static method in class io.agora.rtc2.RtcEngine
 
destroyCustomAudioTrack(int) - Method in class io.agora.rtc2.RtcEngine
 
destroyCustomEncodedVideoTrack(int) - Method in class io.agora.rtc2.RtcEngine
destroy a created custom encoded video track id
destroyCustomVideoTrack(int) - Method in class io.agora.rtc2.RtcEngine
 
destroyMediaRecorder(AgoraMediaRecorder) - Method in class io.agora.rtc2.RtcEngine
 
destroyVideoEffectObject(IVideoEffectObject) - Method in class io.agora.rtc2.RtcEngine
 
deviceId - Variable in class io.agora.mediaplayer.data.PlayerUpdatedInfo
The ID of a deivce.
DeviceInfo - Class in io.agora.rtc2
 
DeviceInfo(boolean) - Constructor for class io.agora.rtc2.DeviceInfo
 
dimensions - Variable in class io.agora.rtc2.SimulcastConfig.StreamLayerConfig
Video frame size.
dimensions - Variable in class io.agora.rtc2.SimulcastStreamConfig
The video dimension.
dimensions - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
Users can set the resolution by themselves, or directly select the desired resolution from the following list: - VD_120x120: The video resolution is 120 × 120.
DirectCdnStreamingMediaOptions - Class in io.agora.rtc2
Deprecated.
v4.6.0.
DirectCdnStreamingMediaOptions() - Constructor for class io.agora.rtc2.DirectCdnStreamingMediaOptions
Deprecated.
 
DirectCdnStreamingReason - Enum Class in io.agora.rtc2
Deprecated.
v4.6.0.
DirectCdnStreamingState - Enum Class in io.agora.rtc2
Deprecated.
v4.6.0.
DirectCdnStreamingStats - Class in io.agora.rtc2
Deprecated.
v4.6.0.
DirectCdnStreamingStats() - Constructor for class io.agora.rtc2.DirectCdnStreamingStats
Deprecated.
 
DirectCdnStreamingStats(int, int, int, int, int) - Constructor for class io.agora.rtc2.DirectCdnStreamingStats
Deprecated.
 
DISABLE_SIMULCAST_STREAM - Enum constant in enum class io.agora.rtc2.Constants.SimulcastStreamMode
0: Never send low-quality video stream.
disableAudio() - Method in class io.agora.rtc2.RtcEngine
 
disableAudioSpectrumMonitor() - Method in class io.agora.rtc2.RtcEngine
 
disableAut - Variable in class io.agora.rtc2.proxy.LocalAccessPointConfiguration
Whether to disable vos-aut: - true: (Default)disable vos-aut.
DISABLED - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.DEGRADATION_PREFERENCE
4: Disabled VQC adjustion.
disableVideo() - Method in class io.agora.rtc2.RtcEngine
 
dispose() - Method in class io.agora.mediaplayer.gl.PlayerTextureHelper
Call disconnect() to stop receiving frames.
dispose() - Method in interface io.agora.mediaplayer.IPlayerTextureHelper
 
distance - Variable in class io.agora.rtc2.IRtcEngineEventHandler.AgoraFacePositionInfo
The distance between the human face and the device screen (cm).
domainList - Variable in class io.agora.rtc2.proxy.LocalAccessPointConfiguration
The domain name list for the Local Access Point.
DOWN - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.Quality
Deprecated.
 
downlinkMultipathMode - Variable in class io.agora.rtc2.ChannelMediaOptions
Downlink transmission mode.
DownlinkNetworkInfo() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.DownlinkNetworkInfo
 
downlinkReport - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LastmileProbeResult
Results of the downlink last-mile network test.
dualStreamEnabled - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
Whether we send dual stream now.
durationMs - Variable in class io.agora.rtc2.RecorderInfo
Duration of the recorded file, in milliseconds.

E

e2eDelay - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
End-to-end audio delay (in milliseconds), which refers to the time from when the audio is captured by the remote user to when it is played by the local user.
e2eDelay - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
End-to-end video latency (ms).
EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERS - Static variable in class io.agora.rtc2.Constants
2: Add an audio filter to the in-ear monitor.
EAR_MONITORING_FILTER_NOISE_SUPPRESSION - Static variable in class io.agora.rtc2.Constants
4: Enable noise suppression to the in-ear monitor.
EAR_MONITORING_FILTER_NONE - Static variable in class io.agora.rtc2.Constants
1: Do not add an audio filter to the in-ear monitor.
EAR_MONITORING_FILTER_REUSE_POST_PROCESSING_FILTER - Static variable in class io.agora.rtc2.Constants
32768: Enable audio filters by reuse post-processing filter to the in-ear monitor.
earMonitorDelay - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalAudioStats
The ear monitor delay (ms), which is the delay from microphone input to headphone output.
EchoTestConfiguration - Class in io.agora.rtc2
 
EchoTestConfiguration() - Constructor for class io.agora.rtc2.EchoTestConfiguration
 
EchoTestConfiguration(SurfaceView, boolean, boolean, String, String) - Constructor for class io.agora.rtc2.EchoTestConfiguration
 
EchoTestConfiguration(SurfaceView, boolean, boolean, String, String, int) - Constructor for class io.agora.rtc2.EchoTestConfiguration
 
eglContext10 - Variable in class io.agora.rtc2.video.AgoraVideoFrame
EGLContext10.
eglContext14 - Variable in class io.agora.rtc2.video.AgoraVideoFrame
EGLContext14.
EglCore - Class in io.agora.rtc2.internal.gdp
Core EGL state (display, context, config).
EglCore() - Constructor for class io.agora.rtc2.internal.gdp.EglCore
Prepares EGL display and context.
EglCore(EGLContext, int) - Constructor for class io.agora.rtc2.internal.gdp.EglCore
Prepares EGL display and context.
EglSurfaceBase - Class in io.agora.rtc2.internal.gdp
Common base class for EGL surfaces.
elapsedTime - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoRenderingTracingInfo
The time interval (ms) from `startMediaRenderingTracing` to SDK triggering the `onVideoRenderingTracingResult` callback.
enable - Variable in class io.agora.rtc2.SimulcastConfig.StreamLayerConfig
Whether to enable the video stream for the corresponding layer.
enable_air_absorb - Variable in class io.agora.rtc2.SpatialAudioParams
Whether to enable air absorption, that is, to simulate the sound attenuation effect of sound transmitting in the air; under a certain transmission distance, the attenuation speed of high-frequency sound is fast, and the attenuation speed of low-frequency sound is slow.
enable_blur - Variable in class io.agora.rtc2.SpatialAudioParams
Whether to enable audio blurring: - `true`: Enable audio blurring.
enable_doppler - Variable in class io.agora.rtc2.SpatialAudioParams
Whether to enable the Doppler effect: When there is a relative displacement between the sound source and the receiver of the sound source, the tone heard by the receiver changes.
ENABLE_SIMULCAST_STREAM - Enum constant in enum class io.agora.rtc2.Constants.SimulcastStreamMode
1: Always send low-quality video stream.
enableAgoraSource(boolean) - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
enableAlphaMask - Variable in class io.agora.rtc2.video.VideoCanvas
(Optional) Whether to enable alpha mask rendering: - `true`: Enable alpha mask rendering.
enableAudio - Variable in class io.agora.rtc2.EchoTestConfiguration
Whether to enable the audio device for the loop test: - `true`: (Default) Enable the audio device.
enableAudio() - Method in class io.agora.rtc2.RtcEngine
 
enableAudioProcessing - Variable in class io.agora.rtc2.audio.AudioTrackConfig
Whether to enable audio processing module: - `true`: Enable the audio processing module to apply the Automatic Echo Cancellation (AEC), Automatic Noise Suppression (ANS), and Automatic Gain Control (AGC) effects.
enableAudioRecordingOrPlayout - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to enable audio capturing or playback: - `true`: Enable audio capturing or playback.
enableAudioSpectrumMonitor(int) - Method in class io.agora.rtc2.RtcEngine
 
enableAudioVolumeIndication(int, int, boolean) - Method in class io.agora.rtc2.RtcEngine
 
enableAudioVolumeIndicationEx(int, int, boolean, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
enableAutoRemoveCache(boolean) - Method in interface io.agora.mediaplayer.IMediaPlayerCacheManager
 
enableAutoSwitchAgoraCDN(boolean) - Method in interface io.agora.mediaplayer.IMediaPlayer
Deprecated.
4.6.0
enableBuiltInMediaEncryption - Variable in class io.agora.rtc2.ChannelMediaOptions
Enable media packet encryption.
enableContentInspect(boolean, ContentInspectConfig) - Method in class io.agora.rtc2.RtcEngine
 
enableContentInspectEx(boolean, ContentInspectConfig, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
enableCustomAudioLocalPlayback(int, boolean) - Method in class io.agora.rtc2.RtcEngine
 
enableDualStreamMode(boolean) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
v4.2.0. This method is deprecated. Use setDualStreamMode instead.
enableDualStreamMode(boolean, SimulcastStreamConfig) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
v4.2.0. This method is deprecated. Use setDualStreamMode instead.
enableDualStreamModeEx(boolean, SimulcastStreamConfig, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Deprecated.
v4.2.0. This method is deprecated. Use setDualStreamModeEx instead.
enableEncryption(boolean, EncryptionConfig) - Method in class io.agora.rtc2.RtcEngine
 
enableEncryptionEx(boolean, EncryptionConfig, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
enableExtension(String, String, boolean) - Method in class io.agora.rtc2.RtcEngine
Enable/Disable an extension.
enableExtension(String, String, boolean, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
 
enableExtension(String, String, ExtensionInfo, boolean) - Method in class io.agora.rtc2.RtcEngine
Enable/Disable an extension.
enableExternalAudioSourceLocalPlayback(boolean) - Method in class io.agora.rtc2.RtcEngine
Enable or disable the external audio source local playback.
enableFaceDetection(boolean) - Method in class io.agora.rtc2.RtcEngine
 
enableHighPerfWifiMode(boolean) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
This method is deprecated.
enableInEarMonitoring(boolean) - Method in class io.agora.rtc2.RtcEngine
 
enableInEarMonitoring(boolean, int) - Method in class io.agora.rtc2.RtcEngine
 
enableInstantMediaRendering() - Method in class io.agora.rtc2.RtcEngine
 
enableLiveSource(boolean) - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
enableLocalAudio(boolean) - Method in class io.agora.rtc2.RtcEngine
 
enableLocalPlayback - Variable in class io.agora.rtc2.audio.AudioTrackConfig
Whether to enable the local audio-playback device: - `true`: (Default) Enable the local audio-playback device.
enableLocalVideo(boolean) - Method in class io.agora.rtc2.RtcEngine
 
enableMultipath - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to enable multiple transmisssion paths: - `true`: Enable multiple transmisssion path.
enableSoundPositionIndication(boolean) - Method in class io.agora.rtc2.RtcEngine
 
enableSpatialAudio(boolean) - Method in class io.agora.rtc2.RtcEngine
 
enableTranscode(String, String, int) - Method in interface io.agora.rtc2.IH265Transcoder
Enable transcoding for a channel.
enableTransportQualityIndication(boolean) - Method in class io.agora.rtc2.RtcEngineInternal
 
enableVideo - Variable in class io.agora.rtc2.EchoTestConfiguration
Whether to enable the video device for the loop test: - `true`: (Default) Enable the video device.
enableVideo() - Method in class io.agora.rtc2.RtcEngine
 
enableVideoImageSource(boolean, ImageTrackOptions) - Method in class io.agora.rtc2.RtcEngine
 
enableVirtualBackground(boolean, VirtualBackgroundSource, SegmentationProperty) - Method in class io.agora.rtc2.RtcEngine
 
enableVirtualBackground(boolean, VirtualBackgroundSource, SegmentationProperty, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
 
enableVoiceAITuner(boolean, Constants.VOICE_AI_TUNER_TYPE) - Method in class io.agora.rtc2.RtcEngine
 
enableWebSdkInteroperability(boolean) - Method in class io.agora.rtc2.RtcEngine
 
encodeAlpha - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration.AdvanceOptions
Whether to encode and send the Alpha data present in the video frame to the remote end: - `true`: Encode and send Alpha data.
ENCODED_VIDEO_FRAME - Enum constant in enum class io.agora.rtc2.Constants.ExternalVideoSourceType
1: The video frame is encoded.
encodedBitrate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The bitrate (Kbps) while encoding the local video stream.
encodedFrameCount - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The number of the sent video frames, represented by an aggregate value.
encodedFrameDepth - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
 
encodedFrameHeight - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The height of the encoded video (px).
encodedFrameWidth - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The width of the encoded video (px).
EncodedVideoFrameInfo - Class in io.agora.rtc2.video
 
EncodedVideoFrameInfo() - Constructor for class io.agora.rtc2.video.EncodedVideoFrameInfo
 
EncodedVideoFrameInfo(int, int, int, int, int, int, int, long, long, int) - Constructor for class io.agora.rtc2.video.EncodedVideoFrameInfo
 
EncodedVideoTrackOptions - Class in io.agora.rtc2
The channel media options.
EncodedVideoTrackOptions() - Constructor for class io.agora.rtc2.EncodedVideoTrackOptions
 
encoderOutputFrameRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The output frame rate (fps) of the local video encoder.
encodingPreference - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration.AdvanceOptions
Video encoder preference.
ENCRYPTION_ERROR_DATASTREAM_DECRYPTION_FAILURE - Static variable in class io.agora.rtc2.Constants
3: DataStream decryption errors.
ENCRYPTION_ERROR_DATASTREAM_ENCRYPTION_FAILURE - Static variable in class io.agora.rtc2.Constants
4: DataStream encryption errors.
ENCRYPTION_ERROR_DECRYPTION_FAILURE - Static variable in class io.agora.rtc2.Constants
1: MediaStream decryption errors.
ENCRYPTION_ERROR_ENCRYPTION_FAILURE - Static variable in class io.agora.rtc2.Constants
2: MediaStream encryption errors.
ENCRYPTION_ERROR_INTERNAL_FAILURE - Static variable in class io.agora.rtc2.Constants
0: Internal reason.
ERR_ABORTED - Static variable in class io.agora.rtc2.Constants
The SDK gives up the request due to too many requests.
ERR_ABORTED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
20: The SDK gives up the request due to too many requests.
ERR_ADM_GENERAL_ERROR - Static variable in class io.agora.rtc2.Constants
General error on the Audio Device Module (no classified reason).
ERR_ADM_GENERAL_ERROR - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
1005: General error on the audio device module (no specified reason).
ERR_ADM_INIT_PLAYOUT - Static variable in class io.agora.rtc2.Constants
Audio Device Module: Error in initializing the playback device.
ERR_ADM_INIT_PLAYOUT - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
1008: Audio Device Module: An error occurs in initializing the playback device.
ERR_ADM_INIT_RECORDING - Static variable in class io.agora.rtc2.Constants
Audio Device Module: Error in initializing the recording device.
ERR_ADM_INIT_RECORDING - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
1011: Audio Device Module: An error occurs when initializing the recording device.
ERR_ADM_START_PLAYOUT - Static variable in class io.agora.rtc2.Constants
Audio Device Module: Error in starting the playback device.
ERR_ADM_START_PLAYOUT - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
1009: Audio Device Module: An error occurs when starting the playback device.
ERR_ADM_START_RECORDING - Static variable in class io.agora.rtc2.Constants
Audio Device Module: Error in starting the recording device.
ERR_ADM_START_RECORDING - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
1012: Audio Device Module: An error occurs when starting the recording device.
ERR_ADM_STOP_PLAYOUT - Static variable in class io.agora.rtc2.Constants
Audio Device Module: Error in stopping the playback device.
ERR_ADM_STOP_PLAYOUT - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
1010: Audio Device Module: An error occurs when stopping the playback device.
ERR_ADM_STOP_RECORDING - Static variable in class io.agora.rtc2.Constants
Audio Device Module: Error in stopping the recording device.
ERR_ADM_STOP_RECORDING - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
1013: Audio Device Module: An error occurs when stopping the recording device.
ERR_ALREADY_IN_USE - Static variable in class io.agora.rtc2.Constants
Resources are occupied, and cannot be reused.
ERR_ALREADY_IN_USE - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
19: Resources are occupied, and cannot be reused.
ERR_AUDIO_BT_SCO_FAILED - Static variable in class io.agora.rtc2.Constants
 
ERR_BIND_SOCKET - Static variable in class io.agora.rtc2.Constants
The SDK fails to bind to the network socket.
ERR_BIND_SOCKET - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
13: The SDK fails to bind to the network socket.
ERR_BITRATE_LIMIT - Static variable in class io.agora.rtc2.Constants
The bitrate is limited.
ERR_BITRATE_LIMIT - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
115: The bitrate is limited.
ERR_BUFFER_TOO_SMALL - Static variable in class io.agora.rtc2.Constants
The buffer size is not big enough to store the returned data.
ERR_BUFFER_TOO_SMALL - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
6: The buffer size is not big enough to store the returned data.
ERR_CANCELED - Static variable in class io.agora.rtc2.Constants
The request is cancelled.
ERR_CANCELED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
11: The request is cancelled.
ERR_CLIENT_IS_BANNED_BY_SERVER - Static variable in class io.agora.rtc2.Constants
The client is banned by the server.
ERR_CLIENT_IS_BANNED_BY_SERVER - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
123: The client is banned by the server.
ERR_CONNECTION_INTERRUPTED - Static variable in class io.agora.rtc2.Constants
The CONNECTION_INTERRUPTED callback.
ERR_CONNECTION_INTERRUPTED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
111: The CONNECTION_INTERRUPTED callback.
ERR_CONNECTION_LOST - Static variable in class io.agora.rtc2.Constants
The CONNECTION_LOST callback.
ERR_CONNECTION_LOST - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
112: The CONNECTION_LOST callback.
ERR_DATASTREAM_DECRYPTION_FAILED - Static variable in class io.agora.rtc2.Constants
Failed to decrypt datastream.
ERR_DATASTREAM_DECRYPTION_FAILED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
122: Data stream decryption fails.
ERR_DECRYPTION_FAILED - Static variable in class io.agora.rtc2.Constants
Failed to decrypt mediastream.
ERR_DECRYPTION_FAILED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
120: Media stream decryption fails.
ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH - Static variable in class io.agora.rtc2.Constants
Encryption is enabled when the user calls the addPublishStreamUrl method (CDN live streaming does not support encrypted streams).
ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
130: Encryption is enabled when the user calls the addPublishStreamUrl method (CDN live streaming does not support encrypted streams).
ERR_FAILED - Static variable in class io.agora.rtc2.Constants
A general error occurs (no specified reason).
ERR_FAILED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
1: A general error occurs (no specified reason).
ERR_INIT_NET_ENGINE - Static variable in class io.agora.rtc2.Constants
On Windows, specific firewall settings can cause the SDK to fail to initialize and crash.
ERR_INIT_NET_ENGINE - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
21: On Windows, specific firewall settings can cause the SDK to fail to initialize and crash.
ERR_INVALID_APP_ID - Static variable in class io.agora.rtc2.Constants
The specified App ID is invalid.
ERR_INVALID_APP_ID - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
101: The specified App ID is invalid.
ERR_INVALID_ARGUMENT - Static variable in class io.agora.rtc2.Constants
An invalid parameter is used.
ERR_INVALID_ARGUMENT - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
2: An invalid parameter is used.
ERR_INVALID_CHANNEL_NAME - Static variable in class io.agora.rtc2.Constants
The specified channel name is invalid.
ERR_INVALID_CHANNEL_NAME - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
102: The specified channel name is invalid.
ERR_INVALID_STATE - Static variable in class io.agora.rtc2.Constants
The state is invalid.
ERR_INVALID_TOKEN - Static variable in class io.agora.rtc2.Constants
The Token is invalid due to one of the following reasons: The App Certificate for the project is enabled on the Dashboard, but the user is still using the App ID.
ERR_INVALID_TOKEN - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
110: The token is invalid due to one of the following reasons: - The App Certificate for the project is enabled in Console, but the user is still using the App ID.
ERR_INVALID_USER_ACCOUNT - Static variable in class io.agora.rtc2.Constants
The user account is invalid, usually because the data format of the user account is incorrect.
ERR_INVALID_USER_ACCOUNT - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
134: The user account is invalid, usually because the data format of the user account is incorrect.
ERR_INVALID_USER_ID - Static variable in class io.agora.rtc2.Constants
The user ID is invalid.
ERR_INVALID_USER_ID - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
121: The user ID is invalid.
ERR_JOIN_CHANNEL_REJECTED - Static variable in class io.agora.rtc2.Constants
The request to join the channel is rejected.
ERR_JOIN_CHANNEL_REJECTED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
17: The request to join the channel is rejected.
ERR_LEAVE_CHANNEL_REJECTED - Static variable in class io.agora.rtc2.Constants
The request to leave the channel is rejected.
ERR_LEAVE_CHANNEL_REJECTED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
18: The request to leave the channel is rejected.
ERR_LICENSE_CREDENTIAL_INVALID - Static variable in class io.agora.rtc2.Constants
License credential is invalid
ERR_LICENSE_CREDENTIAL_INVALID - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
131: License credential is invalid
ERR_LOAD_MEDIA_ENGINE - Static variable in class io.agora.rtc2.Constants
Failed to load the media engine.
ERR_LOAD_MEDIA_ENGINE - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
1001: Fails to load the media engine.
ERR_MODULE_NOT_FOUND - Static variable in class io.agora.rtc2.Constants
The extension library is not integrated, such as the library for enabling deep-learning noise reduction.
ERR_MODULE_NOT_FOUND - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
157: The extension library is not integrated, such as the library for enabling deep-learning noise reduction.
ERR_NET_DOWN - Static variable in class io.agora.rtc2.Constants
The network is unavailable.
ERR_NET_DOWN - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
14: The network is unavailable.
ERR_NO_PERMISSION - Static variable in class io.agora.rtc2.Constants
No permission.
ERR_NO_PERMISSION - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
9: No permission.
ERR_NO_SERVER_RESOURCES - Static variable in class io.agora.rtc2.Constants
Fails to get server resources in the specified region.
ERR_NO_SERVER_RESOURCES - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
103: Fails to get server resources in the specified region.
ERR_NOT_IN_CHANNEL - Static variable in class io.agora.rtc2.Constants
The user is not in the channel.
ERR_NOT_IN_CHANNEL - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
113: The user is not in the channel.
ERR_NOT_INITIALIZED - Static variable in class io.agora.rtc2.Constants
The SDK is not initialized before calling this API.
ERR_NOT_INITIALIZED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
7: The SDK is not initialized before calling this API.
ERR_NOT_READY - Static variable in class io.agora.rtc2.Constants
The SDK module is not ready.
ERR_NOT_READY - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
3: The SDK module is not ready.
ERR_NOT_SUPPORTED - Static variable in class io.agora.rtc2.Constants
The SDK does not support this function.
ERR_NOT_SUPPORTED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
4: The SDK does not support this function.
ERR_OK - Static variable in class io.agora.rtc2.Constants
No error occurs.
ERR_OK - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
0: No error occurs.
ERR_PCMSEND_BUFFEROVERFLOW - Static variable in class io.agora.rtc2.Constants
201: Buffer overflow, the pcm send rate too quickly.
ERR_PCMSEND_FORMAT - Static variable in class io.agora.rtc2.Constants
200: Unsupported pcm format.
ERR_RDT_CMD_EXCEED_LIMIT - Static variable in class io.agora.rtc2.Constants
253: The RDT CMD stream exceeds the limit (size <= 256 Bytes, freq <= 100/sec)
ERR_RDT_DATA_BLOCKED - Static variable in class io.agora.rtc2.Constants
252: The RDT data stream is blocked
ERR_RDT_DATA_EXCEED_LIMIT - Static variable in class io.agora.rtc2.Constants
254: The RDT DATA stream exceeds the limit (size <= 128 KBytes, speed <= 4 Mbps)
ERR_RDT_ENCRYPTION - Static variable in class io.agora.rtc2.Constants
255: The RDT encryption error.
ERR_RDT_USER_NOT_EXIST - Static variable in class io.agora.rtc2.Constants
250: The user does not exist
ERR_RDT_USER_NOT_READY - Static variable in class io.agora.rtc2.Constants
251: The RDT state with the user is not ready
ERR_REFUSED - Static variable in class io.agora.rtc2.Constants
The request is rejected.
ERR_REFUSED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
5: The request is rejected.
ERR_RESOURCE_LIMITED - Static variable in class io.agora.rtc2.Constants
The app uses too much of the system resource and the SDK fails to allocate any resource.
ERR_RESOURCE_LIMITED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
22: The app uses too much of the system resource and the SDK fails to allocate any resource.
ERR_SCREEN_CAPTURE_PERMISSION_DENIED - Static variable in class io.agora.rtc2.Constants
16: The user refuses to grant screen capture permission to the application.
ERR_SCREEN_CAPTURE_SYSTEM_AUDIO_NOT_SUPPORTED - Static variable in class io.agora.rtc2.Constants
3: Due to system limitations, system audio cannot be captured on systems earlier than Android 10 (that is, API level 29).
ERR_SCREEN_CAPTURE_SYSTEM_NOT_SUPPORTED - Static variable in class io.agora.rtc2.Constants
2: Due to system limitations, screen capture is not available on systems earlier than Android 5 (that is, Android API level 21).
ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED - Static variable in class io.agora.rtc2.Constants
Switching the user role fails.
ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
119: Switching the user role fails.
ERR_SIZE_TOO_LARGE - Static variable in class io.agora.rtc2.Constants
The data size is too big.
ERR_SIZE_TOO_LARGE - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
114: The data size is too big.
ERR_STREAM_MESSAGE_TIMEOUT - Static variable in class io.agora.rtc2.Constants
A timeout occurs for the data stream transmission.
ERR_STREAM_MESSAGE_TIMEOUT - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
117: A timeout occurs for the data stream transmission.
ERR_TIMEDOUT - Static variable in class io.agora.rtc2.Constants
An API timeout.
ERR_TIMEDOUT - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
10: An API timeout.
ERR_TOKEN_EXPIRED - Static variable in class io.agora.rtc2.Constants
The Token expired due to one of the following reasons: Authorized Timestamp expired: The timestamp is represented by the number of seconds elapsed since 1/1/1970.
ERR_TOKEN_EXPIRED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
109: The token expired due to one of the following reasons: - Authorized Timestamp expired: The timestamp is represented by the number of seconds elapsed since 1/1/1970.
ERR_TOO_MANY_DATA_STREAMS - Static variable in class io.agora.rtc2.Constants
Too many data streams.
ERR_TOO_MANY_DATA_STREAMS - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
116: Too many data streams.
ERR_TOO_OFTEN - Static variable in class io.agora.rtc2.Constants
The call frequency is too high.
ERR_TOO_OFTEN - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
12: The call frequency is too high.
ERR_VDM_CAMERA_NOT_AUTHORIZED - Static variable in class io.agora.rtc2.Constants
Video Device Module: The camera is not authorized.
ERR_VDM_CAMERA_NOT_AUTHORIZED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
1501: Video Device Module: The camera is not authorized.
ErrorCode() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
 
EXCELLENT - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.Quality
Deprecated.
 
EXPERIENCE_QUALITY_BAD - Static variable in class io.agora.rtc2.Constants
1: QoE of the local user is poor.
EXPERIENCE_QUALITY_GOOD - Static variable in class io.agora.rtc2.Constants
0: QoE of the local user is good.
EXPERIENCE_REASON_NONE - Static variable in class io.agora.rtc2.Constants
0: No reason, indicating good QoE of the local user.
ExtensionContext - Class in io.agora.rtc2
 
ExtensionContext() - Constructor for class io.agora.rtc2.ExtensionContext
 
ExtensionContext(int, String, String) - Constructor for class io.agora.rtc2.ExtensionContext
 
ExtensionInfo - Class in io.agora.rtc2
 
ExtensionInfo() - Constructor for class io.agora.rtc2.ExtensionInfo
 
ExtensionInfo(Constants.MediaSourceType, int, String, int) - Constructor for class io.agora.rtc2.ExtensionInfo
 
extensionName - Variable in class io.agora.rtc2.ExtensionContext
The name of the extension.
extraInfo - Variable in class io.agora.rtc2.PublisherParameters
Deprecated.
 
extraInfo - Variable in class io.agora.rtc2.video.ContentInspectConfig
Additional information on the video content (maximum length: 1024 Bytes).
extraInfo(String) - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
Adds extra information.

F

FACE_SHAPE_AREA_CHEEK - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
106: Cheek, adjusts the size of the cheek.
FACE_SHAPE_AREA_CHEEKBONE - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
105: Cheekbone, adjusts the size of the cheekbone.
FACE_SHAPE_AREA_CHIN - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
108: Chin, adjusts the length of the chin.
FACE_SHAPE_AREA_EYEBROWPOSITION - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
500: Eyebrow Position, adjusts the position of the eyebrows.
FACE_SHAPE_AREA_EYEBROWTHICKNESS - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
501: Eyebrow Thickness, adjusts the thickness of the eyebrows.
FACE_SHAPE_AREA_EYEDISTANCE - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
201: Eye Distance, adjusts the distance between the two eyes.
FACE_SHAPE_AREA_EYEINNERCORNER - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
205: Eye Inner Corner, adjusts the inner corner of the eyes.
FACE_SHAPE_AREA_EYELID - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
203: Lower Eyelid, adjusts the downward position of the eyelids.
FACE_SHAPE_AREA_EYEOUTERCORNER - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
206: Eye Outer Corner, adjusts the outer corner of the eyes.
FACE_SHAPE_AREA_EYEPOSITION - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
202: Eye Position, adjusts the upper and lower position of the eyes.
FACE_SHAPE_AREA_EYEPUPILS - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
204: Eye Pupils, adjusts the size of the eye pupils.
FACE_SHAPE_AREA_EYESCALE - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
200: Eye Scale, adjusts the size of the eyes.
FACE_SHAPE_AREA_FACECONTOUR - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
102: Face Contour, slims the facial contour.
FACE_SHAPE_AREA_FACELENGTH - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
103: Face Length, adjusts the length of the face.
FACE_SHAPE_AREA_FACEWIDTH - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
104: Face Width, narrows the width of the face.
FACE_SHAPE_AREA_FOREHEAD - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
101: Forehead, adjusts the size of the forehead.
FACE_SHAPE_AREA_HEADSCALE - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
100: Head Scale, reduces the size of the head.
FACE_SHAPE_AREA_MANDIBLE - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
107: Mandible, slims the mandible.
FACE_SHAPE_AREA_MOUTHLIP - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
403: Mouth Lip, adjusts the size of the lips.
FACE_SHAPE_AREA_MOUTHPOSITION - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
401: Mouth Position, adjusts the position of the mouth.
FACE_SHAPE_AREA_MOUTHSCALE - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
400: Mouth Scale, adjusts the size of the mouth.
FACE_SHAPE_AREA_MOUTHSMILE - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
402: Mouth Smile, adjusts the smile degree of the mouth.
FACE_SHAPE_AREA_NONE - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
-1: (Default) Invalid area.
FACE_SHAPE_AREA_NOSEBRIDGE - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
304: Nose Bridge, adjusts the size of the nose bridge.
FACE_SHAPE_AREA_NOSEGENERAL - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
306: Nose General, adjusts the overall size of the nose.
FACE_SHAPE_AREA_NOSELENGTH - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
300: Nose Length, adjusts the length of the nose.
FACE_SHAPE_AREA_NOSEROOT - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
303: Nose Root, adjusts the size of the nose root.
FACE_SHAPE_AREA_NOSETIP - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
305: Nose Tip, adjusts the size of the nose tip.
FACE_SHAPE_AREA_NOSEWIDTH - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
301: Nose Width, adjusts the width of the nose.
FACE_SHAPE_AREA_NOSEWING - Static variable in class io.agora.rtc2.video.FaceShapeAreaOptions
302: Nose Wing, adjusts the size of the nose wing.
FACE_SHAPE_BEAUTY_STYLE_FEMALE - Static variable in class io.agora.rtc2.video.FaceShapeBeautyOptions
0: (Default) Female face shape style.
FACE_SHAPE_BEAUTY_STYLE_MALE - Static variable in class io.agora.rtc2.video.FaceShapeBeautyOptions
1: Male face shape style.
FACE_SHAPE_BEAUTY_STYLE_NATURAL - Static variable in class io.agora.rtc2.video.FaceShapeBeautyOptions
2: Natural face shape style.
FaceShapeAreaOptions - Class in io.agora.rtc2.video
 
FaceShapeAreaOptions() - Constructor for class io.agora.rtc2.video.FaceShapeAreaOptions
 
FaceShapeAreaOptions(int, int) - Constructor for class io.agora.rtc2.video.FaceShapeAreaOptions
The face shape area options.
FaceShapeBeautyOptions - Class in io.agora.rtc2.video
 
FaceShapeBeautyOptions() - Constructor for class io.agora.rtc2.video.FaceShapeBeautyOptions
 
FaceShapeBeautyOptions(int, int) - Constructor for class io.agora.rtc2.video.FaceShapeBeautyOptions
Face shape beauty options.
FAILED - Enum constant in enum class io.agora.rtc2.DirectCdnStreamingReason
Deprecated.
1: A general error; no specific reason.
FAILED - Enum constant in enum class io.agora.rtc2.DirectCdnStreamingState
Deprecated.
3: Fails to push streams to the CDN.
FEATURE_VIDEO_BEAUTY_EFFECT - Static variable in class io.agora.rtc2.Constants
 
FEATURE_VIDEO_VIRTUAL_BACKGROUND - Static variable in class io.agora.rtc2.Constants
FeatureType
fileName - Variable in class io.agora.rtc2.RecorderInfo
The absolute storage path of the recording file.
filePath - Variable in class io.agora.rtc2.RtcEngineConfig.LogConfig
The complete path of the log files.
filePath - Variable in class io.agora.rtc2.video.SnapshotConfig
The local path (including filename extensions) of the snapshot.
fileSize - Variable in class io.agora.rtc2.RecorderInfo
Size of the recording file, in bytes.
fileSizeInKB - Variable in class io.agora.rtc2.RtcEngineConfig.LogConfig
The size (KB) of an `agorasdk.log` file.
FILTER - Enum constant in enum class io.agora.rtc2.IVideoEffectObject.VIDEO_EFFECT_NODE_ID
(4): Filter effect node.
FilterEffectOptions - Class in io.agora.rtc2.video
 
FilterEffectOptions() - Constructor for class io.agora.rtc2.video.FilterEffectOptions
 
FilterEffectOptions(String, float) - Constructor for class io.agora.rtc2.video.FilterEffectOptions
 
FLAG_RECORDABLE - Static variable in class io.agora.rtc2.internal.gdp.EglCore
Constructor flag: surface must be recordable.
FLAG_TRY_GLES3 - Static variable in class io.agora.rtc2.internal.gdp.EglCore
Constructor flag: ask for GLES3, fall back to GLES2 if not available.
focalLengthType - Variable in class io.agora.rtc2.video.AgoraFocalLengthInfo
The focal length type.
followEncodeDimensionRatio - Variable in class io.agora.rtc2.video.CameraCapturerConfiguration
(Optional) Whether to follow the video aspect ratio set in `setVideoEncoderConfiguration`: - `true`: (Default) Follow the set video aspect ratio.
FORBIDDEN - Enum constant in enum class io.agora.rtc2.IH265TranscoderObserver.H265TranscodeResult
4: No permission to access the interface.
format - Variable in class io.agora.rtc2.video.AgoraVideoFrame
The format of the video data: - 10: TEXTURE_2D - 11: TEXTURE_OES, usually the data captured by the camera is in this format.
format - Variable in class io.agora.rtc2.video.WatermarkBuffer
Format of the watermark image: - `WATERMARK_BUFFER_FORMAT_I420`: I420 format.
FORMAT_BGRA - Static variable in class io.agora.rtc2.video.AgoraVideoFrame
2: The video format is BGRA.
FORMAT_I420 - Static variable in class io.agora.rtc2.video.AgoraVideoFrame
1: The video format is I420.
FORMAT_I422 - Static variable in class io.agora.rtc2.video.AgoraVideoFrame
16: Video frame in the format of I422.
FORMAT_NONE - Static variable in class io.agora.rtc2.video.AgoraVideoFrame
-1: No video format.
FORMAT_NV21 - Static variable in class io.agora.rtc2.video.AgoraVideoFrame
3: The video format is NV21.
FORMAT_RGBA - Static variable in class io.agora.rtc2.video.AgoraVideoFrame
4: The video format is RGBA.
FORMAT_TEXTURE_2D - Static variable in class io.agora.rtc2.video.AgoraVideoFrame
10: The video format is TEXTURE_2D.
FORMAT_TEXTURE_OES - Static variable in class io.agora.rtc2.video.AgoraVideoFrame
11: The video format is TEXTURE_OES.
forward - Variable in class io.agora.spatialaudio.RemoteVoicePositionInfo
The unit vector of the x axis in the coordinate system.
forward - Variable in class io.agora.spatialaudio.SpatialAudioZone
Starting at `position`, the forward unit vector.
forwardLength - Variable in class io.agora.spatialaudio.SpatialAudioZone
The entire sound insulation area is regarded as a cube; this represents the length of the forward side in the unit length of the game engine.
fps - Variable in class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
Frame rate for recording video.
fps - Variable in class io.agora.rtc2.DirectCdnStreamingStats
Deprecated.
The frame rate (fps) of the current video frame.
fps - Variable in class io.agora.rtc2.video.CameraCapturerConfiguration.CaptureFormat
The video frame rate (fps).
FRAME_RATE_FPS_1 - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.FRAME_RATE
1: 1 fps.
FRAME_RATE_FPS_10 - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.FRAME_RATE
10: 10 fps.
FRAME_RATE_FPS_15 - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.FRAME_RATE
15: 15 fps.
FRAME_RATE_FPS_24 - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.FRAME_RATE
24: 24 fps.
FRAME_RATE_FPS_30 - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.FRAME_RATE
30: 30 fps.
FRAME_RATE_FPS_60 - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.FRAME_RATE
Not supported.
FRAME_RATE_FPS_7 - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.FRAME_RATE
7: 7 fps.
frameLossRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
The packet loss rate (%) of the remote video.
framerate - Variable in class io.agora.rtc2.PublisherParameters
Deprecated.
 
framerate - Variable in class io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters
The video encoding frame rate (fps).
framerate - Variable in class io.agora.rtc2.SimulcastConfig.StreamLayerConfig
Frame rate (fps) of the local video capture.
framerate - Variable in class io.agora.rtc2.SimulcastStreamConfig
The frame rate (fps) of the local video.
frameRate - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
The frame rate (fps) of the encoding video frame.
frameRate(int) - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
Sets the stream's frame rate.
framesPerSecond - Variable in class io.agora.rtc2.video.EncodedVideoFrameInfo
The number of video frames per second.
frameType - Variable in class io.agora.rtc2.video.EncodedVideoFrameInfo
The video frame type.
fromInt(int) - Static method in enum class io.agora.rtc2.Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY
 
fromInt(int) - Static method in enum class io.agora.rtc2.Constants.AUDIO_REVERB_TYPE
 
fromInt(int) - Static method in enum class io.agora.rtc2.Constants.AudioSourceType
 
fromInt(int) - Static method in enum class io.agora.rtc2.Constants.MEDIA_TRACE_EVENT
 
fromInt(int) - Static method in enum class io.agora.rtc2.Constants.MultipathType
 
fromInt(int) - Static method in enum class io.agora.rtc2.Constants.RenewTokenErrorCode
 
fromInt(int) - Static method in enum class io.agora.rtc2.Constants.VideoSourceType
 
fromInt(int) - Static method in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
 
fromInt(int) - Static method in enum class io.agora.rtc2.DirectCdnStreamingReason
Deprecated.
 
fromInt(int) - Static method in enum class io.agora.rtc2.DirectCdnStreamingState
Deprecated.
 
fromInt(int) - Static method in enum class io.agora.rtc2.IH265TranscoderObserver.H265TranscodeResult
 
fromNativeIndex(int) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
 
fromNativeIndex(int) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerMetadataType
 
fromNativeIndex(int) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerPreloadEvent
 
fromNativeIndex(int) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
 
fromNativeIndex(int) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerState
 
frozenCntByCustom - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
 
frozenRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
The total audio freeze time as a percentage (%) of the total time when the audio is available.
frozenRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
The total video freeze time as a percentage (%) of the total time the video is available.
frozenRateByCustomPlcCount - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
If the packet loss concealment (PLC) occurs for N consecutive times, freeze is considered as PLC occurring for M consecutive times.
frozenTimeByCustom - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
 

G

GAME_STREAMING - Enum constant in enum class io.agora.rtc2.Constants.AudioScenario
3: (Recommended) The live gaming scenario, which needs to enable the gaming audio effects in the speaker mode in a live broadcast scenario.
gatewayRtt - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The round-trip time delay (ms) from the client to the local router.
GDPAndroid - Class in io.agora.rtc2.internal.gdp
 
GDPAndroid() - Constructor for class io.agora.rtc2.internal.gdp.GDPAndroid
 
getAdvancedFeatures() - Method in class io.agora.rtc2.live.LiveTranscoding
Checks whether advanced features of the RTMP or RTMPS streaming with transcoding are enabled.
getAgoraCDNLineCount() - Method in interface io.agora.mediaplayer.IMediaPlayer
Deprecated.
4.6.0
getAirAbsorbFlag() - Method in class io.agora.rtc2.SpatialAudioParams
get air absorb enabled flag
getAppId() - Method in class io.agora.rtc2.RtcEngineConfig
 
getAreaCode() - Method in class io.agora.rtc2.RtcEngineConfig
 
getAudienceLatencyLevel() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getAudienceLatencyLevel() - Method in class io.agora.rtc2.ClientRoleOptions
 
getAudioAttenuation() - Method in class io.agora.spatialaudio.SpatialAudioZone
 
getAudioBitrate() - Method in class io.agora.mediaplayer.data.PlayerPlaybackStats
 
getAudioBitsPerSample() - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
 
getAudioBufferDelay() - Method in interface io.agora.mediaplayer.IMediaPlayer
 
getAudioBytesPerSample() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
getAudioCaptureParameters() - Method in class io.agora.rtc2.ScreenCaptureParameters
 
getaudioChannels() - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
 
getAudioChannels() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
getAudioDelayMs() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getAudioDeviceInfo() - Method in class io.agora.rtc2.RtcEngine
 
getAudioEffectManager() - Method in class io.agora.rtc2.RtcEngine
 
getAudioMixingCurrentPosition() - Method in class io.agora.rtc2.RtcEngine
 
getAudioMixingDuration() - Method in class io.agora.rtc2.RtcEngine
 
getAudioMixingPlayoutVolume() - Method in class io.agora.rtc2.RtcEngine
 
getAudioMixingPublishVolume() - Method in class io.agora.rtc2.RtcEngine
 
getAudioSampleRate() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
getAudioSampleRate() - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
 
getAudioScenario() - Method in class io.agora.rtc2.RtcEngineConfig
 
getAudioSpectrumData() - Method in class io.agora.rtc2.audio.AudioSpectrumInfo
 
getAudioSpectrumInfo() - Method in class io.agora.rtc2.audio.UserAudioSpectrumInfo
 
getAudioTrackCount() - Method in class io.agora.rtc2.RtcEngine
 
getAutoRegisterAgoraExtensions() - Method in class io.agora.rtc2.RtcEngineConfig
 
getAvailableTextureInfo(int) - Method in class io.agora.mediaplayer.gl.PlayerTextureHelper
wait for most waitTime time;
getAvailableTextureInfo(int) - Method in interface io.agora.mediaplayer.IPlayerTextureHelper
 
getBackgroundColor() - Method in class io.agora.rtc2.live.LiveTranscoding
Gets the background color in hex.
getBackgroundImageList() - Method in class io.agora.rtc2.live.LiveTranscoding
get object attribute of backgroundImageList
getBattery() - Method in class io.agora.rtc2.internal.gdp.GDPAndroid
 
getBeatsPerMeasure() - Method in class io.agora.rtc2.audio.AgoraRhythmPlayerConfig
 
getBeatsPerMinute() - Method in class io.agora.rtc2.audio.AgoraRhythmPlayerConfig
 
getBitrate() - Method in class io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters
 
getBitrate() - Method in class io.agora.rtc2.SimulcastStreamConfig
 
getBitrateInKbps() - Method in class io.agora.mediaplayer.data.SrcInfo
 
getBlue() - Method in class io.agora.rtc2.live.LiveTranscoding
Deprecated.
Gets the background color's blue component.
getBlurFlag() - Method in class io.agora.rtc2.SpatialAudioParams
get blur enabled flag
getBuffer() - Method in class io.agora.rtc2.video.WatermarkBuffer
 
getBuffer() - Method in class io.agora.rtc2.video.WatermarkConfig
 
getByteBuffer() - Method in class io.agora.base.AudioFrame
 
getBytesPerSample() - Method in class io.agora.base.AudioFrame
 
getCacheDir() - Method in interface io.agora.mediaplayer.IMediaPlayerCacheManager
 
getCacheFileCount() - Method in interface io.agora.mediaplayer.IMediaPlayerCacheManager
 
getCacheSize() - Method in class io.agora.mediaplayer.data.CacheStatistics
 
getCallId() - Method in class io.agora.rtc2.RtcEngine
 
getCallIdEx(RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
getCameraDirection() - Method in class io.agora.rtc2.video.CameraCapturerConfiguration
 
getCameraFocalLengthType() - Method in class io.agora.rtc2.video.CameraCapturerConfiguration
 
getCameraId() - Method in class io.agora.rtc2.video.CameraCapturerConfiguration
 
getCameraMaxZoomFactor() - Method in class io.agora.rtc2.RtcEngine
 
getCaptureFormat() - Method in class io.agora.rtc2.video.CameraCapturerConfiguration
 
getCaptureSignalVolume() - Method in class io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters
 
getCaptureTimeMs() - Method in class io.agora.rtc2.video.EncodedVideoFrameInfo
 
getCcMode() - Method in class io.agora.rtc2.EncodedVideoTrackOptions
 
getChannel() - Method in class io.agora.rtc2.audio.AudioParams
 
getChannelName() - Method in class io.agora.rtc2.video.ChannelMediaInfo
 
getChannelNums() - Method in class io.agora.base.AudioFrame
 
getChannelProfile() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getChannelProfile() - Method in class io.agora.rtc2.RtcEngineConfig
 
getChannels() - Method in class io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters
 
getClientRoleType() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getCodecName() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
getCodecType() - Method in class io.agora.rtc2.EncodedVideoTrackOptions
 
getCodecType() - Method in class io.agora.rtc2.video.EncodedVideoFrameInfo
 
getConfig(int, int) - Method in class io.agora.rtc2.internal.gdp.EglCore
Finds a suitable EGLConfig.
getConnectionState() - Method in class io.agora.rtc2.RtcEngine
 
getConnectionStateEx(RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
getContentHint() - Method in class io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters
 
getContext() - Method in class io.agora.rtc2.RtcEngineConfig
 
getCpuClock() - Method in class io.agora.rtc2.internal.gdp.GDPAndroid
 
getCpuCores() - Method in class io.agora.rtc2.internal.gdp.GDPAndroid
 
getCpuTemperature() - Method in class io.agora.rtc2.internal.gdp.GDPAndroid
 
getCpuVendor() - Method in class io.agora.rtc2.internal.gdp.GDPAndroid
 
getCurrentAgoraCDNIndex() - Method in interface io.agora.mediaplayer.IMediaPlayer
Deprecated.
4.6.0
getCurrentMonotonicTimeInMs() - Method in class io.agora.rtc2.RtcEngine
 
getCurrentPosition() - Method in class io.agora.mediaplayer.AssetsFileReader
 
getCurrentPosition() - Method in class io.agora.mediaplayer.ContentFileReader
 
getCustomVideoTrackId() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getCustomVideoTrackId() - Method in class io.agora.rtc2.DirectCdnStreamingMediaOptions
Deprecated.
 
getDataLength() - Method in class io.agora.rtc2.audio.AudioSpectrumInfo
 
getDecodeTimeMs() - Method in class io.agora.rtc2.video.EncodedVideoFrameInfo
 
getDefaultVideoStreamType() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getDestChannelMediaInfos() - Method in class io.agora.rtc2.video.ChannelMediaRelayConfiguration
 
getDeviceId() - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
 
getDimensionsHeight() - Method in class io.agora.rtc2.SimulcastConfig.StreamLayerConfig
 
getDimensionsHeight() - Method in class io.agora.rtc2.SimulcastStreamConfig
 
getDimensionsWidth() - Method in class io.agora.rtc2.SimulcastConfig.StreamLayerConfig
 
getDimensionsWidth() - Method in class io.agora.rtc2.SimulcastStreamConfig
 
getDomainLimit() - Method in class io.agora.rtc2.RtcEngineConfig
 
getDopplerFlag() - Method in class io.agora.rtc2.SpatialAudioParams
 
getDownlinkMultipathMode() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getDownloadSize() - Method in class io.agora.mediaplayer.data.CacheStatistics
 
getDuration() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
getDuration() - Method in interface io.agora.mediaplayer.IMediaPlayer
 
getEarMonitoringAudioParams() - Method in interface io.agora.rtc2.IAudioFrameObserver
 
getEffectCurrentPosition(int) - Method in class io.agora.rtc2.RtcEngine
 
getEffectDuration(String) - Method in class io.agora.rtc2.RtcEngine
 
getEffectsVolume() - Method in interface io.agora.rtc2.IAudioEffectManager
Gets the volume of the audio effects.
getEffectsVolume() - Method in class io.agora.rtc2.RtcEngine
 
getEglContextHandler() - Method in class io.agora.mediaplayer.gl.PlayerTextureHelper
 
getEglContextHandler() - Method in interface io.agora.mediaplayer.IPlayerTextureHelper
 
getErrorByValue(int) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
 
getErrorDescription(int) - Static method in class io.agora.rtc2.RtcEngine
 
getEventByValue(int) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
 
getExtensionObserver() - Method in class io.agora.rtc2.RtcEngineConfig
 
getExtensionProperty(String, String, ExtensionInfo, String) - Method in class io.agora.rtc2.RtcEngine
Gets the properties of an extension.
getExtensionProperty(String, String, String) - Method in class io.agora.rtc2.RtcEngine
 
getExtensionProperty(String, String, String, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
 
getFaceShapeAreaOptions(int) - Method in class io.agora.rtc2.RtcEngine
 
getFaceShapeAreaOptions(int, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
 
getFaceShapeBeautyOptions() - Method in class io.agora.rtc2.RtcEngine
 
getFaceShapeBeautyOptions(Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
 
getFakeTextureInfo() - Method in class io.agora.mediaplayer.gl.PlayerTextureHelper
 
getFakeTextureInfo() - Method in interface io.agora.mediaplayer.IPlayerTextureHelper
 
getFilePath() - Method in class io.agora.rtc2.RtcEngineConfig.LogConfig
 
getFileSize() - Method in class io.agora.mediaplayer.AssetsFileReader
 
getFileSize() - Method in class io.agora.mediaplayer.ContentFileReader
 
getFileSize() - Method in class io.agora.mediaplayer.data.CacheStatistics
 
getFileSize() - Method in class io.agora.rtc2.RtcEngineConfig.LogConfig
 
getFormat() - Method in class io.agora.rtc2.video.WatermarkBuffer
 
getForward() - Method in class io.agora.spatialaudio.RemoteVoicePositionInfo
 
getForward() - Method in class io.agora.spatialaudio.SpatialAudioZone
 
getForwardLength() - Method in class io.agora.spatialaudio.SpatialAudioZone
 
getFps() - Method in class io.agora.rtc2.video.CameraCapturerConfiguration.CaptureFormat
 
getFps() - Method in class io.agora.rtc2.video.ImageTrackOptions
 
getFramerate() - Method in class io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters
 
getFramerate() - Method in class io.agora.rtc2.SimulcastConfig.StreamLayerConfig
 
getFramerate() - Method in class io.agora.rtc2.SimulcastStreamConfig
 
getFramesPerSecond() - Method in class io.agora.rtc2.video.EncodedVideoFrameInfo
 
getFrameType() - Method in class io.agora.rtc2.video.EncodedVideoFrameInfo
 
getGpuRenderer() - Method in class io.agora.rtc2.internal.gdp.GDPAndroid
 
getGpuVendor() - Method in class io.agora.rtc2.internal.gdp.GDPAndroid
 
getGreen() - Method in class io.agora.rtc2.live.LiveTranscoding
Deprecated.
Gets the background color's green component.
getH265Transcoder() - Method in class io.agora.rtc2.RtcEngine
get an H265Transcoder instance, which is used to
getHeight() - Method in class io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters
 
getHeight() - Method in class io.agora.rtc2.video.CameraCapturerConfiguration.CaptureFormat
 
getHeight() - Method in class io.agora.rtc2.video.EncodedVideoFrameInfo
 
getHeight() - Method in class io.agora.rtc2.video.WatermarkBuffer
 
getId() - Method in class io.agora.rtc2.video.WatermarkConfig
 
getImageUrl() - Method in class io.agora.rtc2.video.ImageTrackOptions
 
getImageUrl() - Method in class io.agora.rtc2.video.WatermarkConfig
 
getInternalPlayerUuid() - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
 
getIsAudioFilterable() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getLanguage() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
getLevel() - Method in class io.agora.rtc2.RtcEngineConfig.LogConfig
 
getLicense() - Method in class io.agora.rtc2.RtcEngineConfig
 
getLogConfig() - Method in class io.agora.rtc2.RtcEngineConfig
 
getLogUploadServerInfo() - Method in class io.agora.rtc2.proxy.LocalAccessPointConfiguration.AdvancedConfigInfo
 
getMaxCacheFileCount() - Method in interface io.agora.mediaplayer.IMediaPlayerCacheManager
 
getMaxCacheFileSize() - Method in interface io.agora.mediaplayer.IMediaPlayerCacheManager
 
getMaxMetadataSize() - Method in interface io.agora.rtc2.IMetadataObserver
 
getMediaEngineVersion() - Static method in class io.agora.rtc2.RtcEngine
Deprecated.
getMediaPlayerAudioDelayMs() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getMediaPlayerCacheManager() - Method in class io.agora.rtc2.RtcEngine
 
getMediaPlayerId() - Method in interface io.agora.mediaplayer.IMediaPlayer
 
getMediaStreamType() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
getMirrorApplied() - Method in interface io.agora.rtc2.video.IVideoFrameObserver
 
getMirrorMode() - Method in class io.agora.rtc2.video.ImageTrackOptions
 
getMixedAudioParams() - Method in interface io.agora.rtc2.IAudioFrameObserver
 
getMode() - Method in class io.agora.rtc2.audio.AudioParams
 
getMute() - Method in interface io.agora.mediaplayer.IMediaPlayer
 
getName() - Method in class io.agora.mediaplayer.data.SrcInfo
 
getNativeHandle() - Method in class io.agora.rtc2.RtcEngine
 
getNativeLibPath() - Method in class io.agora.rtc2.RtcEngineConfig
 
getNativeMediaPlayer(int) - Method in class io.agora.rtc2.RtcEngine
Returns the native handler of the mediaplayer.
getNetworkType() - Method in class io.agora.rtc2.RtcEngine
 
getNtpWallTimeInMs() - Method in class io.agora.rtc2.RtcEngine
 
getObservedAudioFramePosition() - Method in interface io.agora.rtc2.IAudioFrameObserver
 
getObservedFramePosition() - Method in interface io.agora.rtc2.video.IVideoFrameObserver
 
getOptions() - Method in class io.agora.rtc2.video.WatermarkConfig
 
getOsVersion() - Method in class io.agora.rtc2.internal.gdp.GDPAndroid
 
getParameter(String, String) - Method in class io.agora.rtc2.RtcEngine
Gets the Agora SDK’s parameters for customization purposes.
getParameters() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getParameters(String) - Method in class io.agora.rtc2.RtcEngine
Queries internal states
getPlaybackAudioParams() - Method in interface io.agora.rtc2.IAudioFrameObserver
 
getPlayoutVolume() - Method in interface io.agora.mediaplayer.IMediaPlayer
 
getPlayPosition() - Method in interface io.agora.mediaplayer.IMediaPlayer
 
getPlaySrc() - Method in interface io.agora.mediaplayer.IMediaPlayer
 
getPosition() - Method in class io.agora.spatialaudio.RemoteVoicePositionInfo
 
getPosition() - Method in class io.agora.spatialaudio.SpatialAudioZone
 
getPositionInLandscapeMode() - Method in class io.agora.rtc2.video.WatermarkOptions
 
getPositionInPortraitMode() - Method in class io.agora.rtc2.video.WatermarkOptions
 
getPreferMultipathType() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getProvider() - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
getPublishCustomAudioTrackId() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getPublishMediaPlayerId() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getPublishMediaPlayerId() - Method in class io.agora.rtc2.DirectCdnStreamingMediaOptions
Deprecated.
 
getPublishRhythmPlayerTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getPublishSignalVolume() - Method in interface io.agora.mediaplayer.IMediaPlayer
 
getRam() - Method in class io.agora.rtc2.internal.gdp.GDPAndroid
 
getRecommendedEncoderType() - Static method in class io.agora.rtc2.RtcEngine
Deprecated.
This method is deprecated.
getRecordAudioParams() - Method in interface io.agora.rtc2.IAudioFrameObserver
 
getRed() - Method in class io.agora.rtc2.live.LiveTranscoding
Deprecated.
Gets the background color's red component.
getRenderGlSurface() - Method in class io.agora.mediaplayer.gl.PlayerTextureHelper
 
getRenderGlSurface() - Method in interface io.agora.mediaplayer.IPlayerTextureHelper
 
getRight() - Method in class io.agora.spatialaudio.SpatialAudioZone
 
getRightLength() - Method in class io.agora.spatialaudio.SpatialAudioZone
 
getRotation() - Method in class io.agora.rtc2.video.EncodedVideoFrameInfo
 
getRotationApplied() - Method in interface io.agora.rtc2.video.IVideoFrameObserver
 
getSampleRataHz() - Method in class io.agora.base.AudioFrame
 
getSampleRate() - Method in class io.agora.rtc2.audio.AudioParams
 
getSampleRate() - Method in class io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters
 
getSamplesPerCall() - Method in class io.agora.rtc2.audio.AudioParams
 
getSamplesPerChannel() - Method in class io.agora.base.AudioFrame
 
getSdkVersion() - Static method in class io.agora.rtc2.RtcEngine
 
getServerDomain() - Method in class io.agora.rtc2.proxy.LocalAccessPointConfiguration.LogUploadServerInfo
 
getServerHttps() - Method in class io.agora.rtc2.proxy.LocalAccessPointConfiguration.LogUploadServerInfo
 
getServerPath() - Method in class io.agora.rtc2.proxy.LocalAccessPointConfiguration.LogUploadServerInfo
 
getServerPort() - Method in class io.agora.rtc2.proxy.LocalAccessPointConfiguration.LogUploadServerInfo
 
getSocName() - Static method in class io.agora.rtc2.internal.gdp.GDPAndroid
 
getSpeakerAttenuation() - Method in class io.agora.rtc2.SpatialAudioParams
get speaker attenuation
getSpeakerAzimuth() - Method in class io.agora.rtc2.SpatialAudioParams
get speaker azimuth
getSpeakerDistance() - Method in class io.agora.rtc2.SpatialAudioParams
get speaker distance
getSpeakerElevation() - Method in class io.agora.rtc2.SpatialAudioParams
get speaker elevation
getSpeakerOrientation() - Method in class io.agora.rtc2.SpatialAudioParams
get speaker orientation
getSrcChannelMediaInfo() - Method in class io.agora.rtc2.video.ChannelMediaRelayConfiguration
 
getStartPos() - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
getState() - Method in interface io.agora.mediaplayer.IMediaPlayer
 
getStateByValue(int) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerState
 
getStreamCount() - Method in interface io.agora.mediaplayer.IMediaPlayer
 
getStreamIndex() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
getStreamInfo(int) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
getStreamType() - Method in class io.agora.rtc2.video.EncodedVideoFrameInfo
 
getStreamType() - Method in class io.agora.rtc2.video.VideoSubscriptionOptions
 
getTargetBitrate() - Method in class io.agora.rtc2.EncodedVideoTrackOptions
 
getThreadPriority() - Method in class io.agora.rtc2.RtcEngineConfig
 
getTimestamp() - Method in class io.agora.base.AudioFrame
 
getToken() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getToken() - Method in class io.agora.rtc2.video.ChannelMediaInfo
 
getTotalBitrate() - Method in class io.agora.mediaplayer.data.PlayerPlaybackStats
 
getTrackId() - Method in class io.agora.rtc2.video.EncodedVideoFrameInfo
 
getType() - Method in class io.agora.rtc2.video.WatermarkConfig
 
getTypeByValue(int) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerMetadataType
 
getTypeByValue(int) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerPreloadEvent
 
getUid() - Method in class io.agora.rtc2.audio.UserAudioSpectrumInfo
 
getUid() - Method in class io.agora.rtc2.video.ChannelMediaInfo
 
getUnknowCPUMax(int) - Static method in class io.agora.rtc2.internal.gdp.GDPAndroid
 
getUp() - Method in class io.agora.spatialaudio.SpatialAudioZone
 
getUpLength() - Method in class io.agora.spatialaudio.SpatialAudioZone
 
getUplinkMultipathMode() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getUri() - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
getUrl() - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
getUserCount() - Method in class io.agora.rtc2.live.LiveTranscoding
Gets the number of users transcoded in CDN live.
getUserInfoByUid(int, UserInfo) - Method in class io.agora.rtc2.RtcEngine
 
getUserInfoByUidEx(int, UserInfo, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
getUserInfoByUserAccount(String, UserInfo) - Method in class io.agora.rtc2.RtcEngine
 
getUserInfoByUserAccountEx(String, UserInfo, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
getUsers() - Method in class io.agora.rtc2.live.LiveTranscoding
Gets the user list in CDN live.
getValue() - Method in enum class io.agora.rtc2.audio.AdvancedAudioOptions.AudioProcessingChannelsEnum
 
getValue() - Method in enum class io.agora.rtc2.Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY
 
getValue() - Method in enum class io.agora.rtc2.Constants.AUDIO_REVERB_TYPE
 
getValue() - Method in enum class io.agora.rtc2.Constants.AudioSourceType
 
getValue() - Method in enum class io.agora.rtc2.Constants.MEDIA_TRACE_EVENT
 
getValue() - Method in enum class io.agora.rtc2.Constants.MultipathType
 
getValue() - Method in enum class io.agora.rtc2.Constants.StreamFallbackOptions
 
getValue() - Method in enum class io.agora.rtc2.Constants.VideoSourceType
 
getValue() - Method in enum class io.agora.rtc2.Constants.VideoStreamType
 
getValue() - Method in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
 
getValue() - Method in enum class io.agora.rtc2.DirectCdnStreamingReason
Deprecated.
 
getValue() - Method in enum class io.agora.rtc2.DirectCdnStreamingState
Deprecated.
 
getValue() - Method in enum class io.agora.rtc2.IH265TranscoderObserver.H265TranscodeResult
 
getValue() - Method in enum class io.agora.rtc2.IVideoEffectObject.VIDEO_EFFECT_ACTION
 
getValue() - Method in enum class io.agora.rtc2.IVideoEffectObject.VIDEO_EFFECT_NODE_ID
 
getValue() - Method in enum class io.agora.rtc2.SimulcastConfig.StreamLayerIndex
 
getValue() - Method in enum class io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_DIRECTION
 
getValue() - Method in enum class io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE
 
getValue() - Method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.CODEC_CAP_MASK
 
getValue() - Method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.COMPRESSION_PREFERENCE
 
getValue() - Method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.DEGRADATION_PREFERENCE
 
getValue() - Method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.ENCODING_PREFERENCE
 
getValue() - Method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.FRAME_RATE
 
getValue() - Method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.MIRROR_MODE_TYPE
 
getValue() - Method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.ORIENTATION_MODE
 
getValue() - Method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.VIDEO_CODEC_TYPE
 
getValue(Constants.AudioDualMonoMode) - Static method in enum class io.agora.mediaplayer.Constants.AudioDualMonoMode
 
getValue(Constants.MediaPlayerEvent) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
 
getValue(Constants.MediaPlayerMetadataType) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerMetadataType
 
getValue(Constants.MediaPlayerPreloadEvent) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerPreloadEvent
 
getValue(Constants.MediaPlayerReason) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
 
getValue(Constants.MediaPlayerState) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerState
 
getValue(Constants.MediaStreamType) - Static method in enum class io.agora.mediaplayer.Constants.MediaStreamType
 
getValue(Constants.AudioMixingDualMonoMode) - Static method in enum class io.agora.rtc2.Constants.AudioMixingDualMonoMode
 
getValue(Constants.AudioProfile) - Static method in enum class io.agora.rtc2.Constants.AudioProfile
 
getValue(Constants.AudioScenario) - Static method in enum class io.agora.rtc2.Constants.AudioScenario
 
getValue(Constants.AudioSourceType) - Static method in enum class io.agora.rtc2.Constants.AudioSourceType
 
getValue(Constants.AudioTrackType) - Static method in enum class io.agora.rtc2.Constants.AudioTrackType
 
getValue(Constants.BytesPerSample) - Static method in enum class io.agora.rtc2.Constants.BytesPerSample
 
getValue(Constants.ExternalVideoSourceType) - Static method in enum class io.agora.rtc2.Constants.ExternalVideoSourceType
 
getValue(Constants.LogLevel) - Static method in enum class io.agora.rtc2.Constants.LogLevel
 
getValue(Constants.MediaSourceType) - Static method in enum class io.agora.rtc2.Constants.MediaSourceType
 
getValue(Constants.MediaType) - Static method in enum class io.agora.rtc2.Constants.MediaType
 
getValue(Constants.MultipathMode) - Static method in enum class io.agora.rtc2.Constants.MultipathMode
 
getValue(Constants.QoEPreference) - Static method in enum class io.agora.rtc2.Constants.QoEPreference
 
getValue(Constants.RenewTokenErrorCode) - Static method in enum class io.agora.rtc2.Constants.RenewTokenErrorCode
 
getValue(Constants.ScreenScenarioType) - Static method in enum class io.agora.rtc2.Constants.ScreenScenarioType
 
getValue(Constants.SimulcastStreamMode) - Static method in enum class io.agora.rtc2.Constants.SimulcastStreamMode
 
getValue(Constants.ThreadPriorityType) - Static method in enum class io.agora.rtc2.Constants.ThreadPriorityType
 
getValue(Constants.VIDEO_MODULE_TYPE) - Static method in enum class io.agora.rtc2.Constants.VIDEO_MODULE_TYPE
 
getValue(Constants.VideoModulePosition) - Static method in enum class io.agora.rtc2.Constants.VideoModulePosition
 
getValue(Constants.VideoScenario) - Static method in enum class io.agora.rtc2.Constants.VideoScenario
 
getValue(Constants.VideoSourceType) - Static method in enum class io.agora.rtc2.Constants.VideoSourceType
 
getValue(LiveInjectStreamConfig.AudioSampleRateType) - Static method in enum class io.agora.rtc2.live.LiveInjectStreamConfig.AudioSampleRateType
 
getValue(LiveTranscoding.AudioCodecProfileType) - Static method in enum class io.agora.rtc2.live.LiveTranscoding.AudioCodecProfileType
 
getValue(LiveTranscoding.AudioSampleRateType) - Static method in enum class io.agora.rtc2.live.LiveTranscoding.AudioSampleRateType
 
getValue(LiveTranscoding.VideoCodecProfileType) - Static method in enum class io.agora.rtc2.live.LiveTranscoding.VideoCodecProfileType
 
getValue(LiveTranscoding.VideoCodecType) - Static method in enum class io.agora.rtc2.live.LiveTranscoding.VideoCodecType
 
getValue(RtcConnection.CONNECTION_STATE_TYPE) - Static method in enum class io.agora.rtc2.RtcConnection.CONNECTION_STATE_TYPE
 
getVideoBitrate() - Method in class io.agora.mediaplayer.data.PlayerPlaybackStats
 
getVideoBitRate() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
getVideoCaptureParameters() - Method in class io.agora.rtc2.ScreenCaptureParameters
 
getVideoEffectBoolParam(String, String) - Method in interface io.agora.rtc2.IVideoEffectObject
 
getVideoEffectFloatParam(String, String) - Method in interface io.agora.rtc2.IVideoEffectObject
 
getVideoEffectIntParam(String, String) - Method in interface io.agora.rtc2.IVideoEffectObject
 
getVideoFormatPreference() - Method in interface io.agora.rtc2.video.IVideoFrameObserver
 
getVideoFps() - Method in class io.agora.mediaplayer.data.PlayerPlaybackStats
 
getVideoFrameProcessMode() - Method in interface io.agora.rtc2.video.IVideoFrameObserver
 
getVideoFrameRate() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
getVideoHeight() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
getVideoHeight() - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
 
getVideoRotation() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
getVideoWidth() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
getVideoWidth() - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
 
getVolumeOfEffect(int) - Method in class io.agora.rtc2.RtcEngine
 
getWatermarkList() - Method in class io.agora.rtc2.live.LiveTranscoding
get object attribute of watermarkList
getWidth() - Method in class io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters
 
getWidth() - Method in class io.agora.rtc2.video.CameraCapturerConfiguration.CaptureFormat
 
getWidth() - Method in class io.agora.rtc2.video.EncodedVideoFrameInfo
 
getWidth() - Method in class io.agora.rtc2.video.WatermarkBuffer
 
getZoneSetId() - Method in class io.agora.spatialaudio.SpatialAudioZone
 
getzOrder() - Method in class io.agora.rtc2.video.WatermarkOptions
 
GOOD - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.Quality
Deprecated.
 
greenCapacity - Variable in class io.agora.rtc2.video.SegmentationProperty
The accuracy range for recognizing background colors in the image.

H

H264 - Enum constant in enum class io.agora.rtc2.live.LiveTranscoding.VideoCodecType
1: (Default) H.264.
H265 - Enum constant in enum class io.agora.rtc2.live.LiveTranscoding.VideoCodecType
2: H.265.
HARDWARE_ENCODER - Static variable in class io.agora.rtc2.Constants
Hardware encoder.
HE_AAC - Enum constant in enum class io.agora.rtc2.live.LiveTranscoding.AudioCodecProfileType
1: HE-AAC.
HE_AAC_V2 - Enum constant in enum class io.agora.rtc2.live.LiveTranscoding.AudioCodecProfileType
2: HE-AAC v2.
HEADPHONE_EQUALIZER_INEAR - Static variable in class io.agora.rtc2.Constants
For in-ear headphones.
HEADPHONE_EQUALIZER_OFF - Static variable in class io.agora.rtc2.Constants
Turn off headphone EQ and use the original voice.
HEADPHONE_EQUALIZER_OVEREAR - Static variable in class io.agora.rtc2.Constants
For over-ear headphones.
height - Variable in class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
Height (px) of the recorded video.
height - Variable in class io.agora.rtc2.IRtcEngineEventHandler.AgoraFacePositionInfo
The height (px) of the human face in the captured video.
height - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
The height (pixels) of the video.
height - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayout
Heitht (px) of the sub-video stream.
height - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayoutInfo
The height of the mixed video stream (px).
height - Variable in class io.agora.rtc2.live.LiveInjectStreamConfig
 
height - Variable in class io.agora.rtc2.live.LiveTranscoding
The height of the video in pixels.
height - Variable in class io.agora.rtc2.live.LiveTranscoding.TranscodingUser
The height (pixel) of the host's video.
height - Variable in class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
The height (px) of the video for local video mixing on the canvas.
height - Variable in class io.agora.rtc2.PublisherParameters
Deprecated.
 
height - Variable in class io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters
The height (px) of the video encoding resolution.
height - Variable in class io.agora.rtc2.video.AgoraImage
The height (px) of the image on the video frame.
height - Variable in class io.agora.rtc2.video.AgoraVideoFrame
Height of the incoming video frame.
height - Variable in class io.agora.rtc2.video.CameraCapturerConfiguration.CaptureFormat
The height (px) of the video frame.
height - Variable in class io.agora.rtc2.video.EncodedVideoFrameInfo
Height (pixel) of the video frame.
height - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Canvas
Deprecated.
 
height - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
height - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration.VideoDimensions
The height (pixels) of the video.
height - Variable in class io.agora.rtc2.video.WatermarkBuffer
Height of the watermark buffer, in pixels.
height - Variable in class io.agora.rtc2.video.WatermarkOptions.Rectangle
The height of the target area.
HIGH - Enum constant in enum class io.agora.rtc2.Constants.ThreadPriorityType
3: High priority.
HIGH - Enum constant in enum class io.agora.rtc2.live.LiveTranscoding.VideoCodecProfileType
100: (Default) High video codec profile; generally used in high-resolution live streaming or television.
HIGHEST - Enum constant in enum class io.agora.rtc2.Constants.ThreadPriorityType
4.
hwDecodingLevel - Variable in class io.agora.rtc2.video.CodecCapLevels
Hardware decoding capability level, which represents the device's ability to perform hardware decoding on videos of different quality.
hwEncoderAccelerating - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The local video encoding acceleration type.

I

IAudioEffectManager - Interface in io.agora.rtc2
 
IAudioEncodedFrameObserver - Interface in io.agora.rtc2
 
IAudioFrameObserver - Interface in io.agora.rtc2
The IAudioFrameObserver interface.
IAudioSpectrumObserver - Interface in io.agora.rtc2.audio
The IAudioSpectrumObserver interface.
IBaseSpatialAudioEngine - Class in io.agora.spatialaudio
 
IBaseSpatialAudioEngine() - Constructor for class io.agora.spatialaudio.IBaseSpatialAudioEngine
 
id - Variable in class io.agora.rtc2.video.WatermarkConfig
Unique identifier for the watermark, usually generated using UUID.
IDENTITY_MATRIX - Static variable in class io.agora.mediaplayer.gl.PlayerTextureHelper
 
IDirectCdnStreamingEventHandler - Interface in io.agora.rtc2
Deprecated.
v4.6.0.
IDLE - Enum constant in enum class io.agora.rtc2.DirectCdnStreamingState
Deprecated.
0: The initial state before the CDN streaming starts.
IFaceInfoObserver - Interface in io.agora.rtc2.video
The IVideoEncodedFrameObserver interface.
IH265Transcoder - Interface in io.agora.rtc2
The IH265Transcoder interface.
IH265TranscoderObserver - Interface in io.agora.rtc2
The IH265TranscoderObserver interface.
IH265TranscoderObserver.H265TranscodeResult - Enum Class in io.agora.rtc2
The result of IH265Transcoder interface invoking.
ILocalSpatialAudioEngine - Class in io.agora.spatialaudio
 
ILocalSpatialAudioEngine() - Constructor for class io.agora.spatialaudio.ILocalSpatialAudioEngine
 
ImageTrackOptions - Class in io.agora.rtc2.video
 
ImageTrackOptions(String, int) - Constructor for class io.agora.rtc2.video.ImageTrackOptions
 
ImageTrackOptions(String, int, VideoEncoderConfiguration.MIRROR_MODE_TYPE) - Constructor for class io.agora.rtc2.video.ImageTrackOptions
 
imageUrl - Variable in class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
The file path of local images.
imageUrl - Variable in class io.agora.rtc2.video.WatermarkConfig
URL address used to load the watermark image.
IMediaExtensionObserver - Interface in io.agora.rtc2
 
IMediaPlayer - Interface in io.agora.mediaplayer
 
IMediaPlayerAudioFrameObserver - Interface in io.agora.mediaplayer
 
IMediaPlayerCacheManager - Interface in io.agora.mediaplayer
 
IMediaPlayerCustomDataProvider - Interface in io.agora.mediaplayer
 
IMediaPlayerObserver - Interface in io.agora.mediaplayer
 
IMediaPlayerVideoFrameObserver - Interface in io.agora.mediaplayer
 
IMediaRecorderCallback - Interface in io.agora.rtc2
The `IMediaRecorderCallback` interface.
IMetadataObserver - Interface in io.agora.rtc2
The definition of IMetadataObserver.
init() - Static method in class io.agora.rtc2.internal.gdp.GDPAndroid
 
initialize(LocalSpatialAudioConfig) - Method in class io.agora.spatialaudio.ILocalSpatialAudioEngine
 
INJECT_STREAM_STATUS_BROKEN - Static variable in class io.agora.rtc2.Constants
The external video stream is broken.
INJECT_STREAM_STATUS_START_ALREADY_EXISTS - Static variable in class io.agora.rtc2.Constants
The external video stream already exists.
INJECT_STREAM_STATUS_START_FAILED - Static variable in class io.agora.rtc2.Constants
The external video stream failed to import.
INJECT_STREAM_STATUS_START_SUCCESS - Static variable in class io.agora.rtc2.Constants
The external video stream imported successfully.
INJECT_STREAM_STATUS_START_TIMEDOUT - Static variable in class io.agora.rtc2.Constants
Import external video stream timeout.
INJECT_STREAM_STATUS_START_UNAUTHORIZED - Static variable in class io.agora.rtc2.Constants
The external video stream import is unauthorized
INJECT_STREAM_STATUS_STOP_FAILED - Static variable in class io.agora.rtc2.Constants
Importing the external video stream failed.
INJECT_STREAM_STATUS_STOP_NOT_FOUND - Static variable in class io.agora.rtc2.Constants
No external video stream is found.
INJECT_STREAM_STATUS_STOP_SUCCESS - Static variable in class io.agora.rtc2.Constants
The xternal video stream imports successfully.
INJECT_STREAM_STATUS_STOP_TIMEDOUT - Static variable in class io.agora.rtc2.Constants
Importing the external video stream timeout.
INJECT_STREAM_STATUS_STOP_UNAUTHORIZED - Static variable in class io.agora.rtc2.Constants
The external video stream is stopped from being unauthorized.
injectStream(String, int, int) - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
Sets the inject stream.
injectStreamHeight - Variable in class io.agora.rtc2.PublisherParameters
Deprecated.
 
injectStreamUrl - Variable in class io.agora.rtc2.PublisherParameters
Deprecated.
 
injectStreamWidth - Variable in class io.agora.rtc2.PublisherParameters
Deprecated.
 
internalCodec - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalAudioStats
The internal payload codec.
internalPlayerUuid - Variable in class io.agora.mediaplayer.data.PlayerUpdatedInfo
 
interval - Variable in class io.agora.rtc2.video.ContentInspectConfig.ContentInspectModule
The frequency (s) of video screenshot and upload.
intervalInSeconds - Variable in class io.agora.rtc2.EchoTestConfiguration
Set the time interval or delay for returning the results of the audio and video loop test.
io.agora.base - package io.agora.base
 
io.agora.mediaplayer - package io.agora.mediaplayer
 
io.agora.mediaplayer.data - package io.agora.mediaplayer.data
 
io.agora.mediaplayer.gl - package io.agora.mediaplayer.gl
 
io.agora.rtc2 - package io.agora.rtc2
 
io.agora.rtc2.audio - package io.agora.rtc2.audio
 
io.agora.rtc2.internal.gdp - package io.agora.rtc2.internal.gdp
 
io.agora.rtc2.live - package io.agora.rtc2.live
 
io.agora.rtc2.proxy - package io.agora.rtc2.proxy
 
io.agora.rtc2.video - package io.agora.rtc2.video
 
io.agora.spatialaudio - package io.agora.spatialaudio
 
IPlayerTextureHelper - Interface in io.agora.mediaplayer
 
ipList - Variable in class io.agora.rtc2.proxy.LocalAccessPointConfiguration
The list of internal IP addresses for the Local Access Point.
IRtcEngineEventHandler - Class in io.agora.rtc2
Callback methods.
IRtcEngineEventHandler() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler
 
IRtcEngineEventHandler.AgoraFacePositionInfo - Class in io.agora.rtc2
 
IRtcEngineEventHandler.AudioVolumeInfo - Class in io.agora.rtc2
 
IRtcEngineEventHandler.ClientRole - Class in io.agora.rtc2
Deprecated.
Use the new Constants class with the same constants value
IRtcEngineEventHandler.DownlinkNetworkInfo - Class in io.agora.rtc2
The statistics of the downlink network info.
IRtcEngineEventHandler.ErrorCode - Class in io.agora.rtc2
The error codes.
IRtcEngineEventHandler.LastmileProbeResult - Class in io.agora.rtc2
 
IRtcEngineEventHandler.LastmileProbeResult.LastmileProbeOneWayResult - Class in io.agora.rtc2
 
IRtcEngineEventHandler.LocalAudioStats - Class in io.agora.rtc2
 
IRtcEngineEventHandler.LocalVideoStats - Class in io.agora.rtc2
 
IRtcEngineEventHandler.MultipathStats - Class in io.agora.rtc2
 
IRtcEngineEventHandler.PathStats - Class in io.agora.rtc2
 
IRtcEngineEventHandler.Quality - Class in io.agora.rtc2
Deprecated.
Use the new Constants class with the same constants value
IRtcEngineEventHandler.RemoteAudioStats - Class in io.agora.rtc2
 
IRtcEngineEventHandler.RemoteVideoStats - Class in io.agora.rtc2
 
IRtcEngineEventHandler.RtcStats - Class in io.agora.rtc2
 
IRtcEngineEventHandler.UplinkNetworkInfo - Class in io.agora.rtc2
 
IRtcEngineEventHandler.UserOfflineReason - Class in io.agora.rtc2
Deprecated.
Use the new Constants class with the same constants value
IRtcEngineEventHandler.VideoLayout - Class in io.agora.rtc2
 
IRtcEngineEventHandler.VideoLayoutInfo - Class in io.agora.rtc2
 
IRtcEngineEventHandler.VideoProfile - Class in io.agora.rtc2
Deprecated.
Use the new Constants class with the same constants value
IRtcEngineEventHandler.VideoRenderingTracingInfo - Class in io.agora.rtc2
 
IRtcEngineEventHandler.WarnCode - Class in io.agora.rtc2
The warning code.
IRtcEngineReleaseCallback - Interface in io.agora.rtc2
 
isAgoraSource() - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
isAudioFilterable - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether the audio stream being published is filtered according to the volume algorithm: - `true`: The audio stream is filtered.
isAutoPlay() - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
isAutoSubscribeAudio() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isAutoSubscribeVideo() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isCameraAutoFocusFaceModeSupported() - Method in class io.agora.rtc2.RtcEngine
 
isCameraExposurePositionSupported() - Method in class io.agora.rtc2.RtcEngine
 
isCameraExposureSupported() - Method in class io.agora.rtc2.RtcEngine
 
isCameraFaceDetectSupported() - Method in class io.agora.rtc2.RtcEngine
 
isCameraFocusSupported() - Method in class io.agora.rtc2.RtcEngine
 
isCameraTorchSupported() - Method in class io.agora.rtc2.RtcEngine
 
isCameraZoomSupported() - Method in class io.agora.rtc2.RtcEngine
 
isCaptureAudio() - Method in class io.agora.rtc2.ScreenCaptureParameters
 
isCaptureVideo() - Method in class io.agora.rtc2.ScreenCaptureParameters
 
isEnableAudioRecordingOrPlayout() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isEnableBuiltInMediaEncryption() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isEnableCache() - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
isEnabled() - Method in class io.agora.rtc2.SimulcastConfig.StreamLayerConfig
 
isEnableMultiAudioTrack() - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
isEnableMultipath() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isEncodedFrameOnly() - Method in class io.agora.rtc2.video.VideoSubscriptionOptions
 
isFeatureAvailableOnDevice(int) - Method in class io.agora.rtc2.RtcEngine
 
isFollowEncodeDimensionRatio() - Method in class io.agora.rtc2.video.CameraCapturerConfiguration
 
isInteractiveAudience - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to enable interactive mode: - `true`: Enable interactive mode.
isInteractiveAudience() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isLiveSource() - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
isLowLatencyAudioSupported - Variable in class io.agora.rtc2.DeviceInfo
Whether the audio device supports ultra-low-latency capture and playback: - `true`: The device supports ultra-low-latency capture and playback.
isPublishCameraTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishCameraTrack() - Method in class io.agora.rtc2.DirectCdnStreamingMediaOptions
Deprecated.
 
isPublishCustomAudioTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishCustomAudioTrack() - Method in class io.agora.rtc2.DirectCdnStreamingMediaOptions
Deprecated.
 
isPublishCustomVideoTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishCustomVideoTrack() - Method in class io.agora.rtc2.DirectCdnStreamingMediaOptions
Deprecated.
 
isPublishEncodedVideoTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishFourthCameraTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishLipSyncTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishMediaPlayerAudioTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishMediaPlayerAudioTrack() - Method in class io.agora.rtc2.DirectCdnStreamingMediaOptions
Deprecated.
 
isPublishMediaPlayerVideoTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishMicrophoneTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishMicrophoneTrack() - Method in class io.agora.rtc2.DirectCdnStreamingMediaOptions
Deprecated.
 
isPublishMixedAudioTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishScreenCaptureAudio() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishScreenCaptureVideo() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishSecondaryCameraTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishThirdCameraTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishTranscodedVideoTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isScreenSupportHdrVision() - Method in class io.agora.rtc2.internal.gdp.GDPAndroid
 
isSpeakerphoneEnabled() - Method in class io.agora.rtc2.RtcEngine
 
isStartPreview() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isStopAllEffect() - Method in class io.agora.rtc2.LeaveChannelOptions
 
isStopAudioMixing() - Method in class io.agora.rtc2.LeaveChannelOptions
 
isStopMicrophoneRecording() - Method in class io.agora.rtc2.LeaveChannelOptions
 
isTextureEncodeSupported() - Method in class io.agora.rtc2.RtcEngine
 
isValid - Variable in class io.agora.rtc2.ExtensionContext
Whether the `uid` in `ExtensionContext` is valid: - `true`: The `uid` is valid.
isValidColor(String) - Static method in class io.agora.rtc2.video.VideoCompositingLayout
Deprecated.
 
isVisibleInPreview() - Method in class io.agora.rtc2.video.WatermarkOptions
 
IVideoEffectObject - Interface in io.agora.rtc2
 
IVideoEffectObject.VIDEO_EFFECT_ACTION - Enum Class in io.agora.rtc2
 
IVideoEffectObject.VIDEO_EFFECT_NODE_ID - Enum Class in io.agora.rtc2
 
IVideoEncodedFrameObserver - Interface in io.agora.rtc2.video
The IVideoEncodedFrameObserver interface.
IVideoFrameObserver - Interface in io.agora.rtc2.video
 

J

jitter - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LastmileProbeResult.LastmileProbeOneWayResult
The network jitter (ms).
jitterBufferDelay - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
The network delay (ms) from the audio receiver to the jitter buffer.
join2JoinSuccess - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoRenderingTracingInfo
The time interval (ms) from `joinChannel(String token, String channelId, String optionalInfo, int uid)` or `joinChannel(String token, String channelId, int uid, ChannelMediaOptions options)` to successfully joining the channel.
joinChannel(String, String, int, ChannelMediaOptions) - Method in class io.agora.rtc2.RtcEngine
 
joinChannel(String, String, String, int) - Method in class io.agora.rtc2.RtcEngine
 
joinChannelEx(String, RtcConnection, ChannelMediaOptions, IRtcEngineEventHandler) - Method in class io.agora.rtc2.RtcEngineEx
 
joinChannelWithUserAccount(String, String, String) - Method in class io.agora.rtc2.RtcEngine
 
joinChannelWithUserAccount(String, String, String, ChannelMediaOptions) - Method in class io.agora.rtc2.RtcEngine
 
joinChannelWithUserAccountEx(String, String, String, ChannelMediaOptions, IRtcEngineEventHandler) - Method in class io.agora.rtc2.RtcEngineEx
 
joinSuccess2RemoteJoined - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoRenderingTracingInfo
- If the local user calls `startMediaRenderingTracing` before successfully joining the channel, this value is the time interval (ms) from the local user successfully joining the channel to the remote user joining the channel.

L

lanAccelerateState - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The local network acceleration state.
lanRxBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.MultipathStats
The total number of bytes received over LAN.
lanTxBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.MultipathStats
The total number of bytes sent over LAN.
lastmile_buffer_delay_time_ms - Variable in class io.agora.rtc2.IRtcEngineEventHandler.DownlinkNetworkInfo
The lastmile buffer delay time in ms.
LASTMILE_PROBE_RESULT_COMPLETE - Static variable in class io.agora.rtc2.Constants
1: The last-mile probe result is complete.
LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE - Static variable in class io.agora.rtc2.Constants
2: The last-mile network probe test is incomplete and the bandwidth estimation is not available, probably due to limited test resources.
LASTMILE_PROBE_RESULT_UNAVAILABLE - Static variable in class io.agora.rtc2.Constants
3: The last-mile network probe test is not carried out, probably due to poor network conditions.
lastmileDelay - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The client-to-server delay (milliseconds).
LastmileProbeOneWayResult() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.LastmileProbeResult.LastmileProbeOneWayResult
 
LastmileProbeResult() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.LastmileProbeResult
 
layoutCount - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayoutInfo
The number of layout information in the mixed video stream.
layoutList - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayoutInfo
The detailed layout information of a mixed video stream.
LC_AAC - Enum constant in enum class io.agora.rtc2.live.LiveTranscoding.AudioCodecProfileType
0: (Default) LC-AAC.
leaveChannel() - Method in class io.agora.rtc2.RtcEngine
 
leaveChannel(LeaveChannelOptions) - Method in class io.agora.rtc2.RtcEngine
 
leaveChannelEx(RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
leaveChannelEx(RtcConnection, LeaveChannelOptions) - Method in class io.agora.rtc2.RtcEngineEx
 
LeaveChannelOptions - Class in io.agora.rtc2
 
LeaveChannelOptions() - Constructor for class io.agora.rtc2.LeaveChannelOptions
 
leaveChannelWithUserAccountEx(String, String) - Method in class io.agora.rtc2.RtcEngineEx
 
leaveChannelWithUserAccountEx(String, String, LeaveChannelOptions) - Method in class io.agora.rtc2.RtcEngineEx
Leaves a channel with the channel ID and user account and sets the options for leaving.
level - Variable in class io.agora.rtc2.RtcEngineConfig.LogConfig
The output level of the SDK log file.
LICENSE_ERR_DIFF_DEVICES - Static variable in class io.agora.rtc2.Constants
5: Same license used in different devices at the same time
LICENSE_ERR_EXPIRE - Static variable in class io.agora.rtc2.Constants
2: License expired
LICENSE_ERR_INTERNAL - Static variable in class io.agora.rtc2.Constants
99: SDK internal error
LICENSE_ERR_INVALID - Static variable in class io.agora.rtc2.Constants
1: Invalid license
LICENSE_ERR_LIMITED_PERIOD - Static variable in class io.agora.rtc2.Constants
4: License use in limited period
LICENSE_ERR_MINUTES_EXCEED - Static variable in class io.agora.rtc2.Constants
3: Exceed license minutes limit
lifecycle - Variable in class io.agora.rtc2.PublisherParameters
Deprecated.
 
LIGHTENING_CONTRAST_HIGH - Static variable in class io.agora.rtc2.video.BeautyOptions
2: high contrast for lightening.
LIGHTENING_CONTRAST_LOW - Static variable in class io.agora.rtc2.video.BeautyOptions
0: low contrast for lightening.
LIGHTENING_CONTRAST_NORMAL - Static variable in class io.agora.rtc2.video.BeautyOptions
1: normal contrast for lightening.
lighteningContrastLevel - Variable in class io.agora.rtc2.video.BeautyOptions
The contrast level, used with the `lighteningLevel` parameter.
lighteningLevel - Variable in class io.agora.rtc2.video.BeautyOptions
The brightening level, in the range [0.0,1.0], where 0.0 means the original brightening.
LiveInjectStreamConfig - Class in io.agora.rtc2.live
 
LiveInjectStreamConfig() - Constructor for class io.agora.rtc2.live.LiveInjectStreamConfig
 
LiveInjectStreamConfig.AudioSampleRateType - Enum Class in io.agora.rtc2.live
 
LiveTranscoding - Class in io.agora.rtc2.live
 
LiveTranscoding() - Constructor for class io.agora.rtc2.live.LiveTranscoding
 
LiveTranscoding.AudioCodecProfileType - Enum Class in io.agora.rtc2.live
 
LiveTranscoding.AudioSampleRateType - Enum Class in io.agora.rtc2.live
Audio sample rate (Hz).
LiveTranscoding.TranscodingUser - Class in io.agora.rtc2.live
 
LiveTranscoding.VideoCodecProfileType - Enum Class in io.agora.rtc2.live
 
LiveTranscoding.VideoCodecType - Enum Class in io.agora.rtc2.live
 
loadExtensionProvider(String) - Method in class io.agora.rtc2.RtcEngine
 
LOCAL_AUDIO_STREAM_REASON_CAPTURE_FAILURE - Static variable in class io.agora.rtc2.Constants
4: The local audio capture failed.
LOCAL_AUDIO_STREAM_REASON_DEVICE_BUSY - Static variable in class io.agora.rtc2.Constants
3: The microphone is in use.
LOCAL_AUDIO_STREAM_REASON_DEVICE_NO_PERMISSION - Static variable in class io.agora.rtc2.Constants
2: No permission to use the local audio device.
LOCAL_AUDIO_STREAM_REASON_ENCODE_FAILURE - Static variable in class io.agora.rtc2.Constants
5: The local audio encoding fails.
LOCAL_AUDIO_STREAM_REASON_FAILURE - Static variable in class io.agora.rtc2.Constants
1: No specified reason for the local audio failure.
LOCAL_AUDIO_STREAM_REASON_INTERRUPTED - Static variable in class io.agora.rtc2.Constants
8: The local audio capturing is interrupted by the system call.
LOCAL_AUDIO_STREAM_REASON_OK - Static variable in class io.agora.rtc2.Constants
0: The local audio is normal.
LOCAL_AUDIO_STREAM_STATE_ENCODING - Static variable in class io.agora.rtc2.Constants
2: The first audio frame is successfully encoded.
LOCAL_AUDIO_STREAM_STATE_FAILED - Static variable in class io.agora.rtc2.Constants
3: The local audio fails to start.
LOCAL_AUDIO_STREAM_STATE_RECORDING - Static variable in class io.agora.rtc2.Constants
1: The capturer starts successfully.
LOCAL_AUDIO_STREAM_STATE_STOPPED - Static variable in class io.agora.rtc2.Constants
0: The local audio is in the initial state.
LOCAL_NETWORK_QUALITY_POOR - Static variable in class io.agora.rtc2.Constants
2: The local user's network quality is poor.
LOCAL_RPOXY_CONNECTIVITY_FIRST - Static variable in class io.agora.rtc2.Constants
0: connectivity first
LOCAL_RPOXY_LOCAL_ONLY - Static variable in class io.agora.rtc2.Constants
1: local only
LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_STOPPED_BY_USER - Static variable in class io.agora.rtc2.Constants
3: The screen capture is stopped by user.
LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_SYSTEM_INTERNAL_ERROR - Static variable in class io.agora.rtc2.Constants
4: An internal error occurs during the screen capture.
LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_WINDOW_HIDDEN - Static variable in class io.agora.rtc2.Constants
1: The screen capture window is hidden.
LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN - Static variable in class io.agora.rtc2.Constants
2: The screen capture window is recovered from hidden.
LOCAL_VIDEO_STREAM_REASON_CAPTURE_FAILURE - Static variable in class io.agora.rtc2.Constants
4: The local video capture fails.
LOCAL_VIDEO_STREAM_REASON_CODEC_NOT_SUPPORT - Static variable in class io.agora.rtc2.Constants
5: The local video encoding fails.
LOCAL_VIDEO_STREAM_REASON_DEVICE_BUSY - Static variable in class io.agora.rtc2.Constants
3: The local video capturer is in use.
LOCAL_VIDEO_STREAM_REASON_DEVICE_FATAL_ERROR - Static variable in class io.agora.rtc2.Constants
15: The device may need to be shut down and restarted to restore camera function, or there may be a persistent hardware problem.
LOCAL_VIDEO_STREAM_REASON_DEVICE_INTERRUPT - Static variable in class io.agora.rtc2.Constants
14: Video capture was interrupted, possibly due to the camera being occupied or some policy reasons such as background termination.
LOCAL_VIDEO_STREAM_REASON_DEVICE_NO_PERMISSION - Static variable in class io.agora.rtc2.Constants
2: No permission to use the local video device.
LOCAL_VIDEO_STREAM_REASON_DEVICE_NOT_FOUND - Static variable in class io.agora.rtc2.Constants
8: The local video device not found.
LOCAL_VIDEO_STREAM_REASON_FAILURE - Static variable in class io.agora.rtc2.Constants
1: No specified reason for the local video failure.
LOCAL_VIDEO_STREAM_REASON_OK - Static variable in class io.agora.rtc2.Constants
0: The local video is normal.
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_FAILURE - Static variable in class io.agora.rtc2.Constants
21: The local video screen captuere fails, Check whether the mediaProjection is working properly.
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_HIDDEN - Static variable in class io.agora.rtc2.Constants
25: The screen capture window is hidden.
LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN - Static variable in class io.agora.rtc2.Constants
26: The screen capture window is recovered from hidden.
LOCAL_VIDEO_STREAM_STATE_CAPTURING - Static variable in class io.agora.rtc2.Constants
The capturer starts successfully.
LOCAL_VIDEO_STREAM_STATE_ENCODING - Static variable in class io.agora.rtc2.Constants
The first video frame is successfully encoded.
LOCAL_VIDEO_STREAM_STATE_FAILED - Static variable in class io.agora.rtc2.Constants
The local video fails to start.
LOCAL_VIDEO_STREAM_STATE_STOPPED - Static variable in class io.agora.rtc2.Constants
Initial state
LocalAccessPointConfiguration - Class in io.agora.rtc2.proxy
 
LocalAccessPointConfiguration() - Constructor for class io.agora.rtc2.proxy.LocalAccessPointConfiguration
 
LocalAccessPointConfiguration.AdvancedConfigInfo - Class in io.agora.rtc2.proxy
 
LocalAccessPointConfiguration.LogUploadServerInfo - Class in io.agora.rtc2.proxy
 
LocalAudioMixerConfiguration - Class in io.agora.rtc2
 
LocalAudioMixerConfiguration() - Constructor for class io.agora.rtc2.LocalAudioMixerConfiguration
 
LocalAudioMixerConfiguration.MixedAudioStream - Class in io.agora.rtc2
 
LocalAudioStats() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.LocalAudioStats
 
LocalSpatialAudioConfig - Class in io.agora.spatialaudio
 
LocalSpatialAudioConfig() - Constructor for class io.agora.spatialaudio.LocalSpatialAudioConfig
 
LocalTranscoderConfiguration - Class in io.agora.rtc2
 
LocalTranscoderConfiguration() - Constructor for class io.agora.rtc2.LocalTranscoderConfiguration
 
LocalTranscoderConfiguration.TranscodingVideoStream - Class in io.agora.rtc2
 
localUid - Variable in class io.agora.rtc2.ExtensionInfo
User ID: A 32-bit unsigned integer ranging from 1 to (2^32-1).
localUid - Variable in class io.agora.rtc2.RtcConnection
The ID of the local user.
LocalVideoStats() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
 
LOG_FILTER_CRITICAL - Static variable in class io.agora.rtc2.Constants
Output logs of the CRITICAL level.
LOG_FILTER_DEBUG - Static variable in class io.agora.rtc2.Constants
Output all the API logs.
LOG_FILTER_ERROR - Static variable in class io.agora.rtc2.Constants
Output logs of the CRITICAL and ERROR level.
LOG_FILTER_INFO - Static variable in class io.agora.rtc2.Constants
Output logs of the CRITICAL, ERROR, WARNING, and INFO level.
LOG_FILTER_OFF - Static variable in class io.agora.rtc2.Constants
Do not output any log.
LOG_FILTER_WARNING - Static variable in class io.agora.rtc2.Constants
Output logs of the CRITICAL, ERROR, and WARNING level.
LOG_LEVEL_ERROR - Enum constant in enum class io.agora.rtc2.Constants.LogLevel
0x0004: Output `FATAL` and `ERROR` level log information.
LOG_LEVEL_ERROR - Static variable in class io.agora.rtc2.Constants
Output log files of the Error level.
LOG_LEVEL_FATAL - Enum constant in enum class io.agora.rtc2.Constants.LogLevel
0x0008: Output `FATAL` level log information.
LOG_LEVEL_FATAL - Static variable in class io.agora.rtc2.Constants
Output log files of the Critical level.
LOG_LEVEL_INFO - Enum constant in enum class io.agora.rtc2.Constants.LogLevel
0x0001: (Default) Output `FATAL`, `ERROR`, `WARN`, and `INFO` level log information.
LOG_LEVEL_INFO - Static variable in class io.agora.rtc2.Constants
(Recommended) Output log files of the Info level.
LOG_LEVEL_NONE - Enum constant in enum class io.agora.rtc2.Constants.LogLevel
0: Do not output any log information.
LOG_LEVEL_NONE - Static variable in class io.agora.rtc2.Constants
Do not output any log file.
LOG_LEVEL_WARN - Enum constant in enum class io.agora.rtc2.Constants.LogLevel
0x0002: Output `FATAL`, `ERROR`, and `WARN` level log information.
LOG_LEVEL_WARNING - Static variable in class io.agora.rtc2.Constants
Output log files of the Warning level.
LogConfig() - Constructor for class io.agora.rtc2.RtcEngineConfig.LogConfig
 
logUploadServer - Variable in class io.agora.rtc2.proxy.LocalAccessPointConfiguration.AdvancedConfigInfo
Custom log upload server.
LogUploadServerInfo() - Constructor for class io.agora.rtc2.proxy.LocalAccessPointConfiguration.LogUploadServerInfo
 
LogUploadServerInfo(String, String, int, boolean) - Constructor for class io.agora.rtc2.proxy.LocalAccessPointConfiguration.LogUploadServerInfo
 
LOW - Enum constant in enum class io.agora.rtc2.Constants.ThreadPriorityType
1: Low priority.
LOW_LIGHT_ENHANCE_AUTO - Static variable in class io.agora.rtc2.video.LowLightEnhanceOptions
`0`: (Default) Automatic mode.
LOW_LIGHT_ENHANCE_LEVEL_FAST - Static variable in class io.agora.rtc2.video.LowLightEnhanceOptions
`1`: Promotes performance during low-light enhancement.
LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY - Static variable in class io.agora.rtc2.video.LowLightEnhanceOptions
`0`: (Default) Promotes video quality during low-light enhancement.
LOW_LIGHT_ENHANCE_MANUAL - Static variable in class io.agora.rtc2.video.LowLightEnhanceOptions
`1`: Manual mode.
LOWEST - Enum constant in enum class io.agora.rtc2.Constants.ThreadPriorityType
0: Lowest priority.
lowLatency - Variable in class io.agora.rtc2.live.LiveTranscoding
Deprecated.
Deprecated as of v2.8.0. Agora does not recommend using this parameter.
lowlightEnhanceLevel - Variable in class io.agora.rtc2.video.LowLightEnhanceOptions
The low-light enhancement level.
lowlightEnhanceMode - Variable in class io.agora.rtc2.video.LowLightEnhanceOptions
The low-light enhancement mode.
LowLightEnhanceOptions - Class in io.agora.rtc2.video
 
LowLightEnhanceOptions() - Constructor for class io.agora.rtc2.video.LowLightEnhanceOptions
 
LowLightEnhanceOptions(int, int) - Constructor for class io.agora.rtc2.video.LowLightEnhanceOptions
 

M

MAIN - Enum constant in enum class io.agora.rtc2.live.LiveTranscoding.VideoCodecProfileType
77: Main video codec profile; generally used in mainstream electronics such as MP4 players, portable video players, PSP, and iPads.
MAINTAIN_AUTO - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.DEGRADATION_PREFERENCE
-1: (Default) Automatic mode.
MAINTAIN_BALANCED - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.DEGRADATION_PREFERENCE
2: Reduces the video frame rate and video resolution simultaneously during video encoding under limited bandwidth.
MAINTAIN_FRAMERATE - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.DEGRADATION_PREFERENCE
1: Degrade resolution in order to maintain framerate.
MAINTAIN_QUALITY - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.DEGRADATION_PREFERENCE
0: Prefers to reduce the video frame rate while maintaining video resolution during video encoding under limited bandwidth.
MAINTAIN_RESOLUTION - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.DEGRADATION_PREFERENCE
3: Reduces the video frame rate while maintaining the video resolution during video encoding under limited bandwidth.
makeCurrent() - Method in class io.agora.rtc2.internal.gdp.EglSurfaceBase
Makes our EGL context and surface current.
makeCurrent(EGLSurface) - Method in class io.agora.rtc2.internal.gdp.EglCore
Makes our EGL context current, using the supplied surface for both "draw" and "read".
makeQualityReportUrl(String, String, String, int) - Method in class io.agora.rtc2.RtcEngineInternal
 
MakeUpOptions - Class in io.agora.rtc2.video
 
MakeUpOptions() - Constructor for class io.agora.rtc2.video.MakeUpOptions
 
mAppId - Variable in class io.agora.rtc2.RtcEngineConfig
The App ID issued by Agora for your project.
mAreaCode - Variable in class io.agora.rtc2.RtcEngineConfig
The region for connection.
mAudioScenario - Variable in class io.agora.rtc2.RtcEngineConfig
The audio scenarios.
mAutoRegisterAgoraExtensions - Variable in class io.agora.rtc2.RtcEngineConfig
Whether to automatically register the Agora extensions when initializing `RtcEngine`: - `true`: (Default) Automatically register the Agora extensions when initializing `RtcEngine`.
MAX_CONTENT_INSPECT_MODULE_COUNT - Static variable in class io.agora.rtc2.video.ContentInspectConfig
 
maxDurationMs - Variable in class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
Maximum recording duration in milliseconds.
mBlushColor - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mBlushStrength - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mBlushType - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mBrowColor - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mBrowStrength - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mBrowType - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mChannelProfile - Variable in class io.agora.rtc2.RtcEngineConfig
The channel profile.
mContext - Variable in class io.agora.rtc2.RtcEngineConfig
The context of Android Activity.
mDomainLimit - Variable in class io.agora.rtc2.RtcEngineConfig
Whether to enable domain name restriction: - `true`: Enables the domain name restriction.
MEDIA_ENGINE_AUDIO_FILE_MIX_FINISH - Static variable in class io.agora.rtc2.Constants
 
MEDIA_ENGINE_PLAYOUT_ERROR - Static variable in class io.agora.rtc2.Constants
 
MEDIA_ENGINE_PLAYOUT_WARNING - Static variable in class io.agora.rtc2.Constants
 
MEDIA_ENGINE_RECORDING_ERROR - Static variable in class io.agora.rtc2.Constants
 
MEDIA_ENGINE_RECORDING_WARNING - Static variable in class io.agora.rtc2.Constants
 
MEDIA_ENGINE_ROLE_AUDIENCE - Static variable in class io.agora.rtc2.Constants
 
MEDIA_ENGINE_ROLE_BROADCASTER_INTERACTIVE - Static variable in class io.agora.rtc2.Constants
 
MEDIA_ENGINE_ROLE_BROADCASTER_SOLO - Static variable in class io.agora.rtc2.Constants
 
MEDIA_ENGINE_ROLE_COMM_PEER - Static variable in class io.agora.rtc2.Constants
 
MEDIA_PLAYER_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
7: Video for media player sharing.
MEDIA_TRACE_EVENT_VIDEO_DECODED - Enum constant in enum class io.agora.rtc2.Constants.MEDIA_TRACE_EVENT
1: The video frame has been decoded.
MEDIA_TRACE_EVENT_VIDEO_RENDERED - Enum constant in enum class io.agora.rtc2.Constants.MEDIA_TRACE_EVENT
0: The video frame has been rendered.
MEDIA_TYPE_AUDIO_AND_VIDEO - Static variable in class io.agora.rtc2.Constants
Audio and video
MEDIA_TYPE_AUDIO_ONLY - Static variable in class io.agora.rtc2.Constants
Audio only
MEDIA_TYPE_NONE - Static variable in class io.agora.rtc2.Constants
None
MEDIA_TYPE_VIDEO_ONLY - Static variable in class io.agora.rtc2.Constants
Video only
mediaPlayerAudioDelayMs - Variable in class io.agora.rtc2.ChannelMediaOptions
The delay in ms for sending media player audio frames.
mediaPlayerId - Variable in class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
(Optional) Media player ID.
mediaPlayerId - Variable in class io.agora.rtc2.video.VideoCanvas
The ID of the media player.
MediaPlayerSource - Class in io.agora.mediaplayer.data
 
MediaPlayerSource() - Constructor for class io.agora.mediaplayer.data.MediaPlayerSource
 
MediaRecorderConfiguration(String, int, int, int, int) - Constructor for class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
 
MediaRecorderConfiguration(String, int, int, int, int, int, int, int, int, int, int) - Constructor for class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
 
mediaSourceType - Variable in class io.agora.rtc2.ExtensionInfo
The type of media device.
MediaStreamInfo - Class in io.agora.mediaplayer.data
 
MediaStreamInfo() - Constructor for class io.agora.mediaplayer.data.MediaStreamInfo
 
MediaStreamInfo(int, int, String, String, int, int, int, int, int, int, int, long) - Constructor for class io.agora.mediaplayer.data.MediaStreamInfo
 
memoryAppUsageInKbytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The memory size occupied by the app (KB).
memoryAppUsageRatio - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The memory ratio occupied by the app (%).
memoryTotalUsageRatio - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The memory occupied by the system (%).
metadata - Variable in class io.agora.rtc2.live.LiveTranscoding
Deprecated.
This parameter is deprecated.
mEventHandler - Variable in class io.agora.rtc2.RtcEngineConfig
The event handler for `RtcEngine`.
mExtensionList - Variable in class io.agora.rtc2.RtcEngineConfig
Extension libraries.
mExtensionObserver - Variable in class io.agora.rtc2.RtcEngineConfig
The `IMediaExtensionObserver` instance.
mFacialStrength - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mFacialType - Variable in class io.agora.rtc2.video.MakeUpOptions
 
minBitrate - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
The minimum encoding bitrate (Kbps) of the video.
minFrameRate - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
(For future use) The minimum video encoder frame rate (fps).
mirror - Variable in class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
Whether to mirror the video for the local video mixing.
MIRROR_MODE_AUTO - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.MIRROR_MODE_TYPE
(Default) 0: The mirror mode determined by the SDK.
MIRROR_MODE_DISABLED - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.MIRROR_MODE_TYPE
2: Disable the mirror mode.
MIRROR_MODE_ENABLED - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.MIRROR_MODE_TYPE
1: Enable the mirror mode.
mirrorMode - Variable in class io.agora.rtc2.video.VideoCanvas
- VIDEO_MIRROR_MODE_AUTO (0): The SDK determines whether to enable the mirror mode.
mirrorMode - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
Sets the mirror mode of the published local video stream.
MixedAudioStream() - Constructor for class io.agora.rtc2.LocalAudioMixerConfiguration.MixedAudioStream
 
mLashColor - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mLashStrength - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mLashType - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mLicense - Variable in class io.agora.rtc2.RtcEngineConfig
The license used for verification when connectting channel.
mLipColor - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mLipStrength - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mLipType - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mLogConfig - Variable in class io.agora.rtc2.RtcEngineConfig
Sets the log file size.
mMakeUpEnable - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mNativeLibPath - Variable in class io.agora.rtc2.RtcEngineConfig
Specifies the storage directory for the `.so` files.
mobileRxBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.MultipathStats
The total number of bytes received over the mobile network.
mobileTxBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.MultipathStats
The total number of bytes sent over the mobile network.
mode - Variable in class io.agora.rtc2.audio.AudioParams
The use mode of the audio data, which can be set as either of the following values: - RAW_AUDIO_FRAME_OP_MODE_READ_ONLY (0): Read-only mode, For example, when users acquire the data with the Agora SDK, then start the media push.
mode - Variable in class io.agora.rtc2.proxy.LocalAccessPointConfiguration
Connection mode: - LOCAL_RPOXY_CONNECTIVITY_FIRST (0): The SDK first attempts to connect to the specified Agora private media server; if the connection to the specified Agora private media server fails, it connects to the Agora SD-RTN™.
modelType - Variable in class io.agora.rtc2.video.SegmentationProperty
The type of algorithms to user for background processing.
moduleCount - Variable in class io.agora.rtc2.video.ContentInspectConfig
The number of functional modules, that is,the number of configured `ContentInspectModule` instances, must be the same as the number of instances configured in `modules`.
modules - Variable in class io.agora.rtc2.video.ContentInspectConfig
Functional module.
monitorAudioRouteChange(boolean) - Method in class io.agora.rtc2.RtcEngineInternal
Enables the audio routing monitoring by the SDK.
monitorBluetoothHeadsetEvent(boolean) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
monitorHeadsetEvent(boolean) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
mosValue - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
The quality of the remote audio stream in the reported interval.
mosValue - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
The quality of the remote video stream in the reported interval.
mPupilStrength - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mPupilType - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mRtcEngine - Variable in class io.agora.spatialaudio.LocalSpatialAudioConfig
`RtcEngine`.
mShadowStrength - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mShadowType - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mThreadPriority - Variable in class io.agora.rtc2.RtcEngineConfig
Thread priority type.
MULTIPATH_MODE_DUPLICATE - Enum constant in enum class io.agora.rtc2.Constants.MultipathMode
0: Duplicate mode, where data is sent over multiple paths simultaneously.
MULTIPATH_MODE_DYNAMIC - Enum constant in enum class io.agora.rtc2.Constants.MultipathMode
1: Dynamic transmission mode.
MULTIPATH_TYPE_LAN - Enum constant in enum class io.agora.rtc2.Constants.MultipathType
(0): LAN type, indicates data is transmitted over a local area network.
MULTIPATH_TYPE_MOBILE - Enum constant in enum class io.agora.rtc2.Constants.MultipathType
(2): Mobile network type, indicates data is transmitted over a mobile network.
MULTIPATH_TYPE_UNKNOWN - Enum constant in enum class io.agora.rtc2.Constants.MultipathType
(99): Unknown type, indicates an unrecognized path type.
MULTIPATH_TYPE_WIFI - Enum constant in enum class io.agora.rtc2.Constants.MultipathType
(1): Wi-Fi type, indicates data is transmitted over a Wi-Fi network.
MultipathStats() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.MultipathStats
 
MUSIC_HIGH_QUALITY - Enum constant in enum class io.agora.rtc2.Constants.AudioProfile
4: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 96 Kbps.
MUSIC_HIGH_QUALITY_STEREO - Enum constant in enum class io.agora.rtc2.Constants.AudioProfile
5: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 128 Kbps.
MUSIC_STANDARD - Enum constant in enum class io.agora.rtc2.Constants.AudioProfile
2: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps.
MUSIC_STANDARD_STEREO - Enum constant in enum class io.agora.rtc2.Constants.AudioProfile
3: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 80 Kbps.
mute(boolean) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
muteAllRemoteAudioStreams(boolean) - Method in class io.agora.rtc2.RtcEngine
 
muteAllRemoteAudioStreams(boolean) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
 
muteAllRemoteAudioStreamsEx(boolean, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
muteAllRemoteVideoStreams(boolean) - Method in class io.agora.rtc2.RtcEngine
 
muteAllRemoteVideoStreamsEx(boolean, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
muteLocalAudioStream(boolean) - Method in class io.agora.rtc2.RtcEngine
 
muteLocalAudioStream(boolean) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
 
muteLocalAudioStreamEx(boolean, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
muteLocalVideoStream(boolean) - Method in class io.agora.rtc2.RtcEngine
 
muteLocalVideoStreamEx(boolean, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
muteRecordingSignal(boolean) - Method in class io.agora.rtc2.RtcEngine
 
muteRecordingSignalEx(boolean, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Mute or resume recording signal volume.
muteRemoteAudioStream(int, boolean) - Method in class io.agora.rtc2.RtcEngine
 
muteRemoteAudioStream(int, boolean) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
 
muteRemoteAudioStreamEx(int, boolean, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
muteRemoteVideoStream(int, boolean) - Method in class io.agora.rtc2.RtcEngine
 
muteRemoteVideoStreamEx(int, boolean, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
mWocanStrength - Variable in class io.agora.rtc2.video.MakeUpOptions
 
mWocanType - Variable in class io.agora.rtc2.video.MakeUpOptions
 

N

NET_CONNECT - Enum constant in enum class io.agora.rtc2.DirectCdnStreamingReason
Deprecated.
4: Fails to connect to the CDN.
NETWORK_TYPE_DISCONNECTED - Static variable in class io.agora.rtc2.Constants
0: The SDK disconnects from the network.
NETWORK_TYPE_LAN - Static variable in class io.agora.rtc2.Constants
1: The network type is LAN.
NETWORK_TYPE_MOBILE_2G - Static variable in class io.agora.rtc2.Constants
3: The network type is mobile 2G.
NETWORK_TYPE_MOBILE_3G - Static variable in class io.agora.rtc2.Constants
4: The network type is mobile 3G.
NETWORK_TYPE_MOBILE_4G - Static variable in class io.agora.rtc2.Constants
5: The network type is mobile 4G.
NETWORK_TYPE_MOBILE_5G - Static variable in class io.agora.rtc2.Constants
6: The network type is mobile 5G.
NETWORK_TYPE_UNKNOWN - Static variable in class io.agora.rtc2.Constants
-1: The network type is unknown.
NETWORK_TYPE_WIFI - Static variable in class io.agora.rtc2.Constants
2: The network type is Wi-Fi (including hotspots).
networkTransportDelay - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
The network delay (ms) from the sender to the receiver.
NONE - Enum constant in enum class io.agora.rtc2.Constants.MediaType
No audio and video.
NORMAL - Enum constant in enum class io.agora.rtc2.Constants.ThreadPriorityType
2: Normal priority.
NOT_FOUND - Enum constant in enum class io.agora.rtc2.IH265TranscoderObserver.H265TranscodeResult
5: The url of request is not found.
NOT_SUPPORTED - Enum constant in enum class io.agora.rtc2.IH265TranscoderObserver.H265TranscodeResult
7: Content type not supported.
numChannels - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalAudioStats
The number of audio channels.
numChannels - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
The number of audio channels.

O

OffscreenSurface - Class in io.agora.rtc2.internal.gdp
Off-screen EGL surface (pbuffer).
OffscreenSurface(EglCore, int, int) - Constructor for class io.agora.rtc2.internal.gdp.OffscreenSurface
Creates an off-screen surface with the specified width and height.
OK - Enum constant in enum class io.agora.rtc2.DirectCdnStreamingReason
Deprecated.
0: No error.
onActiveSpeaker(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onAgoraCDNTokenWillExpire() - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
Deprecated.
4.6.0
onAudioEffectFinished(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onAudioMetadataReceived(int, byte[]) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onAudioMixingFinished() - Method in class io.agora.rtc2.IRtcEngineEventHandler
Deprecated.
onAudioMixingPositionChanged(long) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onAudioMixingStateChanged(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onAudioPublishStateChanged(String, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onAudioQuality(int, int, short, short) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onAudioRouteChanged(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onAudioSubscribeStateChanged(String, int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onAudioVolumeIndication(int) - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
 
onAudioVolumeIndication(IRtcEngineEventHandler.AudioVolumeInfo[], int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onCameraExposureAreaChanged(Rect) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onCameraFocusAreaChanged(Rect) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onCameraReady() - Method in class io.agora.rtc2.IRtcEngineEventHandler
Deprecated.
onCaptureVideoFrame(int, VideoFrame) - Method in interface io.agora.rtc2.video.IVideoFrameObserver
 
onChannelMediaRelayStateChanged(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onClientRoleChanged(int, int, ClientRoleOptions) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onClientRoleChangeFailed(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onConnectionBanned() - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onConnectionInterrupted() - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onConnectionLost() - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onConnectionStateChanged(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onContentInspectResult(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onDirectCdnStreamingStateChanged(DirectCdnStreamingState, DirectCdnStreamingReason, String) - Method in interface io.agora.rtc2.IDirectCdnStreamingEventHandler
Deprecated.
 
onDirectCdnStreamingStats(DirectCdnStreamingStats) - Method in interface io.agora.rtc2.IDirectCdnStreamingEventHandler
Deprecated.
 
onEarMonitoringAudioFrame(int, int, int, int, int, ByteBuffer, long, int) - Method in interface io.agora.rtc2.IAudioFrameObserver
 
onEnableTranscode(int) - Method in interface io.agora.rtc2.IH265TranscoderObserver
Use to notify the result of invoking enableTranscode interface.
onEncodedVideoFrameReceived(String, int, ByteBuffer, EncodedVideoFrameInfo) - Method in interface io.agora.rtc2.video.IVideoEncodedFrameObserver
 
onEncryptionError(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onEngineReleased() - Method in interface io.agora.rtc2.IRtcEngineReleaseCallback
 
onError(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onErrorWithContext(ExtensionContext, int, String) - Method in interface io.agora.rtc2.IMediaExtensionObserver
 
onEventWithContext(ExtensionContext, String, String) - Method in interface io.agora.rtc2.IMediaExtensionObserver
 
onFaceInfo(String) - Method in interface io.agora.rtc2.video.IFaceInfoObserver
 
onFacePositionChanged(int, int, IRtcEngineEventHandler.AgoraFacePositionInfo[]) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onFirstLocalAudioFramePublished(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onFirstLocalVideoFrame(Constants.VideoSourceType, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onFirstLocalVideoFramePublished(Constants.VideoSourceType, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onFirstRemoteAudioDecoded(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onFirstRemoteAudioFrame(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onFirstRemoteVideoDecoded(int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Deprecated.
This callback is deprecated. Use `REMOTE_VIDEO_STATE_STARTING(1)` or `REMOTE_VIDEO_STATE_DECODING(2)` in the onRemoteVideoStateChanged callback instead.
onFirstRemoteVideoFrame(int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onFrame(AudioFrame) - Method in interface io.agora.mediaplayer.IMediaPlayerAudioFrameObserver
 
onFrame(VideoFrame) - Method in interface io.agora.mediaplayer.IMediaPlayerVideoFrameObserver
 
onFrameAvailable(SurfaceTexture) - Method in class io.agora.mediaplayer.gl.PlayerTextureHelper
 
onIntraRequestReceived() - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when intra request from remote user is received.
onJoinChannelSuccess(String, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onLastmileProbeResult(IRtcEngineEventHandler.LastmileProbeResult) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onLastmileQuality(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onLeaveChannel(IRtcEngineEventHandler.RtcStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onLicenseValidationFailure(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when connection license verification fails You can know the reason accordding to error code
onLocalAudioSpectrum(AudioSpectrumInfo) - Method in interface io.agora.rtc2.audio.IAudioSpectrumObserver
 
onLocalAudioStateChanged(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onLocalAudioStats(IRtcEngineEventHandler.LocalAudioStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onLocalUserRegistered(int, String) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onLocalVideoEvent(Constants.VideoSourceType, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onLocalVideoStat(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Deprecated.
The statistics of the uploading local video streams once every two seconds.
onLocalVideoStateChanged(Constants.VideoSourceType, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onLocalVideoStats(Constants.VideoSourceType, IRtcEngineEventHandler.LocalVideoStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onLocalVideoTranscoderError(LocalTranscoderConfiguration.TranscodingVideoStream, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onMediaControlMessage(int, byte[]) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onMediaEngineLoadSuccess() - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when the media engine is loaded.
onMediaEngineStartCallSuccess() - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when the media engine starts.
onMediaPlayerVideoFrame(VideoFrame, int) - Method in interface io.agora.rtc2.video.IVideoFrameObserver
Occurs each time the SDK receives a video frame decoded by the MediaPlayer.
onMetaData(Constants.MediaPlayerMetadataType, byte[]) - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
 
onMetadataReceived(AgoraMetadata) - Method in interface io.agora.rtc2.IMetadataObserver
 
onMixedAudioEncodedFrame(ByteBuffer, int, int, int, int) - Method in interface io.agora.rtc2.IAudioEncodedFrameObserver
 
onMixedAudioFrame(String, int, int, int, int, int, ByteBuffer, long, int) - Method in interface io.agora.rtc2.IAudioFrameObserver
 
onMultipathStats(IRtcEngineEventHandler.MultipathStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onNetworkQuality(int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onNetworkTypeChanged(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onPermissionError(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onPermissionGranted(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Reports the permission granted.
onPlaybackAudioEncodedFrame(ByteBuffer, int, int, int, int) - Method in interface io.agora.rtc2.IAudioEncodedFrameObserver
 
onPlaybackAudioFrame(String, int, int, int, int, int, ByteBuffer, long, int) - Method in interface io.agora.rtc2.IAudioFrameObserver
 
onPlaybackAudioFrameBeforeMixing(String, int, int, int, int, int, int, ByteBuffer, long, int, int, long) - Method in interface io.agora.rtc2.IAudioFrameObserver
 
onPlayBufferUpdated(long) - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
 
onPlayerCacheStats(CacheStatistics) - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
 
onPlayerEvent(Constants.MediaPlayerEvent, long, String) - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
 
onPlayerInfoUpdated(PlayerUpdatedInfo) - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
 
onPlayerPlaybackStats(PlayerPlaybackStats) - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
 
onPlayerSrcInfoChanged(SrcInfo, SrcInfo) - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
 
onPlayerStateChanged(Constants.MediaPlayerState, Constants.MediaPlayerReason) - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
 
onPositionChanged(long, long) - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
 
onPreEncodeVideoFrame(int, VideoFrame) - Method in interface io.agora.rtc2.video.IVideoFrameObserver
 
onPreloadEvent(String, Constants.MediaPlayerPreloadEvent) - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
 
onProxyConnected(String, int, int, String, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onQueryChannel(int, String, String) - Method in interface io.agora.rtc2.IH265TranscoderObserver
Use to notify the result of invoking queryChannel interface.
onRdtMessage(int, int, byte[]) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onRdtStateChanged(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onReadData(ByteBuffer, int) - Method in interface io.agora.mediaplayer.IMediaPlayerCustomDataProvider
 
onReadyToSendMetadata(long, int) - Method in interface io.agora.rtc2.IMetadataObserver
 
onRecordAudioEncodedFrame(ByteBuffer, int, int, int, int) - Method in interface io.agora.rtc2.IAudioEncodedFrameObserver
 
onRecordAudioFrame(String, int, int, int, int, int, ByteBuffer, long, int) - Method in interface io.agora.rtc2.IAudioFrameObserver
 
onRecorderInfoUpdated(String, int, RecorderInfo) - Method in interface io.agora.rtc2.IMediaRecorderCallback
 
onRecorderStateChanged(String, int, int, int) - Method in interface io.agora.rtc2.IMediaRecorderCallback
 
onRejoinChannelSuccess(String, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onRemoteAudioSpectrum(UserAudioSpectrumInfo[], int) - Method in interface io.agora.rtc2.audio.IAudioSpectrumObserver
 
onRemoteAudioStateChanged(int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onRemoteAudioStats(IRtcEngineEventHandler.RemoteAudioStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onRemoteAudioTransportStats(int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Deprecated.
Use onRemoteAudioStats instead.
onRemoteSubscribeFallbackToAudioOnly(int, boolean) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onRemoteVideoStat(int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Deprecated.
The statistics of receiving remote video streams once every two seconds.
onRemoteVideoStateChanged(int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onRemoteVideoStats(IRtcEngineEventHandler.RemoteVideoStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onRemoteVideoTransportStats(int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Deprecated.
Use onRemoteVideoStats instead.
onRenderVideoFrame(String, int, VideoFrame) - Method in interface io.agora.rtc2.video.IVideoFrameObserver
 
onRenewTokenResult(String, Constants.RenewTokenErrorCode) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onRequestToken() - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onRhythmPlayerStateChanged(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onRtcStats(IRtcEngineEventHandler.RtcStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onRtmpStreamingEvent(String, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onRtmpStreamingStateChanged(String, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onSeek(long, int) - Method in interface io.agora.mediaplayer.IMediaPlayerCustomDataProvider
 
onSnapshotTaken(int, String, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onStartedWithContext(ExtensionContext) - Method in interface io.agora.rtc2.IMediaExtensionObserver
 
onStoppedWithContext(ExtensionContext) - Method in interface io.agora.rtc2.IMediaExtensionObserver
 
onStreamMessage(int, int, byte[]) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onStreamMessageError(int, int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onTokenPrivilegeWillExpire(String) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onTranscodedStreamLayoutInfo(int, IRtcEngineEventHandler.VideoLayoutInfo) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onTranscodingUpdated() - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onTriggerTranscode(int) - Method in interface io.agora.rtc2.IH265TranscoderObserver
Use to notify the result of invoking triggerTranscode interface.
onUplinkNetworkInfoUpdated(IRtcEngineEventHandler.UplinkNetworkInfo) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onUploadLogResult(String, boolean, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Reports the user log upload result
onUserEnableLocalVideo(int, boolean) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Deprecated.
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)`.
onUserEnableVideo(int, boolean) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onUserInfoUpdated(int, UserInfo) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onUserJoined(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onUserMuteAudio(int, boolean) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onUserMuteVideo(int, boolean) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onUserOffline(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onUserStateChanged(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when the remote user state is updated.
onVideoPublishStateChanged(Constants.VideoSourceType, String, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onVideoRenderingTracingResult(int, Constants.MEDIA_TRACE_EVENT, IRtcEngineEventHandler.VideoRenderingTracingInfo) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onVideoSizeChanged(Constants.VideoSourceType, int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onVideoStopped() - Method in class io.agora.rtc2.IRtcEngineEventHandler
Deprecated.
onVideoSubscribeStateChanged(String, int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
open(String) - Method in class io.agora.mediaplayer.AssetsFileReader
 
open(String) - Method in class io.agora.mediaplayer.ContentFileReader
 
open(Uri, long) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
openWithAgoraCDNSrc(String, long) - Method in interface io.agora.mediaplayer.IMediaPlayer
Deprecated.
4.6.0
openWithMediaSource(MediaPlayerSource) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
options - Variable in class io.agora.rtc2.video.WatermarkConfig
Options defining the position and size of the watermark.
ordered - Variable in class io.agora.rtc2.DataStreamConfig
Whether the SDK guarantees that the receiver receives the data in the sent order.
ORIENTATION_MODE_ADAPTIVE - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.ORIENTATION_MODE
0: (Default) The output video always follows the orientation of the captured video.
ORIENTATION_MODE_FIXED_LANDSCAPE - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.ORIENTATION_MODE
1: In this mode, the SDK always outputs videos in landscape (horizontal) mode.
ORIENTATION_MODE_FIXED_PORTRAIT - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.ORIENTATION_MODE
2: In this mode, the SDK always outputs video in portrait (portrait) mode.
orientationMode - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
The orientation mode of the encoded video.
owner - Variable in class io.agora.rtc2.PublisherParameters
Deprecated.
 
owner(boolean) - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
Sets the RTMP stream owner.

P

PACKETIZE_MODE_H264_NON_INTERLEAVED - Static variable in class io.agora.rtc2.Constants
Packetize Mode H264PacketizeMode
PACKETIZE_MODE_H264_SINGLE_NAL_UNIT - Static variable in class io.agora.rtc2.Constants
 
packetLossRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LastmileProbeResult.LastmileProbeOneWayResult
The packet loss rate (%).
packetLossRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
The packet loss rate (%) of the remote video after using the anti-packet-loss technology.
parameters - Variable in class io.agora.rtc2.ChannelMediaOptions
Provides the technical preview functionalities or special customizations by configuring the SDK with JSON options.
path - Variable in class io.agora.rtc2.video.FilterEffectOptions
The absolute path to the local cube map texture file, which can be used to customize the filter effect.
pathStats - Variable in class io.agora.rtc2.IRtcEngineEventHandler.MultipathStats
An array of statistics for each active transmission path.
PathStats() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.PathStats
 
pathType - Variable in class io.agora.rtc2.IRtcEngineEventHandler.PathStats
Types of network path: - LAN: Local Area Network.
pause() - Method in interface io.agora.mediaplayer.IMediaPlayer
 
pauseAllChannelMediaRelay() - Method in class io.agora.rtc2.RtcEngine
 
pauseAllChannelMediaRelayEx(RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Deprecated.
This method is deprecated from v4.2.0. Use `startOrUpdateChannelMediaRelayEx` instead.
pauseAllEffects() - Method in interface io.agora.rtc2.IAudioEffectManager
Pauses playing all audio effects.
pauseAllEffects() - Method in class io.agora.rtc2.RtcEngine
 
pauseAudio() - Method in class io.agora.rtc2.RtcEngine
Disables the audio function in the channel.
pauseAudioMixing() - Method in class io.agora.rtc2.RtcEngine
 
pauseEffect(int) - Method in interface io.agora.rtc2.IAudioEffectManager
Pauses playing the specified audio effect.
pauseEffect(int) - Method in class io.agora.rtc2.RtcEngine
 
performVideoEffectAction(int, IVideoEffectObject.VIDEO_EFFECT_ACTION) - Method in interface io.agora.rtc2.IVideoEffectObject
 
PITCH_CORRECTION - Static variable in class io.agora.rtc2.Constants
A pitch correction effect that corrects the user's pitch based on the pitch of the natural C major scale.
play() - Method in interface io.agora.mediaplayer.IMediaPlayer
 
PLAY_REASON_SRC_BUFFER_UNDERFLOW - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-12: The playback buffer is insufficient.
playAllEffects(int, double, double, double, boolean) - Method in class io.agora.rtc2.RtcEngine
 
playEffect(int, String, int, double, double, double) - Method in interface io.agora.rtc2.IAudioEffectManager
Plays a specified audio effect.
playEffect(int, String, int, double, double, double, boolean) - Method in interface io.agora.rtc2.IAudioEffectManager
Plays a specified audio effect.
playEffect(int, String, int, double, double, double, boolean) - Method in class io.agora.rtc2.RtcEngine
 
playEffect(int, String, int, double, double, double, boolean, int) - Method in interface io.agora.rtc2.IAudioEffectManager
Plays a specified audio effect.
playEffect(int, String, int, double, double, double, boolean, int) - Method in class io.agora.rtc2.RtcEngine
 
playEffectEx(RtcConnection, int, String, int, double, double, double, boolean) - Method in interface io.agora.rtc2.IAudioEffectManager
Plays a specified audio effect to a specified channel.
playEffectEx(RtcConnection, int, String, int, double, double, double, boolean) - Method in class io.agora.rtc2.RtcEngineEx
 
playEffectEx(RtcConnection, int, String, int, double, double, double, boolean, int) - Method in interface io.agora.rtc2.IAudioEffectManager
Plays a specified audio effect to a specified channel.
playEffectEx(RtcConnection, int, String, int, double, double, double, boolean, int) - Method in class io.agora.rtc2.RtcEngineEx
 
PLAYER_EVENT_AUDIO_TRACK_CHANGED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
5: The audio track used by the player has been changed.
PLAYER_EVENT_BUFFER_LOW - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
6: The currently buffered data is not enough to support playback.
PLAYER_EVENT_BUFFER_RECOVER - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
7: The currently buffered data is just enough to support playback.
PLAYER_EVENT_FIRST_DISPLAYED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
13: The first video frame is rendered.
PLAYER_EVENT_FREEZE_START - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
8: The audio or video playback freezes.
PLAYER_EVENT_FREEZE_STOP - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
9: The audio or video playback resumes without freezing.
PLAYER_EVENT_HTTP_REDIRECT - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
Triggered when an http redirect occurs
PLAYER_EVENT_REACH_CACHE_FILE_MAX_COUNT - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
14: The cached media files reach the limit in number.
PLAYER_EVENT_REACH_CACHE_FILE_MAX_SIZE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
15: The cached media files reach the limit in aggregate storage space.
PLAYER_EVENT_SEEK_BEGIN - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
0: The player begins to seek to a new playback position.
PLAYER_EVENT_SEEK_COMPLETE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
1: The player finishes seeking to a new playback position.
PLAYER_EVENT_SEEK_ERROR - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
2: An error occurs when seeking to a new playback position.
PLAYER_EVENT_SWITCH_BEGIN - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
10: The player starts switching the media resource.
PLAYER_EVENT_SWITCH_COMPLETE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
11: Media resource switching is complete.
PLAYER_EVENT_SWITCH_ERROR - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
12: Media resource switching error.
PLAYER_EVENT_TRY_OPEN_FAILED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
Triggered when retrying to open media fails
PLAYER_EVENT_TRY_OPEN_START - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
Triggered when a retry is required to open the media
PLAYER_EVENT_TRY_OPEN_SUCCEED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
Triggered when the retry to open the media is successful
PLAYER_EVENT_UNKNOWN - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
-1: An unknown event.
PLAYER_METADATA_TYPE_SEI - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerMetadataType
1: The type is SEI.
PLAYER_METADATA_TYPE_UNKNOWN - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerMetadataType
0: The type is unknown.
PLAYER_PRELOAD_EVENT_BEGIN - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerPreloadEvent
0: Starts preloading media resources.
PLAYER_PRELOAD_EVENT_COMPLETE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerPreloadEvent
1: Preloading media resources is complete.
PLAYER_PRELOAD_EVENT_ERROR - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerPreloadEvent
2: An error occurs when preloading media resources.
PLAYER_REASON_CODEC_NOT_SUPPORTED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-7: The codec is not supported.
PLAYER_REASON_INTERNAL - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-2: Internal error.
PLAYER_REASON_INTERRUPTED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-13: The playback is interrupted.
PLAYER_REASON_INVALID_ARGUMENTS - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-1: Invalid arguments.
PLAYER_REASON_INVALID_CONNECTION_STATE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-11: Invalid connection between the player and the Agora Server.
PLAYER_REASON_INVALID_MEDIA_SOURCE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-4: Invalid media resource.
PLAYER_REASON_INVALID_STATE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-9: An error with the internal state of the player occurs.
PLAYER_REASON_IP_EXPIRED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
ip expired
PLAYER_REASON_NO_RESOURCE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-3: No resource.
PLAYER_REASON_NONE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
0: No error.
PLAYER_REASON_NOT_INIT - Static variable in class io.agora.mediaplayer.Constants
 
PLAYER_REASON_NOT_SUPPORTED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-14: The SDK does not support the method being called.
PLAYER_REASON_OBJ_NOT_INITIALIZED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-6: The object is not initialized.
PLAYER_REASON_TOKEN_EXPIRED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-15: The authentication information of the media resource is expired.
PLAYER_REASON_UNKNOWN - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-17: An unknown error.
PLAYER_REASON_UNKNOWN_STREAM_TYPE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-5: The media stream type is unknown.
PLAYER_REASON_URL_NOT_FOUND - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-10: The URL of the media resource cannot be found.
PLAYER_REASON_VIDEO_RENDER_FAILED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-8: Invalid renderer.
PLAYER_RENDER_MODE_ADAPTIVE - Static variable in class io.agora.mediaplayer.Constants
 
PLAYER_RENDER_MODE_FIT - Static variable in class io.agora.mediaplayer.Constants
 
PLAYER_RENDER_MODE_HIDDEN - Static variable in class io.agora.mediaplayer.Constants
 
PLAYER_STATE_DO_NOTHING_INTERNAL - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
Do nothing state for state machine (internal)
PLAYER_STATE_FAILED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
100: The media player fails to play the media resource.
PLAYER_STATE_GETTING_INTERNAL - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
Player getting state (internal)
PLAYER_STATE_IDLE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
0: The default state.
PLAYER_STATE_NONE_INTERNAL - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
None state for state machine (internal)
PLAYER_STATE_OPEN_COMPLETED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
2: Opens the media resource successfully.
PLAYER_STATE_OPENING - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
1: Opening the media resource.
PLAYER_STATE_PAUSED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
4: Pauses the playback.
PLAYER_STATE_PAUSING_INTERNAL - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
Player pausing (internal)
PLAYER_STATE_PLAYBACK_ALL_LOOPS_COMPLETED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
6: The loop is complete.
PLAYER_STATE_PLAYBACK_COMPLETED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
5: The playback is complete.
PLAYER_STATE_PLAYING - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
3: The media resource is playing.
PLAYER_STATE_SEEKING_INTERNAL - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
Player seeking state (internal)
PLAYER_STATE_SET_TRACK_INTERNAL - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
Player set track state (internal)
PLAYER_STATE_STOPPED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
7: The playback stops.
PLAYER_STATE_STOPPING_INTERNAL - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
Player stopping (internal)
PLAYER_STATE_UNKNOWN - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
-1: The player state is unknown.
PlayerPlaybackStats - Class in io.agora.mediaplayer.data
 
PlayerPlaybackStats() - Constructor for class io.agora.mediaplayer.data.PlayerPlaybackStats
 
PlayerTextureHelper - Class in io.agora.mediaplayer.gl
 
PlayerUpdatedInfo - Class in io.agora.mediaplayer.data
 
PlayerUpdatedInfo() - Constructor for class io.agora.mediaplayer.data.PlayerUpdatedInfo
 
PlayerUpdatedInfo(String, String) - Constructor for class io.agora.mediaplayer.data.PlayerUpdatedInfo
 
PlayerUpdatedInfo(String, String, long, long, long, long, long) - Constructor for class io.agora.mediaplayer.data.PlayerUpdatedInfo
 
playPreloadedSrc(String) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
plcCount - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
The number of audio packet loss concealment
POOR - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.Quality
Deprecated.
 
position - Variable in class io.agora.rtc2.video.ContentInspectConfig.ContentInspectModule
The position of the video observer.
position - Variable in class io.agora.rtc2.video.SnapshotConfig
The position of the snapshot video frame in the video pipeline.
position - Variable in class io.agora.rtc2.video.VideoCanvas
The observation position of the video frame in the video link.
position - Variable in class io.agora.spatialaudio.RemoteVoicePositionInfo
The coordinates in the world coordinate system.
position - Variable in class io.agora.spatialaudio.SpatialAudioZone
The spatial center point of the sound insulation area.
position(double, double) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
POSITION_BEFORE_MIXING - Static variable in class io.agora.rtc2.Constants
`0x01 << 3`: The position for observing the audio of a single remote user before mixing, which enables the SDK to trigger the onPlaybackFrameBeforeMixing or onPlaybackFrameBeforeMixingEx callback.
POSITION_EAR_MONITORING - Static variable in class io.agora.rtc2.Constants
`0x01 << 4`: The position for observing the ear monitoring audio of the local user, which enables the SDK to trigger the onEarMonitoringAudioFrame callback.
POSITION_MIXED - Static variable in class io.agora.rtc2.Constants
`0x01 << 2`: The position for observing the mixed audio of the local user and all remote users, which enables the SDK to trigger the onMixedFrame callback.
POSITION_PLAYBACK - Static variable in class io.agora.rtc2.Constants
`0x01`: The position for observing the playback audio of all remote users after mixing, which enables the SDK to trigger the onPlaybackFrame callback.
POSITION_POST_CAPTURER - Static variable in interface io.agora.rtc2.video.IVideoFrameObserver
The position after capturing the video data, which corresponds to the onCaptureVideoFrame callback.
POSITION_PRE_ENCODER - Static variable in interface io.agora.rtc2.video.IVideoFrameObserver
The position before encoding the video data, which corresponds to the onPreEncodeVideoFrame callback.
POSITION_PRE_RENDERER - Static variable in interface io.agora.rtc2.video.IVideoFrameObserver
The position before receiving the remote video data, which corresponds to the onRenderVideoFrame callback.
POSITION_RECORD - Static variable in class io.agora.rtc2.Constants
`0x01 << 1`: The position for observing the recorded audio of the local user, which enables the SDK to trigger the onRecordFrame callback.
positionInLandscapeMode - Variable in class io.agora.rtc2.video.WatermarkOptions
The area to display the watermark image in landscape mode.
positionInPortraitMode - Variable in class io.agora.rtc2.video.WatermarkOptions
The area to display the watermark image in portrait mode.
PREFER_AUTO - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.ENCODING_PREFERENCE
-1: Adaptive preference.
PREFER_COMPRESSION_AUTO - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.COMPRESSION_PREFERENCE
-1: (Default) Automatic mode.
PREFER_HARDWARE - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.ENCODING_PREFERENCE
1: Hardware encoding preference.
PREFER_LOW_LATENCY - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.COMPRESSION_PREFERENCE
0: Low latency preference.
PREFER_QUALITY - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.COMPRESSION_PREFERENCE
1: High quality preference.
PREFER_SOFTWARE - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.ENCODING_PREFERENCE
0: Software coding preference.
preferMultipathType - Variable in class io.agora.rtc2.ChannelMediaOptions
Preferred type of transmission path.
PREFIX_ASSETS - Static variable in class io.agora.mediaplayer.AssetsFileReader
 
preloadChannel(String, String, int) - Method in class io.agora.rtc2.RtcEngine
 
preloadChannelWithUserAccount(String, String, String) - Method in class io.agora.rtc2.RtcEngine
 
preloadEffect(int, String) - Method in interface io.agora.rtc2.IAudioEffectManager
Preloads a specified audio effect.
preloadEffect(int, String) - Method in class io.agora.rtc2.RtcEngine
 
preloadEffect(int, String, int) - Method in interface io.agora.rtc2.IAudioEffectManager
Preloads a specified audio effect.
preloadEffect(int, String, int) - Method in class io.agora.rtc2.RtcEngine
Preloads a specified audio effect.
preloadEffectEx(RtcConnection, int, String) - Method in interface io.agora.rtc2.IAudioEffectManager
Preloads a specified audio effect to a specified channel.
preloadEffectEx(RtcConnection, int, String) - Method in class io.agora.rtc2.RtcEngineEx
 
preloadEffectEx(RtcConnection, int, String, int) - Method in interface io.agora.rtc2.IAudioEffectManager
Preloads a specified audio effect to a specified channel.
preloadEffectEx(RtcConnection, int, String, int) - Method in class io.agora.rtc2.RtcEngineEx
 
preloadSrc(String, long) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
PRIMARY_CAMERA_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
2: The primary camera.
PRIMARY_SCREEN_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
4: Video captured by primary screen capturer.
PROCESS_MODE_READ_ONLY - Static variable in interface io.agora.rtc2.video.IVideoFrameObserver
Observer works as a pure renderer and will not modify the original frame.
PROCESS_MODE_READ_WRITE - Static variable in interface io.agora.rtc2.video.IVideoFrameObserver
Observer works as a filter that will process the video frame and affect the following frame processing in SDK.
providerName - Variable in class io.agora.rtc2.ExtensionContext
The name of the extension provider.
PROXY_TYPE_HTTP - Static variable in class io.agora.rtc2.Constants
5: The http proxy.
PROXY_TYPE_HTTPS - Static variable in class io.agora.rtc2.Constants
6: The https proxy.
PROXY_TYPE_LOCAL_PROXY - Static variable in class io.agora.rtc2.Constants
3: Reserved for future use.
PROXY_TYPE_NONE_PROXY - Static variable in class io.agora.rtc2.Constants
0: Reserved for future use.
PROXY_TYPE_TCP_AUTO_FALLBACK - Static variable in class io.agora.rtc2.Constants
4: The automatic mode.
PROXY_TYPE_TCP_CLOUD_PROXY - Static variable in class io.agora.rtc2.Constants
2: The cloud proxy for the TCP (encryption) protocol, that is, the Force TCP cloud proxy mode.
PROXY_TYPE_UDP_CLOUD_PROXY - Static variable in class io.agora.rtc2.Constants
1: The cloud proxy for the UDP protocol, that is, the Force UDP cloud proxy mode.
PUB_STATE_IDLE - Static variable in class io.agora.rtc2.Constants
0: The initial publishing state after joining the channel.
PUB_STATE_NO_PUBLISHED - Static variable in class io.agora.rtc2.Constants
1: Fails to publish the local stream.
PUB_STATE_PUBLISHED - Static variable in class io.agora.rtc2.Constants
3: Successfully publishes the local stream.
PUB_STATE_PUBLISHING - Static variable in class io.agora.rtc2.Constants
2: Publishing the local stream.
publishCameraTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to publish the video captured by the camera: - `true`: Publish the video captured by the camera.
publishCameraTrack - Variable in class io.agora.rtc2.DirectCdnStreamingMediaOptions
Deprecated.
Sets whether to publish the video captured by the camera: - `true`: Publish the video captured by the camera.
publishCustomAudioTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to publish the audio captured from a custom source: - `true`: Publish the audio captured from the custom source.
publishCustomAudioTrack - Variable in class io.agora.rtc2.DirectCdnStreamingMediaOptions
Deprecated.
Sets whether to publish the captured audio from a custom source: - `true`: Publish the captured audio from a custom source.
publishCustomAudioTrackId - Variable in class io.agora.rtc2.ChannelMediaOptions
The ID of the custom audio track to be published.
publishCustomVideoTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to publish the video captured from a custom source: - `true`: Publish the video captured from the custom source.
publishCustomVideoTrack - Variable in class io.agora.rtc2.DirectCdnStreamingMediaOptions
Deprecated.
Sets whether to publish the captured video from a custom source: - `true`: Publish the captured video from a custom source.
publishDuration - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
The total duration (ms) of the remote audio stream.
publishDuration - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
The total duration (ms) of the remote video stream.
publishEncodedVideoTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to publish the encoded video: - `true`: Publish the encoded video.
PublisherConfiguration - Class in io.agora.rtc2
Push-stream methods.
PublisherConfiguration.Builder - Class in io.agora.rtc2
Deprecated.

If you want to configure the push-stream, Agora recommends using the setLiveTranscoding method.

PublisherParameters - Class in io.agora.rtc2
Deprecated. 
PublisherParameters() - Constructor for class io.agora.rtc2.PublisherParameters
Deprecated.
 
publishFallbackEnable - Variable in class io.agora.rtc2.SimulcastConfig
Whether to enable fallback publishing: - `true`: Enable fallback publishing.
publishFourthCameraTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to publish the video captured by the fourth camera: - `true`: Publish the video captured by the fourth camera.
publishLipSyncTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to publish the video track processed by the speech driven extension: - `true`: Publish the video track processed by the speech driven extension.
publishMediaPlayerAudioTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to publish the audio from the media player: - `true`: Publish the audio from the media player.
publishMediaPlayerAudioTrack - Variable in class io.agora.rtc2.DirectCdnStreamingMediaOptions
Deprecated.
Determines whether to publish the audio track of media player source.
publishMediaPlayerId - Variable in class io.agora.rtc2.ChannelMediaOptions
The ID of the media player to be published.
publishMediaPlayerId - Variable in class io.agora.rtc2.DirectCdnStreamingMediaOptions
Deprecated.
Determines which media player source should be published.
publishMediaPlayerVideoTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to publish the video from the media player: - `true`: Publish the video from the media player.
publishMicrophoneTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to publish the audio captured by the microphone: - `true`: Publish the audio captured by the microphone.
publishMicrophoneTrack - Variable in class io.agora.rtc2.DirectCdnStreamingMediaOptions
Deprecated.
Sets whether to publish the audio captured by the microphone: - `true`: Publish the audio captured by the microphone.
publishMixedAudioTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to publish the mixed audio track: - `true`: Publish the mixed audio track.
publishRhythmPlayerTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to publish the sound of a metronome to remote users: - `true`: Publish processed audio frames.
publishScreenCaptureAudio - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to publish the audio captured from the screen: - `true`: Publish the audio captured from the screen.
publishScreenCaptureVideo - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to publish the video captured from the screen: - `true`: Publish the video captured from the screen.
publishSecondaryCameraTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
Determines whether to publish the video of the secondary camera track.
publishThirdCameraTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to publish the video captured by the third camera: - `true`: Publish the video captured by the third camera.
publishTranscodedVideoTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
Whether to publish the local transcoded video track.
publishUrl - Variable in class io.agora.rtc2.PublisherParameters
Deprecated.
 
publishUrl(String) - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
Sets the publishing URL.
pullPlaybackAudioFrame(byte[], int) - Method in class io.agora.rtc2.RtcEngine
 
pullPlaybackAudioFrame(ByteBuffer, int) - Method in class io.agora.rtc2.RtcEngine
 
pushExternalAudioFrame(byte[], long) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
This method is deprecated. Use pushExternalAudioFrame(byte[] data, long timestamp, int sampleRate, int channels, Constants.BytesPerSample bytesPerSample, int trackId) instead.
pushExternalAudioFrame(byte[], long, int, int, Constants.BytesPerSample, int) - Method in class io.agora.rtc2.RtcEngine
 
pushExternalAudioFrame(ByteBuffer, long, int) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
This method is deprecated. Use pushExternalAudioFrame(ByteBuffer[] data, long timestamp, int sampleRate, int channels, Constants.BytesPerSample bytesPerSample, int trackId) instead.
pushExternalAudioFrame(ByteBuffer, long, int, int, Constants.BytesPerSample, int) - Method in class io.agora.rtc2.RtcEngine
Pushes the external audio data to the app.
pushExternalEncodedVideoFrame(ByteBuffer, EncodedVideoFrameInfo) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
This method is deprecated.
pushExternalEncodedVideoFrameById(ByteBuffer, EncodedVideoFrameInfo, int) - Method in class io.agora.rtc2.RtcEngine
Pushes the encoded external video frame to the app with specified connection.
pushExternalVideoFrame(VideoFrame) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
This method is deprecated.
pushExternalVideoFrameById(VideoFrame, int) - Method in class io.agora.rtc2.RtcEngine
 

Q

qoeQuality - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
The Quality of Experience (QoE) of the local user when receiving a remote audio stream.
quality - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
The quality of the audio stream sent by the user.
Quality() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.Quality
Deprecated.
 
QUALITY_BAD - Static variable in class io.agora.rtc2.Constants
Users can communicate not very smoothly.
QUALITY_DETECTING - Static variable in class io.agora.rtc2.Constants
8: Detecting the network quality.
QUALITY_DOWN - Static variable in class io.agora.rtc2.Constants
Users cannot communicate at all.
QUALITY_EXCELLENT - Static variable in class io.agora.rtc2.Constants
The quality is excellent.
QUALITY_GOOD - Static variable in class io.agora.rtc2.Constants
The quality is quite good, but the bitrate may be slightly lower than excellent.
QUALITY_POOR - Static variable in class io.agora.rtc2.Constants
Users can feel the communication slightly impaired.
QUALITY_REPORT_FORMAT_HTML - Static variable in class io.agora.rtc2.Constants
The quality report in HTML format.
QUALITY_REPORT_FORMAT_JSON - Static variable in class io.agora.rtc2.Constants
The quality report in JSON format.
QUALITY_UNKNOWN - Static variable in class io.agora.rtc2.Constants
The quality is unknown.
QUALITY_UNSUPPORTED - Static variable in class io.agora.rtc2.Constants
7: (For future use) The network quality cannot be detected.
QUALITY_VBAD - Static variable in class io.agora.rtc2.Constants
The quality is so bad that users can barely communicate.
qualityAdaptIndication - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The quality adaptation of the local video stream in the reported interval (based on the target frame rate and target bitrate).
qualityChangedReason - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
Reasons why the QoE of the local user when receiving a remote audio stream is poor.
queryCameraFocalLengthCapability() - Method in class io.agora.rtc2.RtcEngine
 
queryChannel(String, String, int) - Method in interface io.agora.rtc2.IH265Transcoder
Query the transcoded channel of a channel.
queryCodecCapability() - Method in class io.agora.rtc2.RtcEngine
 
queryDeviceScore() - Method in class io.agora.rtc2.RtcEngine
 
queryHDRCapability(Constants.VIDEO_MODULE_TYPE) - Method in class io.agora.rtc2.RtcEngine
Queries the HDR capability of the video module.
queryScreenCaptureCapability() - Method in class io.agora.rtc2.RtcEngine
 

R

rate(String, int, String) - Method in class io.agora.rtc2.RtcEngine
 
RAW_AUDIO_FRAME_OP_MODE_READ_ONLY - Static variable in class io.agora.rtc2.Constants
Read-only mode, users only read the AudioFrame data without modifying anything.
RAW_AUDIO_FRAME_OP_MODE_READ_WRITE - Static variable in class io.agora.rtc2.Constants
Read and write mode, users read the data from AudioFrame, modify it and then play it.
rawStreamUrl - Variable in class io.agora.rtc2.PublisherParameters
Deprecated.
 
rawStreamUrl(String) - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
Sets the raw stream URL.
RDT_STATE_BLOCKED - Static variable in class io.agora.rtc2.Constants
The send buffer of the RDT tunnel is full.
RDT_STATE_BROKEN - Static variable in class io.agora.rtc2.Constants
The RDT channel is broken, and the data being sent and received will be cleared.
RDT_STATE_CLOSED - Static variable in class io.agora.rtc2.Constants
The RDT tunnel is in the initial or is closed.
RDT_STATE_OPENED - Static variable in class io.agora.rtc2.Constants
The RDT tunnel is open, and data can only be sent in this state.
RDT_STATE_PENDING - Static variable in class io.agora.rtc2.Constants
The RDT tunnel is in a suspended state because SDK has disconnected.
RDT_STREAM_CMD - Static variable in class io.agora.rtc2.Constants
Command stream type.
RDT_STREAM_COUNT - Static variable in class io.agora.rtc2.Constants
Reliable Data Transmission stream type count
RDT_STREAM_DATA - Static variable in class io.agora.rtc2.Constants
Data stream type.
read(ByteBuffer) - Method in class io.agora.mediaplayer.AssetsFileReader
Read file content to ByteBuffer
read(ByteBuffer) - Method in class io.agora.mediaplayer.ContentFileReader
Read file content to ByteBuffer
receivedBitrate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
The average bitrate (Kbps) of the received audio stream in the reported interval.
receivedBitrate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
The bitrate (Kbps) of the remote video received since the last count.
receivedSampleRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
The sampling rate of the received audio stream in the reported interval.
RECORD_AUDIO - Static variable in class io.agora.rtc2.Constants
Type of permission.
RECORDER_REASON_CONFIG_CHANGED - Static variable in class io.agora.rtc2.AgoraMediaRecorder
4: The recording configuration changes.
RECORDER_REASON_NO_STREAM - Static variable in class io.agora.rtc2.AgoraMediaRecorder
2: The SDK does not detect audio and video streams to be recorded, or audio and video streams are interrupted for more than five seconds during recording.
RECORDER_REASON_NONE - Static variable in class io.agora.rtc2.AgoraMediaRecorder
0: No error occurs.
RECORDER_REASON_OVER_MAX_DURATION - Static variable in class io.agora.rtc2.AgoraMediaRecorder
3: The recording duration exceeds the upper limit.
RECORDER_REASON_WRITE_FAILED - Static variable in class io.agora.rtc2.AgoraMediaRecorder
1: The SDK fails to write the recorded data to a file.
RECORDER_STATE_ERROR - Static variable in class io.agora.rtc2.AgoraMediaRecorder
-1: An error occurs during the recording.
RECORDER_STATE_START - Static variable in class io.agora.rtc2.AgoraMediaRecorder
2: The audio and video recording is started.
RECORDER_STATE_STOP - Static variable in class io.agora.rtc2.AgoraMediaRecorder
3: The audio and video recording is stopped.
RecorderInfo - Class in io.agora.rtc2
 
RecorderInfo(String, int, int) - Constructor for class io.agora.rtc2.RecorderInfo
 
recorderInfoUpdateInterval - Variable in class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
Interval for updating recording information, in milliseconds.
RecorderStreamInfo - Class in io.agora.rtc2
 
RecorderStreamInfo() - Constructor for class io.agora.rtc2.RecorderStreamInfo
 
RecorderStreamInfo(String, int, int) - Constructor for class io.agora.rtc2.RecorderStreamInfo
 
recorderStreamType - Variable in class io.agora.rtc2.RecorderStreamInfo
Type of video stream to record: - 0: Remote video streams within the channel.
RECOVERING - Enum constant in enum class io.agora.rtc2.DirectCdnStreamingState
Deprecated.
4: Tries to reconnect the Agora server to the CDN.
rect - Variable in class io.agora.rtc2.video.VideoCanvas
(Optional) Display area for the video frame.
Rectangle() - Constructor for class io.agora.rtc2.video.WatermarkOptions.Rectangle
 
Rectangle(int, int, int, int) - Constructor for class io.agora.rtc2.video.WatermarkOptions.Rectangle
 
rednessLevel - Variable in class io.agora.rtc2.video.BeautyOptions
The redness level, in the range [0.0,1.0], where 0.0 means the original redness.
Region() - Constructor for class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
regionCount() - Method in class io.agora.rtc2.video.VideoCompositingLayout.Builder
Deprecated.
 
regions - Variable in class io.agora.rtc2.video.VideoCompositingLayout
Deprecated.
 
regionsList - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Builder
Deprecated.
 
registerAudioEncodedFrameObserver(AudioEncodedFrameObserverConfig, IAudioEncodedFrameObserver) - Method in class io.agora.rtc2.RtcEngine
 
registerAudioFrameObserver(IMediaPlayerAudioFrameObserver, int) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
registerAudioFrameObserver(IAudioFrameObserver) - Method in class io.agora.rtc2.RtcEngine
 
registerAudioSpectrumObserver(IAudioSpectrumObserver) - Method in class io.agora.rtc2.RtcEngine
 
registerExtension(String, String, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
 
registerFaceInfoObserver(IFaceInfoObserver) - Method in class io.agora.rtc2.RtcEngine
 
registerLocalUserAccount(String, String) - Method in class io.agora.rtc2.RtcEngine
 
registerMediaMetadataObserver(IMetadataObserver, int) - Method in class io.agora.rtc2.RtcEngine
 
registerMediaPlayerAudioSpectrumObserver(IAudioSpectrumObserver, int) - Method in interface io.agora.mediaplayer.IMediaPlayer
Registers the audio frame spectrum observer.
registerPlayerObserver(IMediaPlayerObserver) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
registerTranscoderObserver(IH265TranscoderObserver) - Method in interface io.agora.rtc2.IH265Transcoder
Register a IH265TranscoderObserver object.
registerVideoEncodedFrameObserver(IVideoEncodedFrameObserver) - Method in class io.agora.rtc2.RtcEngine
 
registerVideoFrameObserver(IMediaPlayerVideoFrameObserver) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
registerVideoFrameObserver(IVideoFrameObserver) - Method in class io.agora.rtc2.RtcEngine
 
regulatedCaptureFrameHeight - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The height (px) adjusted by the built-in video capture adapter (regulator) of the SDK for capturing the local video stream.
regulatedCaptureFrameRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The frame rate (fps) adjusted by the built-in video capture adapter (regulator) of the SDK for capturing the local video stream.
regulatedCaptureFrameWidth - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The width (px) adjusted by the built-in video capture adapter (regulator) of the SDK for capturing the local video stream.
RELAY_ERROR_DEST_TOKEN_EXPIRED - Static variable in class io.agora.rtc2.Constants
11: The token of the destination channel has expired.
RELAY_ERROR_FAILED_JOIN_DEST - Static variable in class io.agora.rtc2.Constants
5: Fails to accept the relay request.
RELAY_ERROR_FAILED_JOIN_SRC - Static variable in class io.agora.rtc2.Constants
4: Fails to send the relay request.
RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC - Static variable in class io.agora.rtc2.Constants
6: The server fails to receive the media stream.
RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST - Static variable in class io.agora.rtc2.Constants
7: The server fails to send the media stream.
RELAY_ERROR_INTERNAL_ERROR - Static variable in class io.agora.rtc2.Constants
9: An internal error occurs in the server.
RELAY_ERROR_NO_RESOURCE_AVAILABLE - Static variable in class io.agora.rtc2.Constants
3: The SDK fails to access the service, probably due to limited resources of the server.
RELAY_ERROR_SERVER_CONNECTION_LOST - Static variable in class io.agora.rtc2.Constants
8: The SDK disconnects from the server due to poor network connections.
RELAY_ERROR_SERVER_ERROR_RESPONSE - Static variable in class io.agora.rtc2.Constants
1: An error occurs in the server response.
RELAY_ERROR_SERVER_NO_RESPONSE - Static variable in class io.agora.rtc2.Constants
2: No server response.
RELAY_ERROR_SRC_TOKEN_EXPIRED - Static variable in class io.agora.rtc2.Constants
10: The token of the source channel has expired.
RELAY_EVENT_NETWORK_CONNECTED - Static variable in class io.agora.rtc2.Constants
1: The network reconnects.
RELAY_EVENT_NETWORK_DISCONNECTED - Static variable in class io.agora.rtc2.Constants
0: The user disconnects from the server due to poor network connections.
RELAY_EVENT_PACKET_JOINED_DEST_CHANNEL - Static variable in class io.agora.rtc2.Constants
3: The user joins the destination channel.
RELAY_EVENT_PACKET_JOINED_SRC_CHANNEL - Static variable in class io.agora.rtc2.Constants
2: The user joins the source channel.
RELAY_EVENT_PACKET_RECEIVED_AUDIO_FROM_SRC - Static variable in class io.agora.rtc2.Constants
6: The server receives the audio stream from the source channel.
RELAY_EVENT_PACKET_RECEIVED_VIDEO_FROM_SRC - Static variable in class io.agora.rtc2.Constants
5: The server receives the video stream from the source channel.
RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL - Static variable in class io.agora.rtc2.Constants
4: The SDK starts relaying the media stream to the destination channel.
RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL - Static variable in class io.agora.rtc2.Constants
7: The destination channel is updated.
RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_IS_NULL - Static variable in class io.agora.rtc2.Constants
10: The destination channel name is NULL.
RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_NOT_CHANGE - Static variable in class io.agora.rtc2.Constants
9: The destination channel does not change, which means that the destination channel fails to be updated.
RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_REFUSED - Static variable in class io.agora.rtc2.Constants
8: The destination channel update fails due to internal reasons.
RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_FAILED - Static variable in class io.agora.rtc2.Constants
13: pause send packet to dest channel failed.
RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS - Static variable in class io.agora.rtc2.Constants
12: pause send packet to dest channel success.
RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_FAILED - Static variable in class io.agora.rtc2.Constants
15: pause send packet to dest channel failed.
RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS - Static variable in class io.agora.rtc2.Constants
14: resume send packet to dest channel success.
RELAY_EVENT_VIDEO_PROFILE_UPDATE - Static variable in class io.agora.rtc2.Constants
11: The video profile is sent to the server.
RELAY_OK - Static variable in class io.agora.rtc2.Constants
0: The state is normal.
RELAY_STATE_CONNECTING - Static variable in class io.agora.rtc2.Constants
1: The SDK tries to relay the media stream to the destination channel.
RELAY_STATE_FAILURE - Static variable in class io.agora.rtc2.Constants
3: A failure occurs.
RELAY_STATE_IDLE - Static variable in class io.agora.rtc2.Constants
0: The SDK is initializing.
RELAY_STATE_RUNNING - Static variable in class io.agora.rtc2.Constants
2: The SDK successfully relays the media stream to the destination channel.
release() - Method in class io.agora.rtc2.AgoraMediaRecorder
 
release() - Method in class io.agora.rtc2.internal.gdp.EglCore
Discards all resources held by this class, notably the EGL context.
release() - Method in class io.agora.rtc2.internal.gdp.OffscreenSurface
Releases any resources associated with the surface.
releaseEglSurface() - Method in class io.agora.rtc2.internal.gdp.EglSurfaceBase
Release the EGL surface.
releaseRenderedTextureInfo(VideoFrame) - Method in class io.agora.mediaplayer.gl.PlayerTextureHelper
 
releaseRenderedTextureInfo(VideoFrame) - Method in interface io.agora.mediaplayer.IPlayerTextureHelper
 
releaseSurface(EGLSurface) - Method in class io.agora.rtc2.internal.gdp.EglCore
Destroys the specified surface.
REMOTE_AUDIO_REASON_INTERNAL - Static variable in class io.agora.rtc2.Constants
0: Internal reasons.
REMOTE_AUDIO_REASON_LOCAL_MUTED - Static variable in class io.agora.rtc2.Constants
3: The local user stops receiving the remote audio stream or disables the audio module.
REMOTE_AUDIO_REASON_LOCAL_PLAY_FAILED - Static variable in class io.agora.rtc2.Constants
9: The local user receives remote audio packet but fails to play.
REMOTE_AUDIO_REASON_LOCAL_UNMUTED - Static variable in class io.agora.rtc2.Constants
4: The local user resumes receiving the remote audio stream or enables the audio module.
REMOTE_AUDIO_REASON_NETWORK_CONGESTION - Static variable in class io.agora.rtc2.Constants
1: Network congestion.
REMOTE_AUDIO_REASON_NETWORK_RECOVERY - Static variable in class io.agora.rtc2.Constants
2: Network recovery.
REMOTE_AUDIO_REASON_NO_PACKET_RECEIVE - Static variable in class io.agora.rtc2.Constants
8: The local user does not receive any audio packet from remote user.
REMOTE_AUDIO_REASON_REMOTE_MUTED - Static variable in class io.agora.rtc2.Constants
5: The remote user stops sending the audio stream or disables the audio module.
REMOTE_AUDIO_REASON_REMOTE_OFFLINE - Static variable in class io.agora.rtc2.Constants
7: The remote user leaves the channel.
REMOTE_AUDIO_REASON_REMOTE_UNMUTED - Static variable in class io.agora.rtc2.Constants
6: The remote user resumes sending the audio stream or enables the audio module.
REMOTE_AUDIO_STATE_DECODING - Static variable in class io.agora.rtc2.Constants
2: The remote audio stream is decoded and plays normally, probably due to REMOTE_AUDIO_REASON_NETWORK_RECOVERY(2), REMOTE_AUDIO_REASON_LOCAL_ENABLE_AUDIO(4), or REMOTE_AUDIO_REASON_REMOTE_UNMUTED(6).
REMOTE_AUDIO_STATE_FAILED - Static variable in class io.agora.rtc2.Constants
4: The remote audio fails to start, probably due to REMOTE_AUDIO_REASON_INTERNAL(0).
REMOTE_AUDIO_STATE_FROZEN - Static variable in class io.agora.rtc2.Constants
3: The remote audio is frozen, probably due to REMOTE_AUDIO_REASON_NETWORK_CONGESTION(1).
REMOTE_AUDIO_STATE_STARTING - Static variable in class io.agora.rtc2.Constants
1: The first remote audio packet is received.
REMOTE_AUDIO_STATE_STOPPED - Static variable in class io.agora.rtc2.Constants
0: The remote audio is in the default state, probably due to REMOTE_AUDIO_REASON_LOCAL_DISABLE_AUDIO(3), REMOTE_AUDIO_REASON_REMOTE_MUTED(5), or REMOTE_AUDIO_REASON_REMOTE_OFFLINE(7).
REMOTE_NETWORK_QUALITY_POOR - Static variable in class io.agora.rtc2.Constants
1: The remote user's network quality is poor.
REMOTE_VIDEO_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
11: Remote video received from network.
REMOTE_VIDEO_STATE_DECODING - Static variable in class io.agora.rtc2.Constants
2: Remote video stream is decoded and plays normally.
REMOTE_VIDEO_STATE_FAILED - Static variable in class io.agora.rtc2.Constants
4: Failed.
REMOTE_VIDEO_STATE_FROZEN - Static variable in class io.agora.rtc2.Constants
3: Remote video is frozen, probably due to network issue.
REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK - Static variable in class io.agora.rtc2.Constants
8: The remote media stream falls back to the audio-only stream due to poor network conditions.
REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY - Static variable in class io.agora.rtc2.Constants
9: The remote media stream switches back to the video stream after the network conditions improve.
REMOTE_VIDEO_STATE_REASON_CODEC_NOT_SUPPORT - Static variable in class io.agora.rtc2.Constants
13: The remote video stream is not supported by the decoder.
REMOTE_VIDEO_STATE_REASON_INTERNAL - Static variable in class io.agora.rtc2.Constants
0: Internal reasons.
REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED - Static variable in class io.agora.rtc2.Constants
3: The local user stops receiving the remote video stream or disables the video module.
REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED - Static variable in class io.agora.rtc2.Constants
4: The local user resumes receiving the remote video stream or enables the video module.
REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION - Static variable in class io.agora.rtc2.Constants
1: Network congestion.
REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY - Static variable in class io.agora.rtc2.Constants
2: Network recovery.
REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED - Static variable in class io.agora.rtc2.Constants
5: The remote user stops sending the video stream or disables the video module.
REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE - Static variable in class io.agora.rtc2.Constants
7: The remote user leaves the channel.
REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED - Static variable in class io.agora.rtc2.Constants
6: The remote user resumes sending the video stream or enables the video module.
REMOTE_VIDEO_STATE_REASON_SDK_IN_BACKGROUND - Static variable in class io.agora.rtc2.Constants
12: The remote user sdk(only for iOS) in background.
REMOTE_VIDEO_STATE_STARTING - Static variable in class io.agora.rtc2.Constants
1: video packet has been received, but not decoded yet.
REMOTE_VIDEO_STATE_STOPPED - Static variable in class io.agora.rtc2.Constants
Default state
REMOTE_VIDEO_STREAM_HIGH - Enum constant in enum class io.agora.rtc2.video.VideoSubscriptionOptions.REMOTE_VIDEO_STREAM_TYPE
 
REMOTE_VIDEO_STREAM_LOW - Enum constant in enum class io.agora.rtc2.video.VideoSubscriptionOptions.REMOTE_VIDEO_STREAM_TYPE
 
RemoteAudioStats() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
 
remoteJoined2PacketReceived - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoRenderingTracingInfo
- If the local user calls `startMediaRenderingTracing` before the remote user joins the channel, this value is the time interval (ms) from when the remote user joins the channel to when the local user receives the remote video stream.
remoteJoined2SetView - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoRenderingTracingInfo
- If the local user calls `startMediaRenderingTracing` before the remote user joins the channel, this value is the time interval (ms) from when the remote user joins the channel to when the local user sets the remote view.
remoteJoined2UnmuteVideo - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoRenderingTracingInfo
- If the local user calls `startMediaRenderingTracing` before the remote user joins the channel, this value is the time interval (ms) from the remote user joining the channel to subscribing to the remote video stream.
remoteUid - Variable in class io.agora.rtc2.ExtensionInfo
The id of the remote user on which the extension works.
remoteUserUid - Variable in class io.agora.rtc2.LocalAudioMixerConfiguration.MixedAudioStream
The user ID of the remote user.
remoteUserUid - Variable in class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
The user ID of the remote user.
RemoteVideoStats() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
 
RemoteVoicePositionInfo - Class in io.agora.spatialaudio
 
RemoteVoicePositionInfo() - Constructor for class io.agora.spatialaudio.RemoteVoicePositionInfo
 
removeAllCaches() - Method in interface io.agora.mediaplayer.IMediaPlayerCacheManager
 
removeBackgroundImage(AgoraImage) - Method in class io.agora.rtc2.live.LiveTranscoding
remove background from background image list
removeCacheByUri(String) - Method in interface io.agora.mediaplayer.IMediaPlayerCacheManager
 
removeDestChannelInfo(String) - Method in class io.agora.rtc2.video.ChannelMediaRelayConfiguration
Removes the destination channel.
removeHandler(IRtcEngineEventHandler) - Method in class io.agora.rtc2.RtcEngine
 
removeHandlerEx(IRtcEngineEventHandler, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Removes the IRtcEngineEventHandler.
removeOldCache() - Method in interface io.agora.mediaplayer.IMediaPlayerCacheManager
 
removeRemotePosition(int) - Method in class io.agora.spatialaudio.ILocalSpatialAudioEngine
 
removeRemotePositionEx(int, RtcConnection) - Method in class io.agora.spatialaudio.ILocalSpatialAudioEngine
 
removeUser(int) - Method in class io.agora.rtc2.live.LiveTranscoding
Removes a user from CDN live.
removeVideoEffect(int) - Method in interface io.agora.rtc2.IVideoEffectObject
 
removeVideoWatermark(String) - Method in class io.agora.rtc2.RtcEngine
 
removeVideoWatermarkEx(String, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
removeWatermark(AgoraImage) - Method in class io.agora.rtc2.live.LiveTranscoding
remove watermark from list
removeWindowForUid(int) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Builder
Deprecated.
 
RENDER_MODE_ADAPTIVE - Static variable in class io.agora.rtc2.Constants
3: This mode is deprecated.
RENDER_MODE_ADAPTIVE - Static variable in class io.agora.rtc2.video.VideoCanvas
3: This mode is deprecated and Agora does not recommend using it.
RENDER_MODE_FIT - Static variable in class io.agora.rtc2.Constants
2: Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit).
RENDER_MODE_FIT - Static variable in class io.agora.rtc2.video.VideoCanvas
2: Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit).
RENDER_MODE_HIDDEN - Static variable in class io.agora.rtc2.Constants
1: Uniformly scale the video until it fills the visible boundaries (cropped).
RENDER_MODE_HIDDEN - Static variable in class io.agora.rtc2.video.VideoCanvas
1: Uniformly scale the video until it fills the visible boundaries (cropped).
rendererOutputFrameRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The output frame rate (fps) of the local video renderer.
rendererOutputFrameRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
The frame rate (fps) of rendering the remote video.
renderMode - Variable in class io.agora.rtc2.video.VideoCanvas
- RENDER_MODE_HIDDEN (1): Hidden mode.
renderMode - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
renderMode(int) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
RENEW_TOKEN_CANCELED_BY_NEW_REQUEST - Enum constant in enum class io.agora.rtc2.Constants.RenewTokenErrorCode
(6): Token update was canceled because a new request was initiated, and the previous request was canceled.
RENEW_TOKEN_FAILURE - Enum constant in enum class io.agora.rtc2.Constants.RenewTokenErrorCode
(1): Token update failed.
RENEW_TOKEN_INCONSISTENT_APPID - Enum constant in enum class io.agora.rtc2.Constants.RenewTokenErrorCode
(5): Token update failed because the App ID in the Token does not match the current App ID.
RENEW_TOKEN_INVALID_CHANNEL_NAME - Enum constant in enum class io.agora.rtc2.Constants.RenewTokenErrorCode
(4): Token update failed because the channel name in the Token does not match the current channel.
RENEW_TOKEN_INVALID_TOKEN - Enum constant in enum class io.agora.rtc2.Constants.RenewTokenErrorCode
(3): Token update failed because the provided Token is invalid.
RENEW_TOKEN_SUCCESS - Enum constant in enum class io.agora.rtc2.Constants.RenewTokenErrorCode
(0): Token updated successfully.
RENEW_TOKEN_TOKEN_EXPIRED - Enum constant in enum class io.agora.rtc2.Constants.RenewTokenErrorCode
(2): Token update failed because the provided Token has expired.
renewAgoraCDNSrcToken(String, long) - Method in interface io.agora.mediaplayer.IMediaPlayer
Deprecated.
4.6.0
renewToken(String) - Method in class io.agora.rtc2.RtcEngine
 
REQUEST_INVALID - Enum constant in enum class io.agora.rtc2.IH265TranscoderObserver.H265TranscodeResult
1: This request is invalid.
RESET - Enum constant in enum class io.agora.rtc2.IVideoEffectObject.VIDEO_EFFECT_ACTION
(2): Reset the video effect node to default parameters.
resetTextureBufferQueue() - Method in class io.agora.mediaplayer.gl.PlayerTextureHelper
 
resetTextureBufferQueue() - Method in interface io.agora.mediaplayer.IPlayerTextureHelper
 
resetWindows(List<VideoCompositingLayout.Region>) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Builder
Deprecated.
 
resume() - Method in interface io.agora.mediaplayer.IMediaPlayer
 
resumeAllChannelMediaRelay() - Method in class io.agora.rtc2.RtcEngine
 
resumeAllChannelMediaRelayEx(RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
resumeAllEffects() - Method in interface io.agora.rtc2.IAudioEffectManager
Resumes playing all audio effects.
resumeAllEffects() - Method in class io.agora.rtc2.RtcEngine
 
resumeAudio() - Method in class io.agora.rtc2.RtcEngine
Enables the audio function in the channel.
resumeAudioMixing() - Method in class io.agora.rtc2.RtcEngine
 
resumeEffect(int) - Method in interface io.agora.rtc2.IAudioEffectManager
Resumes playing the specific audio effect.
resumeEffect(int) - Method in class io.agora.rtc2.RtcEngine
 
RHYTHM_PLAYER_REASON_CAN_NOT_OPEN - Static variable in class io.agora.rtc2.Constants
801: The rhythm player can not open the file.
RHYTHM_PLAYER_REASON_CAN_NOT_PLAY - Static variable in class io.agora.rtc2.Constants
802: The rhythm player can not play the file.
RHYTHM_PLAYER_REASON_FAILED - Static variable in class io.agora.rtc2.Constants
1: he rhythm player occurs a internal error.
RHYTHM_PLAYER_REASON_FILE_OVER_DURATION_LIMIT - Static variable in class io.agora.rtc2.Constants
803: The file duration over the limit.
RHYTHM_PLAYER_REASON_OK - Static variable in class io.agora.rtc2.Constants
0: The rhythm player works well.
RHYTHM_PLAYER_STATE_DECODING - Static variable in class io.agora.rtc2.Constants
812: Files opened successfully, the rhythm player starts decoding files.
RHYTHM_PLAYER_STATE_FAILED - Static variable in class io.agora.rtc2.Constants
814: The rhythm player is starting to fail, and you need to check the error code for detailed failure reasons
RHYTHM_PLAYER_STATE_IDLE - Static variable in class io.agora.rtc2.Constants
810: The rhythm player is idle.
RHYTHM_PLAYER_STATE_OPENING - Static variable in class io.agora.rtc2.Constants
811: The rhythm player is opening files.
RHYTHM_PLAYER_STATE_PLAYING - Static variable in class io.agora.rtc2.Constants
813: Files decoded successfully, the rhythm player starts mixing the two files and playing back them locally.
right - Variable in class io.agora.spatialaudio.SpatialAudioZone
Starting at `position`, the right unit vector.
rightLength - Variable in class io.agora.spatialaudio.SpatialAudioZone
The entire sound insulation area is regarded as a cube; this represents the length of the right side in the unit length of the game engine.
ROOM_ACOUSTICS_3D_VOICE - Static variable in class io.agora.rtc2.Constants
A 3D voice effect that makes the voice appear to be moving around the user.
ROOM_ACOUSTICS_CHORUS - Static variable in class io.agora.rtc2.Constants
An audio effect for chorus.
ROOM_ACOUSTICS_ETHEREAL - Static variable in class io.agora.rtc2.Constants
A more ethereal audio effect.
ROOM_ACOUSTICS_KTV - Static variable in class io.agora.rtc2.Constants
An audio effect typical of a KTV venue.
ROOM_ACOUSTICS_PHONOGRAPH - Static variable in class io.agora.rtc2.Constants
An audio effect typical of a vintage phonograph.
ROOM_ACOUSTICS_SPACIAL - Static variable in class io.agora.rtc2.Constants
A more spatial audio effect.
ROOM_ACOUSTICS_STUDIO - Static variable in class io.agora.rtc2.Constants
An audio effect typical of a recording studio.
ROOM_ACOUSTICS_VIRTUAL_STEREO - Static variable in class io.agora.rtc2.Constants
A virtual stereo effect that renders monophonic audio as stereo audio.
ROOM_ACOUSTICS_VIRTUAL_SURROUND_SOUND - Static variable in class io.agora.rtc2.Constants
virtual suround sound.
ROOM_ACOUSTICS_VOCAL_CONCERT - Static variable in class io.agora.rtc2.Constants
An audio effect typical of a concert hall.
rotation - Variable in class io.agora.rtc2.video.AgoraVideoFrame
Raw data related parameter.
rotation - Variable in class io.agora.rtc2.video.EncodedVideoFrameInfo
Rotation information of the video frame, as the following: - 0: (Default) 0 degree.
RTC_IMAGE_GIF_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
10: Video for gif image.
RTC_IMAGE_JPEG_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
9: Video for jpeg image.
RTC_IMAGE_PNG_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
8: Video for png image.
RtcConnection - Class in io.agora.rtc2
 
RtcConnection() - Constructor for class io.agora.rtc2.RtcConnection
 
RtcConnection(String, int) - Constructor for class io.agora.rtc2.RtcConnection
 
RtcConnection.CONNECTION_STATE_TYPE - Enum Class in io.agora.rtc2
Connection state types.
RtcEngine - Class in io.agora.rtc2
Main interface class of the Agora Native SDK.
RtcEngine() - Constructor for class io.agora.rtc2.RtcEngine
 
RtcEngineConfig - Class in io.agora.rtc2
 
RtcEngineConfig() - Constructor for class io.agora.rtc2.RtcEngineConfig
 
RtcEngineConfig.AreaCode - Class in io.agora.rtc2
 
RtcEngineConfig.LogConfig - Class in io.agora.rtc2
 
RtcEngineEx - Class in io.agora.rtc2
 
RtcEngineEx() - Constructor for class io.agora.rtc2.RtcEngineEx
 
RtcEngineInternal - Class in io.agora.rtc2
 
RtcEngineInternal() - Constructor for class io.agora.rtc2.RtcEngineInternal
 
RtcStats() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
 
RTMP_STREAM_PUBLISH_REASON_CONNECTION_TIMEOUT - Static variable in class io.agora.rtc2.Constants
3.
RTMP_STREAM_PUBLISH_REASON_ENCRYPTED_STREAM_NOT_ALLOWED - Static variable in class io.agora.rtc2.Constants
2: The RTMP or RTMPS streaming is encrypted and cannot be published.
RTMP_STREAM_PUBLISH_REASON_FORMAT_NOT_SUPPORTED - Static variable in class io.agora.rtc2.Constants
10: The format of the RTMP or RTMPS streaming URL is not supported.
RTMP_STREAM_PUBLISH_REASON_INTERNAL_SERVER_ERROR - Static variable in class io.agora.rtc2.Constants
4.
RTMP_STREAM_PUBLISH_REASON_INVALID_APPID - Static variable in class io.agora.rtc2.Constants
15: User AppId have not authorized to push stream.
RTMP_STREAM_PUBLISH_REASON_INVALID_ARGUMENT - Static variable in class io.agora.rtc2.Constants
1.
RTMP_STREAM_PUBLISH_REASON_INVALID_PRIVILEGE - Static variable in class io.agora.rtc2.Constants
16: invalid privilege.
RTMP_STREAM_PUBLISH_REASON_NET_DOWN - Static variable in class io.agora.rtc2.Constants
14: Network error.
RTMP_STREAM_PUBLISH_REASON_NOT_AUTHORIZED - Static variable in class io.agora.rtc2.Constants
8: The host manipulates other hosts' URLs.
RTMP_STREAM_PUBLISH_REASON_NOT_BROADCASTER - Static variable in class io.agora.rtc2.Constants
11: Current role is not broadcaster.
RTMP_STREAM_PUBLISH_REASON_OK - Static variable in class io.agora.rtc2.Constants
0: The RTMP or RTMPS streaming publishes successfully.
RTMP_STREAM_PUBLISH_REASON_REACH_LIMIT - Static variable in class io.agora.rtc2.Constants
7: The host publishes more than 10 URLs.
RTMP_STREAM_PUBLISH_REASON_RTMP_SERVER_ERROR - Static variable in class io.agora.rtc2.Constants
5: An error occurs in the CDN server.
RTMP_STREAM_PUBLISH_REASON_STREAM_NOT_FOUND - Static variable in class io.agora.rtc2.Constants
9: Agora server fails to find the RTMP or RTMPS streaming.
RTMP_STREAM_PUBLISH_REASON_TOO_OFTEN - Static variable in class io.agora.rtc2.Constants
6: The RTMP or RTMPS streaming publishes too frequently.
RTMP_STREAM_PUBLISH_REASON_TRANSCODING_NO_MIX_STREAM - Static variable in class io.agora.rtc2.Constants
13: Call updateTranscoding, but no mix stream.
RTMP_STREAM_PUBLISH_STATE_CONNECTING - Static variable in class io.agora.rtc2.Constants
1: The SDK is connecting to the streaming server and the RTMP server.
RTMP_STREAM_PUBLISH_STATE_DISCONNECTING - Static variable in class io.agora.rtc2.Constants
5: The SDK is disconnecting to Agora's streaming server and the CDN server.
RTMP_STREAM_PUBLISH_STATE_FAILURE - Static variable in class io.agora.rtc2.Constants
4: The RTMP streaming fails.
RTMP_STREAM_PUBLISH_STATE_IDLE - Static variable in class io.agora.rtc2.Constants
0: The RTMP streaming has not started or has ended.
RTMP_STREAM_PUBLISH_STATE_RECOVERING - Static variable in class io.agora.rtc2.Constants
3: The RTMP streaming is recovering.
RTMP_STREAM_PUBLISH_STATE_RUNNING - Static variable in class io.agora.rtc2.Constants
2: The RTMP streaming publishes.
RTMP_STREAM_UNPUBLISH_REASON_OK - Static variable in class io.agora.rtc2.Constants
100: The streaming has been stopped normally.
RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT - Static variable in class io.agora.rtc2.Constants
3: advanced feature not support
RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE - Static variable in class io.agora.rtc2.Constants
1: An error occurs when you add a background image or a watermark image to the RTMP or RTMPS stream.
RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN - Static variable in class io.agora.rtc2.Constants
4: Client request too frequently.
RTMP_STREAMING_EVENT_URL_ALREADY_IN_USE - Static variable in class io.agora.rtc2.Constants
2: The streaming URL is already being used for CDN live streaming.
rtt - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LastmileProbeResult
The round-trip time (ms).
RUNNING - Enum constant in enum class io.agora.rtc2.DirectCdnStreamingState
Deprecated.
1: Streams are being pushed to the CDN.
rxAudioBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
Total number of audio bytes received (bytes) before network countermeasures, represented by an aggregate value.
rxAudioBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The total number of audio bytes received, represented by an aggregate value.
rxAudioKBitRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The bitrate (Kbps) of receiving the audio.
rxBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The number of bytes received.
rxKBitRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.PathStats
The receiving bitrate of the path in Kbps.
rxKBitRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The receiving bitrate (Kbps).
rxPacketLossRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The packet loss rate (%) from the Agora server to the client before using the anti-packet-loss method.
rxStreamType - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
The type of the video stream.
rxVideoBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
Total number of video bytes received (bytes), represented by an aggregate value.
rxVideoBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The total number of video bytes received, represented by an aggregate value.
rxVideoKBitRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The bitrate (Kbps) of receiving the video.

S

sample_rate - Variable in class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
Sampling rate (Hz) for recording audio.
sampleRataHz - Variable in class io.agora.base.AudioFrame
The number of samples per channel in the audio frame.
sampleRate - Variable in class io.agora.rtc2.audio.AudioParams
The audio sample rate (Hz), which can be set as one of the following values: - 8000.
sampleRate - Variable in class io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters
Audio sample rate (Hz).
samplesPerCall - Variable in class io.agora.rtc2.audio.AudioParams
The number of samples, such as 1024 for the media push.
samplesPerChannel - Variable in class io.agora.base.AudioFrame
The number of samples per channel in the audio frame.
SAVE - Enum constant in enum class io.agora.rtc2.IVideoEffectObject.VIDEO_EFFECT_ACTION
(1): Save the current parameters of the video effect node.
SCREEN_CAPTURE - Static variable in class io.agora.rtc2.Constants
 
SCREEN_CAPTURE_CONTENT_HINT_DETAILS - Static variable in class io.agora.rtc2.Constants
2: Motionless content.
SCREEN_CAPTURE_CONTENT_HINT_MOTION - Static variable in class io.agora.rtc2.Constants
1: Motion-intensive content.
SCREEN_CAPTURE_CONTENT_HINT_NONE - Static variable in class io.agora.rtc2.Constants
0: No content hint.
SCREEN_COLOR_AUTO - Static variable in class io.agora.rtc2.video.SegmentationProperty
0: (Default) Automatically recognizes the screen color.
SCREEN_COLOR_BLUE - Static variable in class io.agora.rtc2.video.SegmentationProperty
2: Blue.
SCREEN_COLOR_GREEN - Static variable in class io.agora.rtc2.video.SegmentationProperty
1: Green.
SCREEN_SCENARIO_DOCUMENT - Enum constant in enum class io.agora.rtc2.Constants.ScreenScenarioType
1: (Default) Document.
SCREEN_SCENARIO_GAMING - Enum constant in enum class io.agora.rtc2.Constants.ScreenScenarioType
2: Game.
SCREEN_SCENARIO_VIDEO - Enum constant in enum class io.agora.rtc2.Constants.ScreenScenarioType
3: Video.
ScreenCaptureParameters - Class in io.agora.rtc2
 
ScreenCaptureParameters() - Constructor for class io.agora.rtc2.ScreenCaptureParameters
 
ScreenCaptureParameters.AudioCaptureParameters - Class in io.agora.rtc2
 
ScreenCaptureParameters.VideoCaptureParameters - Class in io.agora.rtc2
 
screenColorType - Variable in class io.agora.rtc2.video.SegmentationProperty
The screen color: - SCREEN_COLOR_AUTO (0): The SDK automatically selects the screen color.
SECONDARY_CAMERA_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
3: A secondary camera.
SECONDARY_SCREEN_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
5: Video captured by secondary screen capturer.
seek(long) - Method in class io.agora.mediaplayer.AssetsFileReader
 
seek(long) - Method in class io.agora.mediaplayer.ContentFileReader
 
seek(long) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
SEG_MODEL_AI - Static variable in class io.agora.rtc2.video.SegmentationProperty
1: (Default) AI segmentation algorithm.
SEG_MODEL_GREEN - Static variable in class io.agora.rtc2.video.SegmentationProperty
2: Green screen segmentation algorithm.
SegmentationProperty - Class in io.agora.rtc2.video
 
SegmentationProperty() - Constructor for class io.agora.rtc2.video.SegmentationProperty
 
SegmentationProperty(int, float) - Constructor for class io.agora.rtc2.video.SegmentationProperty
 
selectAudioTrack(int) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
selectAudioTrack(int) - Method in class io.agora.rtc2.RtcEngine
 
selectInternalSubtitle(int) - Method in interface io.agora.mediaplayer.IMediaPlayer
select internal subtitles in video
selectMultiAudioTrack(int, int) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
sendAudioMetadata(byte[]) - Method in class io.agora.rtc2.RtcEngine
 
sendAudioMetadataEx(byte[], RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Send audio metadata.
sendCustomReportMessage(String, String, String, String, int) - Method in class io.agora.rtc2.RtcEngine
 
sendCustomReportMessageEx(String, String, String, String, int, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
sendMediaControlMessage(int, byte[]) - Method in class io.agora.rtc2.RtcEngine
 
sendMediaControlMessageEx(int, byte[], RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
sendRdtMessage(int, int, byte[]) - Method in class io.agora.rtc2.RtcEngine
 
sendRdtMessageEx(int, int, byte[], RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
sendStreamMessage(int, byte[]) - Method in class io.agora.rtc2.RtcEngine
 
sendStreamMessageEx(int, byte[], RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
sentBitrate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalAudioStats
The average bitrate (Kbps) of sending the local user's audio stream.
sentBitrate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The actual bitrate (Kbps) while sending the local video stream.
sentFrameRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The actual frame rate (fps) while sending the local video stream.
sentSampleRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalAudioStats
The sampling rate (Hz) of sending the local user's audio stream.
SERVER_INTERNAL_ERROR - Enum constant in enum class io.agora.rtc2.IH265TranscoderObserver.H265TranscodeResult
9: Internal Server Error, you can try sending the request again.
serverConfig - Variable in class io.agora.rtc2.video.ContentInspectConfig
(Optional) Server configuration related to uploading video screenshots via extensions from Agora Extensions Marketplace.
serverDomain - Variable in class io.agora.rtc2.proxy.LocalAccessPointConfiguration.LogUploadServerInfo
The domain name of the log server.
serverHttps - Variable in class io.agora.rtc2.proxy.LocalAccessPointConfiguration.LogUploadServerInfo
Whether the log server uses the HTTPS protocol: - `true`: Uses the HTTPS protocol.
serverPath - Variable in class io.agora.rtc2.proxy.LocalAccessPointConfiguration.LogUploadServerInfo
The storage path of the log on the server.
serverPort - Variable in class io.agora.rtc2.proxy.LocalAccessPointConfiguration.LogUploadServerInfo
The port of the log server.
SERVICE_UNAVAILABLE - Enum constant in enum class io.agora.rtc2.IH265TranscoderObserver.H265TranscodeResult
10: Service is unavailable.
setAdvancedAudioOptions(AdvancedAudioOptions) - Method in class io.agora.rtc2.RtcEngine
 
setAdvancedFeatures(String, Boolean) - Method in class io.agora.rtc2.live.LiveTranscoding
Enables/Disables advanced features of the RTMP or RTMPS streaming with transcoding.
setAINSMode(boolean, int) - Method in class io.agora.rtc2.RtcEngine
 
setApiCallMode(int) - Method in class io.agora.rtc2.RtcEngineInternal
 
setAudioBitrate(long) - Method in class io.agora.mediaplayer.data.PlayerPlaybackStats
 
setAudioBitsPerSample(long) - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
Set the audio bits per sample.
setAudioBytesPerSample(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setAudioChannels(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setAudioChannels(long) - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
Set the audio channels.
setAudioDualMonoMode(int) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
setAudioEffectParameters(int, int, int) - Method in class io.agora.rtc2.RtcEngine
 
setAudioEffectPreset(int) - Method in class io.agora.rtc2.RtcEngine
 
setAudioMixingDualMonoMode(Constants.AudioMixingDualMonoMode) - Method in class io.agora.rtc2.RtcEngine
 
setAudioMixingPitch(int) - Method in class io.agora.rtc2.RtcEngine
 
setAudioMixingPlaybackSpeed(int) - Method in class io.agora.rtc2.RtcEngine
 
setAudioMixingPosition(int) - Method in class io.agora.rtc2.RtcEngine
 
setAudioPitch(int) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
setAudioProfile(int) - Method in class io.agora.rtc2.RtcEngine
 
setAudioProfile(int, int) - Method in class io.agora.rtc2.RtcEngine
 
setAudioRecvRange(float) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
 
setAudioSampleRate(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setAudioSampleRate(long) - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
Set the audio sample rate.
setAudioScenario(int) - Method in class io.agora.rtc2.RtcEngine
 
setAutoPlay(boolean) - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
setAVSyncSource(String, int) - Method in class io.agora.rtc2.RtcEngine
 
setBackgroundColor(int) - Method in class io.agora.rtc2.live.LiveTranscoding
Sets the background color of the CDN live stream in the format of RGB hex.
setBackgroundColor(int, int, int) - Method in class io.agora.rtc2.live.LiveTranscoding
Sets the background color in RGB format.
setBeautyEffectOptions(boolean, BeautyOptions) - Method in class io.agora.rtc2.RtcEngine
 
setBeautyEffectOptions(boolean, BeautyOptions, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
 
setBitrateInKbps(int) - Method in class io.agora.mediaplayer.data.SrcInfo
 
setBlue(int) - Method in class io.agora.rtc2.live.LiveTranscoding
Deprecated.
Sets the background color's blue component.
setCacheDir(String) - Method in interface io.agora.mediaplayer.IMediaPlayerCacheManager
 
setCacheSize(long) - Method in class io.agora.mediaplayer.data.CacheStatistics
 
setCameraAutoFocusFaceModeEnabled(boolean) - Method in class io.agora.rtc2.RtcEngine
 
setCameraCapturerConfiguration(CameraCapturerConfiguration) - Method in class io.agora.rtc2.RtcEngine
 
setCameraExposureFactor(int) - Method in class io.agora.rtc2.RtcEngine
 
setCameraExposurePosition(float, float) - Method in class io.agora.rtc2.RtcEngine
 
setCameraFocusPositionInPreview(float, float) - Method in class io.agora.rtc2.RtcEngine
 
setCameraTorchOn(boolean) - Method in class io.agora.rtc2.RtcEngine
 
setCameraZoomFactor(float) - Method in class io.agora.rtc2.RtcEngine
 
setCanvas(int, int) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Builder
Deprecated.
 
setCanvas(int, int, String) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Builder
Deprecated.
 
setChannelProfile(int) - Method in class io.agora.rtc2.RtcEngine
 
setClientRole(int) - Method in class io.agora.rtc2.RtcEngine
 
setClientRole(int, ClientRoleOptions) - Method in class io.agora.rtc2.RtcEngine
 
setCloudProxy(int) - Method in class io.agora.rtc2.RtcEngine
 
SetCodecCapMask(int) - Method in class io.agora.rtc2.video.CodecCapInfo
 
setCodecName(String) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
SetCodecType(int) - Method in class io.agora.rtc2.video.CodecCapInfo
 
setColorEnhanceOptions(boolean, ColorEnhanceOptions) - Method in class io.agora.rtc2.RtcEngine
 
setColorEnhanceOptions(boolean, ColorEnhanceOptions, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
 
setDefaultAudioRoutetoSpeakerphone(boolean) - Method in class io.agora.rtc2.RtcEngine
 
setDestChannelInfo(String, ChannelMediaInfo) - Method in class io.agora.rtc2.video.ChannelMediaRelayConfiguration
Sets the information of the destination channel.
setDeviceId(String) - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
Set the device ID.
setDirectCdnStreamingAudioConfiguration(int) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
v4.6.0.
setDirectCdnStreamingVideoConfiguration(VideoEncoderConfiguration) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
v4.6.0.
setDistanceUnit(float) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
 
setDownloadSize(long) - Method in class io.agora.mediaplayer.data.CacheStatistics
 
setDualStreamMode(Constants.SimulcastStreamMode) - Method in class io.agora.rtc2.RtcEngine
 
setDualStreamMode(Constants.SimulcastStreamMode, SimulcastStreamConfig) - Method in class io.agora.rtc2.RtcEngine
 
setDualStreamModeEx(Constants.SimulcastStreamMode, SimulcastStreamConfig, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
setDuration(long) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setEarMonitoringAudioFrameParameters(int, int, int, int) - Method in class io.agora.rtc2.RtcEngine
 
setEffectPosition(int, int) - Method in class io.agora.rtc2.RtcEngine
 
setEffectsVolume(double) - Method in interface io.agora.rtc2.IAudioEffectManager
Sets the volume of audio effects.
setEffectsVolume(double) - Method in class io.agora.rtc2.RtcEngine
 
setEnableCache(boolean) - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
setEnableMultiAudioTrack(boolean) - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
setEnableSpeakerphone(boolean) - Method in class io.agora.rtc2.RtcEngine
 
setEncodedFrameOnly(boolean) - Method in class io.agora.rtc2.video.VideoSubscriptionOptions
 
setExtensionProperty(String, String, ExtensionInfo, String, String) - Method in class io.agora.rtc2.RtcEngine
Sets the properties of an extension.
setExtensionProperty(String, String, String, String) - Method in class io.agora.rtc2.RtcEngine
 
setExtensionProperty(String, String, String, String, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
Sets the properties of an extension.
setExtensionProviderProperty(String, String, String) - Method in class io.agora.rtc2.RtcEngine
 
setExternalAudioSink(boolean, int, int) - Method in class io.agora.rtc2.RtcEngine
 
setExternalAudioSource(boolean, int, int) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
This method is deprecated. Use createCustomAudioTrack(Constants.AudioTrackType trackType, AudioTrackConfig config) instead.
setExternalAudioSource(boolean, int, int, boolean, boolean) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
This method is deprecated. Use createCustomAudioTrack(Constants.AudioTrackType trackType, AudioTrackConfig config) instead.
setExternalMediaProjection(MediaProjection) - Method in class io.agora.rtc2.RtcEngine
 
setExternalRemoteEglContext(Object) - Method in class io.agora.rtc2.RtcEngine
 
setExternalSubtitle(String) - Method in interface io.agora.mediaplayer.IMediaPlayer
set an external subtitle for video
setExternalVideoSource(boolean, boolean, Constants.ExternalVideoSourceType) - Method in class io.agora.rtc2.RtcEngine
 
setExternalVideoSource(boolean, boolean, Constants.ExternalVideoSourceType, EncodedVideoTrackOptions) - Method in class io.agora.rtc2.RtcEngine
Sets the external video source.
setFaceShapeAreaOptions(FaceShapeAreaOptions) - Method in class io.agora.rtc2.RtcEngine
 
setFaceShapeAreaOptions(FaceShapeAreaOptions, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
 
setFaceShapeBeautyOptions(boolean, FaceShapeBeautyOptions) - Method in class io.agora.rtc2.RtcEngine
 
setFaceShapeBeautyOptions(boolean, FaceShapeBeautyOptions, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
 
setFileSize(long) - Method in class io.agora.mediaplayer.data.CacheStatistics
 
setFilterEffectOptions(boolean, FilterEffectOptions) - Method in class io.agora.rtc2.RtcEngine
 
setFilterEffectOptions(boolean, FilterEffectOptions, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
 
setGreen(int) - Method in class io.agora.rtc2.live.LiveTranscoding
Deprecated.
Sets the background color's green component.
setHeadphoneEQParameters(int, int) - Method in class io.agora.rtc2.RtcEngine
 
setHeadphoneEQPreset(int) - Method in class io.agora.rtc2.RtcEngine
 
setHighPriorityUserList(int[], int) - Method in class io.agora.rtc2.RtcEngine
Sets the high priority user list and related fallback option for the remotely subscribed video stream based on the network conditions in NASA2.
setHighPriorityUserListEx(int[], int, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Sets the high priority user list and related fallback option for the remotely subscribed video stream based on the network conditions in NASA2.
setHighQualityAudioParameters(boolean, boolean, boolean) - Method in class io.agora.rtc2.RtcEngine
Sets high-quality audio preferences.
setInEarMonitoringVolume(int) - Method in class io.agora.rtc2.RtcEngine
 
setInternalPlayerUuid(String) - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
Set the internal player UUID.
setLanguage(String) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setLocalAccessPoint(LocalAccessPointConfiguration) - Method in class io.agora.rtc2.RtcEngine
 
setLocalRenderMode(int) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
setLocalRenderMode(int, int) - Method in class io.agora.rtc2.RtcEngine
 
setLocalRenderTargetFps(Constants.VideoSourceType, int) - Method in class io.agora.rtc2.RtcEngine
 
setLocalVideoMirrorMode(int) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
setLocalVoiceEqualization(Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY, int) - Method in class io.agora.rtc2.RtcEngine
 
setLocalVoiceFormant(double) - Method in class io.agora.rtc2.RtcEngine
 
setLocalVoicePitch(double) - Method in class io.agora.rtc2.RtcEngine
 
setLocalVoiceReverb(Constants.AUDIO_REVERB_TYPE, int) - Method in class io.agora.rtc2.RtcEngine
 
setLogFile(String) - Method in class io.agora.rtc2.RtcEngine
 
setLogFileSize(long) - Method in class io.agora.rtc2.RtcEngine
 
setLogFilter(int) - Method in class io.agora.rtc2.RtcEngine
 
setLogLevel(int) - Method in class io.agora.rtc2.RtcEngine
 
setLoopCount(int) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
setLowlightEnhanceOptions(boolean, LowLightEnhanceOptions) - Method in class io.agora.rtc2.RtcEngine
 
setLowlightEnhanceOptions(boolean, LowLightEnhanceOptions, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
 
setMaxAudioRecvCount(int) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
 
setMaxCacheFileCount(int) - Method in interface io.agora.mediaplayer.IMediaPlayerCacheManager
 
setMaxCacheFileSize(long) - Method in interface io.agora.mediaplayer.IMediaPlayerCacheManager
 
setMediaRecorderObserver(IMediaRecorderCallback) - Method in class io.agora.rtc2.AgoraMediaRecorder
 
setMediaStreamType(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setMixedAudioFrameParameters(int, int, int) - Method in class io.agora.rtc2.RtcEngine
 
setMockGDPAndroid(boolean) - Static method in class io.agora.rtc2.internal.gdp.GDPAndroid
 
setMockNonEGLContext(boolean) - Static method in class io.agora.rtc2.internal.gdp.EglCore
 
setName(String) - Method in class io.agora.mediaplayer.data.SrcInfo
 
setParameters(String) - Method in class io.agora.rtc2.RtcEngine
 
setParametersEx(String, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Provides technical preview functionalities or special customizations by configuring the SDK with JSON options.
setPlaybackAudioFrameBeforeMixingParameters(int, int) - Method in class io.agora.rtc2.RtcEngine
 
setPlaybackAudioFrameBeforeMixingParameters(int, int, int) - Method in class io.agora.rtc2.RtcEngine
 
setPlaybackAudioFrameParameters(int, int, int, int) - Method in class io.agora.rtc2.RtcEngine
 
setPlaybackSpeed(int) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
setPlayerAttenuation(int, double, boolean) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
 
setPlayerOption(String, int) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
setPlayerOptionString(String, String) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
setPreferHeadset(boolean) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
This method is deprecated.
setProfile(String, boolean) - Method in class io.agora.rtc2.RtcEngineInternal
 
setProvider(IMediaPlayerCustomDataProvider) - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
setRecordingAudioFrameParameters(int, int, int, int) - Method in class io.agora.rtc2.RtcEngine
 
setRed(int) - Method in class io.agora.rtc2.live.LiveTranscoding
Deprecated.
Sets the background color's red component.
setRemoteAudioAttenuation(int, double, boolean) - Method in class io.agora.spatialaudio.ILocalSpatialAudioEngine
 
setRemoteDefaultVideoStreamType(int) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
setRemoteDefaultVideoStreamType(Constants.VideoStreamType) - Method in class io.agora.rtc2.RtcEngine
 
setRemoteRenderMode(int, int) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
setRemoteRenderMode(int, int, int) - Method in class io.agora.rtc2.RtcEngine
 
setRemoteRenderModeEx(int, int, int, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
setRemoteRenderTargetFps(int) - Method in class io.agora.rtc2.RtcEngine
 
setRemoteSubscribeFallbackOption(int) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
setRemoteSubscribeFallbackOption(Constants.StreamFallbackOptions) - Method in class io.agora.rtc2.RtcEngine
 
setRemoteUserPriority(int, int) - Method in class io.agora.rtc2.RtcEngine
Sets the priority of a remote user's media stream.
setRemoteUserSpatialAudioParams(int, SpatialAudioParams) - Method in class io.agora.rtc2.RtcEngine
 
setRemoteUserSpatialAudioParamsEx(int, SpatialAudioParams, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Sets the 3D sound position of a remote user.
setRemoteVideoStreamType(int, int) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
setRemoteVideoStreamType(int, Constants.VideoStreamType) - Method in class io.agora.rtc2.RtcEngine
 
setRemoteVideoStreamTypeEx(int, int, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Deprecated.
setRemoteVideoStreamTypeEx(int, Constants.VideoStreamType, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
setRemoteVideoSubscriptionOptions(int, VideoSubscriptionOptions) - Method in class io.agora.rtc2.RtcEngine
 
setRemoteVideoSubscriptionOptionsEx(int, VideoSubscriptionOptions, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
setRemoteVoicePosition(int, double, double) - Method in class io.agora.rtc2.RtcEngine
 
setRemoteVoicePositionEx(int, double, double, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
setRenderMode(int) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
setRouteInCommunicationMode(int) - Method in class io.agora.rtc2.RtcEngine
 
setScreenCaptureScenario(Constants.ScreenScenarioType) - Method in class io.agora.rtc2.RtcEngine
 
setSimulcastConfig(SimulcastConfig) - Method in class io.agora.rtc2.RtcEngine
 
setSimulcastConfigEx(SimulcastConfig, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
setSpatialAudioParams(SpatialAudioParams) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
setSrcChannelInfo(ChannelMediaInfo) - Method in class io.agora.rtc2.video.ChannelMediaRelayConfiguration
Sets the information of the source channel.
setStartPos(long) - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
setStreamIndex(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setStreamType(VideoSubscriptionOptions.REMOTE_VIDEO_STREAM_TYPE) - Method in class io.agora.rtc2.video.VideoSubscriptionOptions
 
setSubscribeAudioAllowlist(int[]) - Method in class io.agora.rtc2.RtcEngine
 
setSubscribeAudioAllowlistEx(int[], RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
setSubscribeAudioBlocklist(int[]) - Method in class io.agora.rtc2.RtcEngine
 
setSubscribeAudioBlocklistEx(int[], RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
setSubscribeVideoAllowlist(int[]) - Method in class io.agora.rtc2.RtcEngine
 
setSubscribeVideoAllowlistEx(int[], RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
setSubscribeVideoBlocklist(int[]) - Method in class io.agora.rtc2.RtcEngine
 
setSubscribeVideoBlocklistEx(int[], RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
setTextureId(int, android.opengl.EGLContext, int, int, long) - Method in class io.agora.rtc2.RtcEngineInternal
 
setTextureId(int, EGLContext, int, int, long) - Method in class io.agora.rtc2.RtcEngineInternal
Sets the texture ID to MediaCodec.
setTextureSize(int, int) - Method in class io.agora.mediaplayer.gl.PlayerTextureHelper
 
setTextureSize(int, int) - Method in interface io.agora.mediaplayer.IPlayerTextureHelper
 
setTotalBitrate(long) - Method in class io.agora.mediaplayer.data.PlayerPlaybackStats
 
SetUid(int) - Method in class io.agora.rtc2.UserInfo
 
setupAudioAttributes(AudioAttributes) - Method in class io.agora.rtc2.RtcEngine
配置AudioAttribute
setupLocalVideo(VideoCanvas) - Method in class io.agora.rtc2.RtcEngine
 
setupMode - Variable in class io.agora.rtc2.video.VideoCanvas
Setting mode of the view.
setupRemoteVideo(VideoCanvas) - Method in class io.agora.rtc2.RtcEngine
 
setupRemoteVideoEx(VideoCanvas, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
setUri(String) - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
setUrl(String) - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
SetUserAccount(String) - Method in class io.agora.rtc2.UserInfo
 
setUsers(ArrayList<LiveTranscoding.TranscodingUser>) - Method in class io.agora.rtc2.live.LiveTranscoding
Sets the users in batches in CDN live.
setUsers(Map<Integer, LiveTranscoding.TranscodingUser>) - Method in class io.agora.rtc2.live.LiveTranscoding
Sets the users in batches in CDN live.
setVideoBitrate(long) - Method in class io.agora.mediaplayer.data.PlayerPlaybackStats
 
setVideoBitRate(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setVideoDenoiserOptions(boolean, VideoDenoiserOptions) - Method in class io.agora.rtc2.RtcEngine
 
setVideoDenoiserOptions(boolean, VideoDenoiserOptions, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
 
setVideoEffectBoolParam(String, String, boolean) - Method in interface io.agora.rtc2.IVideoEffectObject
 
setVideoEffectFloatParam(String, String, float) - Method in interface io.agora.rtc2.IVideoEffectObject
 
setVideoEffectIntParam(String, String, int) - Method in interface io.agora.rtc2.IVideoEffectObject
 
setVideoEncoderConfiguration(VideoEncoderConfiguration) - Method in class io.agora.rtc2.RtcEngine
 
setVideoEncoderConfigurationEx(VideoEncoderConfiguration, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
setVideoFps(long) - Method in class io.agora.mediaplayer.data.PlayerPlaybackStats
 
setVideoFrameRate(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setVideoHeight(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setVideoHeight(long) - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
Set the video height.
setVideoQoEPreference(Constants.QoEPreference) - Method in class io.agora.rtc2.RtcEngine
Sets the video qoe preference.
setVideoQualityParameters(boolean) - Method in class io.agora.rtc2.RtcEngine
Sets the video quality preferences.
setVideoRotation(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setVideoScenario(Constants.VideoScenario) - Method in class io.agora.rtc2.RtcEngine
 
setVideoWidth(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setVideoWidth(long) - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
Set the video width.
setView(View) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
setVoiceBeautifierParameters(int, int, int) - Method in class io.agora.rtc2.RtcEngine
 
setVoiceBeautifierPreset(int) - Method in class io.agora.rtc2.RtcEngine
 
setVoiceConversionParameters(int, int, int) - Method in class io.agora.rtc2.RtcEngine
Set parameters for SDK preset voice conversion.
setVoiceConversionPreset(int) - Method in class io.agora.rtc2.RtcEngine
 
setVolumeOfEffect(int, double) - Method in interface io.agora.rtc2.IAudioEffectManager
Sets the volume of the specified audio effect.
setVolumeOfEffect(int, double) - Method in class io.agora.rtc2.RtcEngine
 
setZones(SpatialAudioZone[]) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
 
shapeArea - Variable in class io.agora.rtc2.video.FaceShapeAreaOptions
Facial enhancement areas.
shapeIntensity - Variable in class io.agora.rtc2.video.FaceShapeAreaOptions
The intensity of the enhancement.
shapeStyle - Variable in class io.agora.rtc2.video.FaceShapeBeautyOptions
Facial enhancement style options: - FACE_SHAPE_BEAUTY_STYLE_FEMALE 0: (Default) Female.
sharpnessLevel - Variable in class io.agora.rtc2.video.BeautyOptions
The sharpness level, in the range [0.0,1.0], where 0.0 means the original sharpness.
SimulcastConfig - Class in io.agora.rtc2
 
SimulcastConfig() - Constructor for class io.agora.rtc2.SimulcastConfig
 
SimulcastConfig.StreamLayerConfig - Class in io.agora.rtc2
 
SimulcastConfig.StreamLayerIndex - Enum Class in io.agora.rtc2
 
SimulcastStreamConfig - Class in io.agora.rtc2
 
SimulcastStreamConfig() - Constructor for class io.agora.rtc2.SimulcastStreamConfig
 
SimulcastStreamConfig(VideoEncoderConfiguration.VideoDimensions, int, int) - Constructor for class io.agora.rtc2.SimulcastStreamConfig
 
SINGING_BEAUTIFIER - Static variable in class io.agora.rtc2.Constants
Singing beautifier effect.
size(double, double) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
size(int, int) - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
Sets the stream resolution.
skinProtectLevel - Variable in class io.agora.rtc2.video.ColorEnhanceOptions
The level of skin tone protection.
smoothnessLevel - Variable in class io.agora.rtc2.video.BeautyOptions
The smoothness level, in the range [0.0,1.0], where 0.0 means the original smoothness.
SnapshotConfig - Class in io.agora.rtc2.video
 
SnapshotConfig() - Constructor for class io.agora.rtc2.video.SnapshotConfig
 
SOFTWARE_ENCODER - Static variable in class io.agora.rtc2.Constants
Software encoder.
source - Variable in class io.agora.rtc2.video.VirtualBackgroundSource
The local absolute path of the custom background image.
sourceType - Variable in class io.agora.rtc2.LocalAudioMixerConfiguration.MixedAudioStream
The type of the audio source.
sourceType - Variable in class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
The video source type for local video mixing.
sourceType - Variable in class io.agora.rtc2.video.VideoCanvas
The type of the video source.
SpatialAudioParams - Class in io.agora.rtc2
 
SpatialAudioParams() - Constructor for class io.agora.rtc2.SpatialAudioParams
 
SpatialAudioZone - Class in io.agora.spatialaudio
 
SpatialAudioZone() - Constructor for class io.agora.spatialaudio.SpatialAudioZone
 
speaker_attenuation - Variable in class io.agora.rtc2.SpatialAudioParams
The sound attenuation coefficient of the remote user or media player.
speaker_azimuth - Variable in class io.agora.rtc2.SpatialAudioParams
The azimuth angle of the remote user or media player relative to the local user.
speaker_distance - Variable in class io.agora.rtc2.SpatialAudioParams
The distance of the remote user or media player relative to the local user.
speaker_elevation - Variable in class io.agora.rtc2.SpatialAudioParams
The elevation angle of the remote user or media player relative to the local user.
speaker_orientation - Variable in class io.agora.rtc2.SpatialAudioParams
The orientation of the remote user or media player relative to the local user.
SPEECH_DRIVEN_VIDEO_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
13: Video processed by the speech driven extension.
SPEECH_STANDARD - Enum constant in enum class io.agora.rtc2.Constants.AudioProfile
1: A sample rate of 32 kHz, audio encoding, mono, and a bitrate of up to 18 Kbps.
SrcInfo - Class in io.agora.mediaplayer.data
 
SrcInfo() - Constructor for class io.agora.mediaplayer.data.SrcInfo
 
SrcInfo(int, String) - Constructor for class io.agora.mediaplayer.data.SrcInfo
 
STANDARD_BITRATE - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
0: The standard bitrate mode.
start2JoinChannel - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoRenderingTracingInfo
The time interval (ms) from `startMediaRenderingTracing` to `joinChannel(String token, String channelId, String optionalInfo, int uid)` or `joinChannel(String token, String channelId, int uid, ChannelMediaOptions options)` .
startAudioMixing(String, boolean, int) - Method in class io.agora.rtc2.RtcEngine
 
startAudioMixing(String, boolean, int, int) - Method in class io.agora.rtc2.RtcEngine
 
startAudioRecording(AudioRecordingConfiguration) - Method in class io.agora.rtc2.RtcEngine
 
startAudioRecording(String, int) - Method in class io.agora.rtc2.RtcEngine
 
startCameraCapture(Constants.VideoSourceType, CameraCapturerConfiguration) - Method in class io.agora.rtc2.RtcEngine
 
startDirectCdnStreaming(IDirectCdnStreamingEventHandler, String, DirectCdnStreamingMediaOptions) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
v4.6.0.
startEchoTest(EchoTestConfiguration) - Method in class io.agora.rtc2.RtcEngine
 
startLastmileProbeTest(LastmileProbeConfig) - Method in class io.agora.rtc2.RtcEngine
 
startLocalAudioMixer(LocalAudioMixerConfiguration) - Method in class io.agora.rtc2.RtcEngine
 
startLocalVideoTranscoder(LocalTranscoderConfiguration) - Method in class io.agora.rtc2.RtcEngine
 
startMediaRenderingTracing() - Method in class io.agora.rtc2.RtcEngine
 
startMediaRenderingTracingEx(RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
startOrUpdateChannelMediaRelay(ChannelMediaRelayConfiguration) - Method in class io.agora.rtc2.RtcEngine
 
startOrUpdateChannelMediaRelayEx(ChannelMediaRelayConfiguration, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
startPlaybackDeviceTest(String) - Method in class io.agora.rtc2.RtcEngine
 
startPreview - Variable in class io.agora.rtc2.ChannelMediaOptions
Determines whether to start preview when join channel if canvas have been set.
startPreview() - Method in class io.agora.rtc2.RtcEngine
 
startPreview(Constants.VideoSourceType) - Method in class io.agora.rtc2.RtcEngine
 
startRecording(AgoraMediaRecorder.MediaRecorderConfiguration) - Method in class io.agora.rtc2.AgoraMediaRecorder
 
startRecordingDeviceTest(int) - Method in class io.agora.rtc2.RtcEngine
 
startRhythmPlayer(String, String, AgoraRhythmPlayerConfig) - Method in class io.agora.rtc2.RtcEngine
 
startRtmpStreamWithoutTranscoding(String) - Method in class io.agora.rtc2.RtcEngine
 
startRtmpStreamWithoutTranscodingEx(String, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
startRtmpStreamWithTranscoding(String, LiveTranscoding) - Method in class io.agora.rtc2.RtcEngine
 
startRtmpStreamWithTranscodingEx(String, LiveTranscoding, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
startScreenCapture(ScreenCaptureParameters) - Method in class io.agora.rtc2.RtcEngine
 
state - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LastmileProbeResult
The status of the last-mile network test, which includes: - LASTMILE_PROBE_RESULT_COMPLETE (1): The last-mile network probe test is complete.
stop() - Method in interface io.agora.mediaplayer.IMediaPlayer
 
stopAllEffect - Variable in class io.agora.rtc2.LeaveChannelOptions
Whether to stop playing all audio effects when a user leaves the channel.
stopAllEffects() - Method in interface io.agora.rtc2.IAudioEffectManager
Stops playing all audio effects.
stopAllEffects() - Method in class io.agora.rtc2.RtcEngine
 
stopAudioMixing - Variable in class io.agora.rtc2.LeaveChannelOptions
Whether to stop playing and mixing the music file when a user leaves the channel.
stopAudioMixing() - Method in class io.agora.rtc2.RtcEngine
 
stopAudioRecording() - Method in class io.agora.rtc2.RtcEngine
 
stopCameraCapture(Constants.VideoSourceType) - Method in class io.agora.rtc2.RtcEngine
 
stopChannelMediaRelay() - Method in class io.agora.rtc2.RtcEngine
 
stopChannelMediaRelayEx(RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
stopDirectCdnStreaming() - Method in class io.agora.rtc2.RtcEngine
Deprecated.
v4.6.0.
stopEchoTest() - Method in class io.agora.rtc2.RtcEngine
 
stopEffect(int) - Method in interface io.agora.rtc2.IAudioEffectManager
Stops playing the specific audio effect.
stopEffect(int) - Method in class io.agora.rtc2.RtcEngine
 
stopLastmileProbeTest() - Method in class io.agora.rtc2.RtcEngine
 
stopLocalAudioMixer() - Method in class io.agora.rtc2.RtcEngine
 
stopLocalVideoTranscoder() - Method in class io.agora.rtc2.RtcEngine
 
stopMicrophoneRecording - Variable in class io.agora.rtc2.LeaveChannelOptions
Whether to stop microphone recording when a user leaves the channel.
STOPPED - Enum constant in enum class io.agora.rtc2.DirectCdnStreamingState
Deprecated.
2: Stops pushing streams to the CDN.
stopPlaybackDeviceTest() - Method in class io.agora.rtc2.RtcEngine
 
stopPreview() - Method in class io.agora.rtc2.RtcEngine
 
stopPreview(Constants.VideoSourceType) - Method in class io.agora.rtc2.RtcEngine
 
stopRecording() - Method in class io.agora.rtc2.AgoraMediaRecorder
 
stopRecordingDeviceTest() - Method in class io.agora.rtc2.RtcEngine
 
stopRhythmPlayer() - Method in class io.agora.rtc2.RtcEngine
 
stopRtmpStream(String) - Method in class io.agora.rtc2.RtcEngine
 
stopRtmpStreamEx(String, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
stopScreenCapture() - Method in class io.agora.rtc2.RtcEngine
 
storagePath - Variable in class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
The absolute path where the recording file is saved locally.
STREAM_FALLBACK_OPTION_AUDIO_ONLY - Enum constant in enum class io.agora.rtc2.Constants.StreamFallbackOptions
2: When the network conditions are weak, try to receive the low-quality video stream first.
STREAM_FALLBACK_OPTION_AUDIO_ONLY - Static variable in class io.agora.rtc2.Constants
 
STREAM_FALLBACK_OPTION_DISABLED - Enum constant in enum class io.agora.rtc2.Constants.StreamFallbackOptions
0: No fallback processing is performed on audio and video streams, the quality of the audio and video streams cannot be guaranteed.
STREAM_FALLBACK_OPTION_DISABLED - Static variable in class io.agora.rtc2.Constants
 
STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_1 - Enum constant in enum class io.agora.rtc2.Constants.StreamFallbackOptions
3~8: If the receiver SDK uses setRemoteSubscribeFallbackOption, it will receive one of the streams from agora::rtc::VIDEO_STREAM_LAYER_1 to agora::rtc::VIDEO_STREAM_LAYER_6 if the related layer exists when the network condition is poor.
STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_2 - Enum constant in enum class io.agora.rtc2.Constants.StreamFallbackOptions
 
STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_3 - Enum constant in enum class io.agora.rtc2.Constants.StreamFallbackOptions
 
STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_4 - Enum constant in enum class io.agora.rtc2.Constants.StreamFallbackOptions
 
STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_5 - Enum constant in enum class io.agora.rtc2.Constants.StreamFallbackOptions
 
STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_6 - Enum constant in enum class io.agora.rtc2.Constants.StreamFallbackOptions
 
STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW - Enum constant in enum class io.agora.rtc2.Constants.StreamFallbackOptions
1: Only receive low-quality (low resolution, low bitrate) video stream.
STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW - Static variable in class io.agora.rtc2.Constants
 
STREAM_LAYER_1 - Enum constant in enum class io.agora.rtc2.SimulcastConfig.StreamLayerIndex
0: Video stream layer_1, with lower resolution and bitrate than VIDEO_STREAM_HIGH.
STREAM_LAYER_2 - Enum constant in enum class io.agora.rtc2.SimulcastConfig.StreamLayerIndex
1: Video stream layer_2, with lower resolution and bitrate than VIDEO_STREAM_LAYER_1.
STREAM_LAYER_3 - Enum constant in enum class io.agora.rtc2.SimulcastConfig.StreamLayerIndex
2: Video stream layer_3, with lower resolution and bitrate than VIDEO_STREAM_LAYER_2.
STREAM_LAYER_4 - Enum constant in enum class io.agora.rtc2.SimulcastConfig.StreamLayerIndex
3: Video stream layer_4, with lower resolution and bitrate than VIDEO_STREAM_LAYER_3.
STREAM_LAYER_5 - Enum constant in enum class io.agora.rtc2.SimulcastConfig.StreamLayerIndex
4: Video stream layer_5, with lower resolution and bitrate than VIDEO_STREAM_LAYER_4.
STREAM_LAYER_6 - Enum constant in enum class io.agora.rtc2.SimulcastConfig.StreamLayerIndex
5: Video stream layer_6, with lower resolution and bitrate than VIDEO_STREAM_LAYER_5.
STREAM_LAYER_COUNT_MAX - Enum constant in enum class io.agora.rtc2.SimulcastConfig.StreamLayerIndex
7: Maximum number of video stream layers.
STREAM_LIFE_CYCLE_BIND2CHANNEL - Static variable in class io.agora.rtc2.Constants
Bound to the channel lifecycle.
STREAM_LIFE_CYCLE_BIND2OWNER - Static variable in class io.agora.rtc2.Constants
Bound to the owner of the RTMP stream.
STREAM_LOW - Enum constant in enum class io.agora.rtc2.SimulcastConfig.StreamLayerIndex
6: Low-quality video stream, with the lowest resolution and bitrate.
STREAM_TYPE_AUDIO - Enum constant in enum class io.agora.mediaplayer.Constants.MediaStreamType
2: The audio stream.
STREAM_TYPE_AUDIO - Static variable in class io.agora.rtc2.AgoraMediaRecorder
1: Record audio only.
STREAM_TYPE_BOTH - Static variable in class io.agora.rtc2.AgoraMediaRecorder
3: Record both audio and video.
STREAM_TYPE_SUBTITLE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaStreamType
3: The subtitle stream.
STREAM_TYPE_UNKNOWN - Enum constant in enum class io.agora.mediaplayer.Constants.MediaStreamType
0: The type is unknown.
STREAM_TYPE_VIDEO - Enum constant in enum class io.agora.mediaplayer.Constants.MediaStreamType
1: The video stream.
STREAM_TYPE_VIDEO - Static variable in class io.agora.rtc2.AgoraMediaRecorder
2: Record video only.
StreamLayerConfig() - Constructor for class io.agora.rtc2.SimulcastConfig.StreamLayerConfig
 
StreamLayerConfig(VideoEncoderConfiguration.VideoDimensions, int, boolean) - Constructor for class io.agora.rtc2.SimulcastConfig.StreamLayerConfig
 
streamLifeCycle(int) - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
CDN push stream life cycle
streamType - Variable in class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
Recording content: - `STREAM_TYPE_AUDIO`: Audio only.
streamType - Variable in class io.agora.rtc2.video.EncodedVideoFrameInfo
The type of video streams.
strength - Variable in class io.agora.rtc2.video.FilterEffectOptions
The intensity of the filter effect, with a range value of [0.0,1.0], in which 0.0 represents no filter effect.
strengthLevel - Variable in class io.agora.rtc2.video.ColorEnhanceOptions
The level of color enhancement.
stride - Variable in class io.agora.rtc2.video.AgoraVideoFrame
Line spacing of the incoming video frame, which must be in pixels instead of bytes.
strUid - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayout
Reserved for future use.
STYLE_MAKEUP - Enum constant in enum class io.agora.rtc2.IVideoEffectObject.VIDEO_EFFECT_NODE_ID
(2): Style makeup effect node.
STYLE_TRANSFORMATION_POPULAR - Static variable in class io.agora.rtc2.Constants
An audio effect typical of popular music.
STYLE_TRANSFORMATION_RNB - Static variable in class io.agora.rtc2.Constants
An audio effect typical of R&B music.
styleIntensity - Variable in class io.agora.rtc2.video.FaceShapeBeautyOptions
The intensity of the facial enhancement style, with a value range oof [0.0,1.0].
SUB_STATE_IDLE - Static variable in class io.agora.rtc2.Constants
0: The initial subscribing state after joining the channel.
SUB_STATE_NO_SUBSCRIBED - Static variable in class io.agora.rtc2.Constants
1: Fails to subscribing to the remote stream.
SUB_STATE_SUBSCRIBED - Static variable in class io.agora.rtc2.Constants
3: Subscribes to and receives the remote stream successfully.
SUB_STATE_SUBSCRIBING - Static variable in class io.agora.rtc2.Constants
2: Subscribing.
subviewUid - Variable in class io.agora.rtc2.video.VideoCanvas
The ID of the user who publishes a specific sub-video stream within the mixed video stream.
SUCCESS - Enum constant in enum class io.agora.rtc2.IH265TranscoderObserver.H265TranscodeResult
0: The request of operation is successfully.
surfaceTexture - Variable in class io.agora.rtc2.video.VideoCanvas
A container that provides video images.
swDecodingLevel - Variable in class io.agora.rtc2.video.CodecCapLevels
Software decoding capability level, which represents the device's ability to perform software decoding on videos of different quality.
switchAgoraCDNLineByIndex(int) - Method in interface io.agora.mediaplayer.IMediaPlayer
Deprecated.
4.6.0
switchAgoraCDNSrc(String, boolean) - Method in interface io.agora.mediaplayer.IMediaPlayer
Deprecated.
4.6.0
switchCamera() - Method in class io.agora.rtc2.RtcEngine
 
switchCamera(String) - Method in class io.agora.rtc2.RtcEngine
 
switchSrc(String, boolean) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
syncMode - Variable in class io.agora.rtc2.video.AgoraVideoFrame
Set whether to enable the synchronization mode.
syncWithAudio - Variable in class io.agora.rtc2.DataStreamConfig
Whether to synchronize the data packet with the published audio packet.
syncWithLocalMic - Variable in class io.agora.rtc2.LocalAudioMixerConfiguration
Whether the mxied audio stream uses the timestamp of the audio frames captured by the local microphone.
syncWithPrimaryCamera - Variable in class io.agora.rtc2.LocalTranscoderConfiguration
Whether to use the timestamp when the primary camera captures the video frame as the timestamp of the mixed video frame.

T

takeScreenshot(String) - Method in interface io.agora.mediaplayer.IMediaPlayer
take screenshot while playing video
takeSnapshot(int, SnapshotConfig) - Method in class io.agora.rtc2.RtcEngine
 
takeSnapshot(int, String) - Method in class io.agora.rtc2.RtcEngine
 
takeSnapshotEx(RtcConnection, int, SnapshotConfig) - Method in class io.agora.rtc2.RtcEngineEx
 
takeSnapshotEx(RtcConnection, int, String) - Method in class io.agora.rtc2.RtcEngineEx
 
targetBitrate - Variable in class io.agora.rtc2.EncodedVideoTrackOptions
Target bitrate (Kbps) for sending encoded video frame.
targetBitrate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The target bitrate (Kbps) of the current encoder.
targetFrameRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The target frame rate (fps) of the current encoder.
TCC_DISABLED - Static variable in class io.agora.rtc2.Constants
 
TCC_ENABLED - Static variable in class io.agora.rtc2.Constants
Transport CC enabled
textureCopy(VideoFrame.TextureBuffer) - Method in class io.agora.mediaplayer.gl.PlayerTextureHelper
 
textureID - Variable in class io.agora.rtc2.video.AgoraVideoFrame
Texture ID of the frame.
TIMBRE_TRANSFORMATION_CLEAR - Static variable in class io.agora.rtc2.Constants
A clearer voice.
TIMBRE_TRANSFORMATION_DEEP - Static variable in class io.agora.rtc2.Constants
A deeper voice.
TIMBRE_TRANSFORMATION_FALSETTO - Static variable in class io.agora.rtc2.Constants
A falsetto voice.
TIMBRE_TRANSFORMATION_FULL - Static variable in class io.agora.rtc2.Constants
A fuller voice.
TIMBRE_TRANSFORMATION_MELLOW - Static variable in class io.agora.rtc2.Constants
A mellower voice.
TIMBRE_TRANSFORMATION_RESOUNDING - Static variable in class io.agora.rtc2.Constants
A more resounding voice.
TIMBRE_TRANSFORMATION_RINGING - Static variable in class io.agora.rtc2.Constants
A more ringing voice.
TIMBRE_TRANSFORMATION_VIGOROUS - Static variable in class io.agora.rtc2.Constants
A more vigorous voice.
timestamp - Variable in class io.agora.base.AudioFrame
The timestamp (ms) of the audio frame.
timeStamp - Variable in class io.agora.rtc2.video.AgoraVideoFrame
Timestamp (ms) of the incoming video frame.
timeStampMs - Variable in class io.agora.rtc2.video.AgoraMetadata
The timestamp (ms) of when the `AgoraMetadata` is sent.
toJsonString() - Method in class io.agora.rtc2.PublisherConfiguration
 
token - Variable in class io.agora.rtc2.ChannelMediaOptions
(Optional) The token generated on your server for authentication.
token - Variable in class io.agora.rtc2.EchoTestConfiguration
The token used to secure the audio and video call loop test.
token - Variable in class io.agora.rtc2.video.ChannelMediaInfo
The token that enables the user to join the channel.
TOKEN_EXPIRED - Enum constant in enum class io.agora.rtc2.IH265TranscoderObserver.H265TranscodeResult
3: The token is expired, please update token.
TOO_OFTEN - Enum constant in enum class io.agora.rtc2.IH265TranscoderObserver.H265TranscodeResult
8: The requests are too frequent.
toString() - Method in class io.agora.base.AudioFrame
 
toString() - Method in class io.agora.mediaplayer.data.CacheStatistics
 
toString() - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
toString() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
toString() - Method in class io.agora.mediaplayer.data.PlayerPlaybackStats
 
toString() - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
 
toString() - Method in class io.agora.mediaplayer.data.SrcInfo
 
toString() - Method in class io.agora.rtc2.audio.AudioParams
 
toString() - Method in class io.agora.rtc2.audio.AudioTrackConfig
 
toString() - Method in class io.agora.rtc2.ChannelMediaOptions
 
toString() - Method in class io.agora.rtc2.DirectCdnStreamingMediaOptions
Deprecated.
 
toString() - Method in class io.agora.rtc2.DirectCdnStreamingStats
Deprecated.
 
toString() - Method in class io.agora.rtc2.IRtcEngineEventHandler.MultipathStats
 
toString() - Method in class io.agora.rtc2.IRtcEngineEventHandler.PathStats
 
toString() - Method in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayout
 
toString() - Method in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayoutInfo
 
toString() - Method in class io.agora.rtc2.LeaveChannelOptions
 
toString() - Method in class io.agora.rtc2.RecorderStreamInfo
 
toString() - Method in class io.agora.rtc2.RtcConnection
 
toString() - Method in class io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters
 
toString() - Method in class io.agora.rtc2.ScreenCaptureParameters
 
toString() - Method in class io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters
 
toString() - Method in class io.agora.rtc2.video.AgoraFocalLengthInfo
 
toString() - Method in class io.agora.rtc2.video.AgoraVideoFrame
 
toString() - Method in class io.agora.rtc2.video.CameraCapturerConfiguration.CaptureFormat
 
toString() - Method in class io.agora.rtc2.video.CameraCapturerConfiguration
 
toString() - Method in class io.agora.rtc2.video.EncodedVideoFrameInfo
 
totalActiveTime - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
The total active time (ms) between the start of the audio call and the callback of the remote user.
totalActiveTime - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
The total active time (ms) of the video.
totalDuration - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
Call duration of the local user in seconds, represented by an aggregate value.
totalFrozenTime - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
The total freeze time (ms) of the remote audio stream after the remote user joins the channel.
totalFrozenTime - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
The total freeze time (ms) of the remote video stream after the remote user joins the channel.
trackId - Variable in class io.agora.rtc2.LocalAudioMixerConfiguration.MixedAudioStream
The audio track ID.
trackId - Variable in class io.agora.rtc2.video.EncodedVideoFrameInfo
Reserved for future use.
TRANSCODED_VIDEO_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
12: Video for transcoded.
TranscodingUser() - Constructor for class io.agora.rtc2.live.LiveTranscoding.TranscodingUser
 
TranscodingVideoStream() - Constructor for class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
 
transcodingVideoStreams - Variable in class io.agora.rtc2.LocalTranscoderConfiguration
The video streams for local video mixing.
transform - Variable in class io.agora.rtc2.video.AgoraVideoFrame
Additional transform of Texture frames.
TRANSPORT_TYPE_NONE_PROXY - Static variable in class io.agora.rtc2.Constants
0: The automatic mode.
TRANSPORT_TYPE_TCP_PROXY - Static variable in class io.agora.rtc2.Constants
2: The cloud proxy for the TCP (encryption) protocol, that is, the Force TCP cloud proxy mode.
TRANSPORT_TYPE_UDP_PROXY - Static variable in class io.agora.rtc2.Constants
1: The cloud proxy for the UDP protocol, that is, the Force UDP cloud proxy mode.
triggerTranscode(String, String, int) - Method in interface io.agora.rtc2.IH265Transcoder
Trigger channel transcoding.
TWO_BYTES_PER_SAMPLE - Enum constant in enum class io.agora.rtc2.Constants.BytesPerSample
two bytes per sample
txAudioBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The total number of audio bytes sent, represented by an aggregate value.
txAudioKBitRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The bitrate (Kbps) of sending the audio packet.
txBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The number of bytes sent.
txKBitRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.PathStats
The transmission bitrate of the path in Kbps.
txKBitRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The actual bitrate (Kbps) while sending the local video stream.
txPacketLossRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalAudioStats
The packet loss rate (%) from the local client to the Agora server before applying the anti-packet loss strategies.
txPacketLossRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The video packet loss rate (%) from the local client to the Agora server before applying the anti-packet loss strategies.
txPacketLossRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The packet loss rate (%) from the client to the Agora server before applying the anti-packet-loss algorithm.
txVideoBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The total number of video bytes sent, represented by an aggregate value.
txVideoKBitRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The bitrate (Kbps) of sending the video.
type - Variable in class io.agora.rtc2.video.ContentInspectConfig.ContentInspectModule
Types of functional modules: - CONTENT_INSPECT_TYPE_INVALID (0): (Default) This module has no actual function.
type - Variable in class io.agora.rtc2.video.WatermarkConfig
Type of the watermark: - `WATERMARK_TYPE_IMAGE`: image type.
TYPE_32000 - Enum constant in enum class io.agora.rtc2.live.LiveInjectStreamConfig.AudioSampleRateType
32000: 32 kHz
TYPE_32000 - Enum constant in enum class io.agora.rtc2.live.LiveTranscoding.AudioSampleRateType
32000: 32 kHz.
TYPE_44100 - Enum constant in enum class io.agora.rtc2.live.LiveInjectStreamConfig.AudioSampleRateType
44100: 44.1 kHz
TYPE_44100 - Enum constant in enum class io.agora.rtc2.live.LiveTranscoding.AudioSampleRateType
(Default) 44100: 44.1 kHz.
TYPE_48000 - Enum constant in enum class io.agora.rtc2.live.LiveInjectStreamConfig.AudioSampleRateType
48000: (Default) 48 kHz
TYPE_48000 - Enum constant in enum class io.agora.rtc2.live.LiveTranscoding.AudioSampleRateType
48000: 48 kHz.

U

uid - Variable in class io.agora.rtc2.ExtensionContext
The user ID.
uid - Variable in class io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo
The user ID.
uid - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The ID of the local user.
uid - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
The user ID of the remote user.
uid - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
The user ID of the remote user sending the video stream.
uid - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayout
User ID who published this sub-video stream.
uid - Variable in class io.agora.rtc2.live.LiveTranscoding.TranscodingUser
The user ID of the host.
uid - Variable in class io.agora.rtc2.RecorderStreamInfo
The user ID of the remote user to be recorded.
uid - Variable in class io.agora.rtc2.UserInfo
The user ID.
uid - Variable in class io.agora.rtc2.video.AgoraMetadata
The user ID.
uid - Variable in class io.agora.rtc2.video.ChannelMediaInfo
The user ID.
uid - Variable in class io.agora.rtc2.video.VideoCanvas
User ID that publishes the video source.
uid - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
uid(int) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
ULTRA_HIGH_QUALITY_VOICE - Static variable in class io.agora.rtc2.Constants
A ultra high quality voice.
UNAUTHORIZED - Enum constant in enum class io.agora.rtc2.IH265TranscoderObserver.H265TranscodeResult
2: Authentication failed, please check for correctness of token.
UNKNOWN - Enum constant in enum class io.agora.rtc2.IH265TranscoderObserver.H265TranscodeResult
-1: Unknown error.
UNKNOWN - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.Quality
Deprecated.
 
UNKNOWN_MEDIA_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
100: Unknown media source.
UNKNOWN_METADATA - Static variable in interface io.agora.rtc2.IMetadataObserver
(Not supported) The metadata type is unknown.
unloadAllEffects() - Method in class io.agora.rtc2.RtcEngine
Releases all preloaded audio effects from the memory.
unloadEffect(int) - Method in interface io.agora.rtc2.IAudioEffectManager
Releases the specific preloaded audio effect from the memory.
unloadEffect(int) - Method in class io.agora.rtc2.RtcEngine
 
unloadSrc(String) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
unRegisterAudioSpectrumObserver(IAudioSpectrumObserver) - Method in class io.agora.rtc2.RtcEngine
 
unregisterMediaMetadataObserver(IMetadataObserver, int) - Method in class io.agora.rtc2.RtcEngine
 
unregisterMediaPlayerAudioSpectrumObserver(IAudioSpectrumObserver) - Method in interface io.agora.mediaplayer.IMediaPlayer
Releases the audio frame spectrum observer.
unRegisterPlayerObserver(IMediaPlayerObserver) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
unregisterTranscoderObserver(IH265TranscoderObserver) - Method in interface io.agora.rtc2.IH265Transcoder
Unregister a IH265TranscoderObserver object.
up - Variable in class io.agora.spatialaudio.SpatialAudioZone
Starting at `position`, the up unit vector.
updateAppData(String) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Builder
Deprecated.
 
updateChannelMediaOptions(ChannelMediaOptions) - Method in class io.agora.rtc2.RtcEngine
 
updateChannelMediaOptionsEx(ChannelMediaOptions, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
updateDirectCdnStreamingMediaOptions(DirectCdnStreamingMediaOptions) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
v4.6.0.
updateLocalAudioMixerConfiguration(LocalAudioMixerConfiguration) - Method in class io.agora.rtc2.RtcEngine
 
updateLocalTranscoderConfiguration(LocalTranscoderConfiguration) - Method in class io.agora.rtc2.RtcEngine
 
updatePlayerPositionInfo(int, RemoteVoicePositionInfo) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
 
updatePreloadChannelToken(String) - Method in class io.agora.rtc2.RtcEngine
 
updateRemotePosition(int, RemoteVoicePositionInfo) - Method in class io.agora.spatialaudio.ILocalSpatialAudioEngine
 
updateRemotePositionEx(int, RemoteVoicePositionInfo, RtcConnection) - Method in class io.agora.spatialaudio.ILocalSpatialAudioEngine
 
updateRtmpTranscoding(LiveTranscoding) - Method in class io.agora.rtc2.RtcEngine
 
updateRtmpTranscodingEx(LiveTranscoding, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
 
updateScreenCaptureParameters(ScreenCaptureParameters) - Method in class io.agora.rtc2.RtcEngine
 
updateSelfPosition(float[], float[], float[], float[]) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
 
updateSelfPositionEx(float[], float[], float[], float[], RtcConnection) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
 
updateSharedContext(android.opengl.EGLContext) - Method in class io.agora.rtc2.RtcEngineInternal
 
updateSharedContext(EGLContext) - Method in class io.agora.rtc2.RtcEngineInternal
Shared context of MediaCodec.
upLength - Variable in class io.agora.spatialaudio.SpatialAudioZone
The entire sound insulation area is regarded as a cube; this represents the length of the up side in the unit length of the game engine.
uplinkMultipathMode - Variable in class io.agora.rtc2.ChannelMediaOptions
Uplink transmission mode.
UplinkNetworkInfo() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.UplinkNetworkInfo
 
uplinkReport - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LastmileProbeResult
Results of the uplink last-mile network test.
uploadLogFile() - Method in class io.agora.rtc2.RtcEngine
Upload current log file immediately to server.
url - Variable in class io.agora.rtc2.video.AgoraImage
The HTTP/HTTPS URL address of the image in the live video.
USER_OFFLINE_BECOME_AUDIENCE - Static variable in class io.agora.rtc2.Constants
2.
USER_OFFLINE_DROPPED - Static variable in class io.agora.rtc2.Constants
1.
USER_OFFLINE_DROPPED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.UserOfflineReason
Deprecated.
The SDK timed out and the user dropped offline because it has not received any data package for a period of time.
USER_OFFLINE_QUIT - Static variable in class io.agora.rtc2.Constants
0: The user has quit the call.
USER_OFFLINE_QUIT - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.UserOfflineReason
Deprecated.
The user has quit the call.
USER_PRIORITY_HIGH - Static variable in class io.agora.rtc2.Constants
High Priority, if you set a user with high priority, then streams of this user will have high priority than streams of other users with normal default priority.
USER_PRIORITY_NORANL - Static variable in class io.agora.rtc2.Constants
Default priority.
USER_STATE_ENABLE_LOCAL_VIDEO - Static variable in class io.agora.rtc2.Constants
 
USER_STATE_ENABLE_VIDEO - Static variable in class io.agora.rtc2.Constants
 
USER_STATE_MUTE_AUDIO - Static variable in class io.agora.rtc2.Constants
 
USER_STATE_MUTE_VIDEO - Static variable in class io.agora.rtc2.Constants
 
userAccount - Variable in class io.agora.rtc2.UserInfo
User account.
UserAudioSpectrumInfo - Class in io.agora.rtc2.audio
 
UserAudioSpectrumInfo(int, AudioSpectrumInfo) - Constructor for class io.agora.rtc2.audio.UserAudioSpectrumInfo
 
userConfigExtraInfo - Variable in class io.agora.rtc2.live.LiveTranscoding
Reserved property.
userCount - Variable in class io.agora.rtc2.live.LiveTranscoding
Deprecated.
This parameter is deprecated. We recommend using the getUserCount method.
userId - Variable in class io.agora.rtc2.live.LiveTranscoding.TranscodingUser
 
userId - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
userId(String) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
UserInfo - Class in io.agora.rtc2
 
UserInfo() - Constructor for class io.agora.rtc2.UserInfo
 
UserInfo(int, String) - Constructor for class io.agora.rtc2.UserInfo
 
UserOfflineReason() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.UserOfflineReason
Deprecated.
 
users - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The number of users in the channel.

V

vad - Variable in class io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo
Voice activity status of the local user.
validate() - Method in class io.agora.rtc2.PublisherConfiguration
 
valueOf(String) - Static method in enum class io.agora.mediaplayer.Constants.AudioDualMonoMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerMetadataType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerPreloadEvent
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerState
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.mediaplayer.Constants.MediaStreamType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.audio.AdvancedAudioOptions.AudioProcessingChannelsEnum
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.AUDIO_REVERB_TYPE
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.AudioMixingDualMonoMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.AudioProfile
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.AudioScenario
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.AudioSourceType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.AudioTrackType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.BytesPerSample
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.ExternalVideoSourceType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.LogLevel
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.MEDIA_TRACE_EVENT
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.MediaSourceType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.MediaType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.MultipathMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.MultipathType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.QoEPreference
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.RenewTokenErrorCode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.ScreenScenarioType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.SimulcastStreamMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.StreamFallbackOptions
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.ThreadPriorityType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.VIDEO_MODULE_TYPE
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.VideoModulePosition
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.VideoScenario
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.VideoSourceType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.VideoStreamType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.DirectCdnStreamingReason
Deprecated.
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.DirectCdnStreamingState
Deprecated.
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.IH265TranscoderObserver.H265TranscodeResult
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.IVideoEffectObject.VIDEO_EFFECT_ACTION
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.IVideoEffectObject.VIDEO_EFFECT_NODE_ID
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.live.LiveInjectStreamConfig.AudioSampleRateType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.live.LiveTranscoding.AudioCodecProfileType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.live.LiveTranscoding.AudioSampleRateType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.live.LiveTranscoding.VideoCodecProfileType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.live.LiveTranscoding.VideoCodecType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.RtcConnection.CONNECTION_STATE_TYPE
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.SimulcastConfig.StreamLayerIndex
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_DIRECTION
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.CODEC_CAP_MASK
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.COMPRESSION_PREFERENCE
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.DEGRADATION_PREFERENCE
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.ENCODING_PREFERENCE
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.FRAME_RATE
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.MIRROR_MODE_TYPE
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.ORIENTATION_MODE
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.VIDEO_CODEC_TYPE
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.agora.rtc2.video.VideoSubscriptionOptions.REMOTE_VIDEO_STREAM_TYPE
Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.agora.mediaplayer.Constants.AudioDualMonoMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerMetadataType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerPreloadEvent
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.mediaplayer.Constants.MediaPlayerState
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.mediaplayer.Constants.MediaStreamType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.audio.AdvancedAudioOptions.AudioProcessingChannelsEnum
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.AUDIO_REVERB_TYPE
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.AudioMixingDualMonoMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.AudioProfile
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.AudioScenario
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.AudioSourceType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.AudioTrackType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.BytesPerSample
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.ExternalVideoSourceType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.LogLevel
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.MEDIA_TRACE_EVENT
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.MediaSourceType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.MediaType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.MultipathMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.MultipathType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.QoEPreference
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.RenewTokenErrorCode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.ScreenScenarioType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.SimulcastStreamMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.StreamFallbackOptions
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.ThreadPriorityType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.VIDEO_MODULE_TYPE
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.VideoModulePosition
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.VideoScenario
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.VideoSourceType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.VideoStreamType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.DirectCdnStreamingReason
Deprecated.
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.DirectCdnStreamingState
Deprecated.
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.IH265TranscoderObserver.H265TranscodeResult
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.IVideoEffectObject.VIDEO_EFFECT_ACTION
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.IVideoEffectObject.VIDEO_EFFECT_NODE_ID
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.live.LiveInjectStreamConfig.AudioSampleRateType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.live.LiveTranscoding.AudioCodecProfileType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.live.LiveTranscoding.AudioSampleRateType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.live.LiveTranscoding.VideoCodecProfileType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.live.LiveTranscoding.VideoCodecType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.RtcConnection.CONNECTION_STATE_TYPE
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.SimulcastConfig.StreamLayerIndex
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_DIRECTION
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.CODEC_CAP_MASK
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.COMPRESSION_PREFERENCE
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.DEGRADATION_PREFERENCE
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.ENCODING_PREFERENCE
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.FRAME_RATE
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.MIRROR_MODE_TYPE
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.ORIENTATION_MODE
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.video.VideoEncoderConfiguration.VIDEO_CODEC_TYPE
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.agora.rtc2.video.VideoSubscriptionOptions.REMOTE_VIDEO_STREAM_TYPE
Returns an array containing the constants of this enum class, in the order they are declared.
VBAD - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.Quality
Deprecated.
 
VD_120x120 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
VD_120x120: The video resolution is 120 × 120.
VD_1280x720 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
VD_1280x720: The video resolution is 640 × 360.
VD_160x120 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
VD_160x120: The video resolution is 160 × 120.
VD_180x180 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
VD_180x180: The video resolution is 180 × 180.
VD_1920x1080 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
Not supported.
VD_240x180 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
VD_240x180: The video resolution is 240 × 180.
VD_240x240 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
VD_240x240: The video resolution is 240 × 240.
VD_2540x1440 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
Not supported.
VD_320x180 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
VD_320x180: The video resolution is 320 × 180.
VD_320x240 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
VD_320x240: The video resolution is 320 × 240.
VD_360x360 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
VD_360x360: The video resolution is 360 × 360.
VD_3840x2160 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
Not supported.
VD_424x240 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
VD_424x240: The video resolution is 424 × 240.
VD_480x360 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
VD_480x360: The video resolution is 480 × 360.
VD_480x480 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
VD_480x480: The video resolution is 480 × 480.
VD_640x360 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
VD_640x360: The video resolution is 640 × 360.
VD_640x480 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
VD_640x480: The video resolution is 640 × 480.
VD_840x480 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
VD_840x480: The video resolution is 840 × 480.
VD_960x540 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
VD_960x540: The video resolution is 960 × 540.
VD_960x720 - Static variable in class io.agora.rtc2.video.VideoEncoderConfiguration
VD_960x720: The video resolution is 640 × 360.
verifyDomainName - Variable in class io.agora.rtc2.proxy.LocalAccessPointConfiguration
Intranet certificate verification domain.
VIDEO_CODEC_AV1 - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.VIDEO_CODEC_TYPE
12: AV1.
VIDEO_CODEC_GENERIC - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.VIDEO_CODEC_TYPE
6: Generic.
VIDEO_CODEC_GENERIC - Static variable in class io.agora.rtc2.Constants
 
VIDEO_CODEC_GENERIC_H264 - Static variable in class io.agora.rtc2.Constants
 
VIDEO_CODEC_GENERIC_JPEG - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.VIDEO_CODEC_TYPE
20: Generic JPEG.
VIDEO_CODEC_GENERIC_JPEG - Static variable in class io.agora.rtc2.Constants
 
VIDEO_CODEC_H264 - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.VIDEO_CODEC_TYPE
2: Standard H.264.
VIDEO_CODEC_H264 - Static variable in class io.agora.rtc2.Constants
 
VIDEO_CODEC_H265 - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.VIDEO_CODEC_TYPE
3: Standard H.265.
VIDEO_CODEC_H265 - Static variable in class io.agora.rtc2.Constants
 
VIDEO_CODEC_NONE - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.VIDEO_CODEC_TYPE
0: (Default) Unspecified codec format.
VIDEO_CODEC_VP8 - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.VIDEO_CODEC_TYPE
1: Standard VP8.
VIDEO_CODEC_VP8 - Static variable in class io.agora.rtc2.Constants
Video codec types VIDEO_CODEC_TYPE
VIDEO_CODEC_VP9 - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.VIDEO_CODEC_TYPE
13: VP9.
VIDEO_CODEC_VP9 - Static variable in class io.agora.rtc2.Constants
 
VIDEO_DENOISER_AUTO - Static variable in class io.agora.rtc2.video.VideoDenoiserOptions
`0`: (Default) Automatic mode.
VIDEO_DENOISER_LEVEL_FAST - Static variable in class io.agora.rtc2.video.VideoDenoiserOptions
`1`: Promotes reducing performance consumption during video noise reduction.
VIDEO_DENOISER_LEVEL_HIGH_QUALITY - Static variable in class io.agora.rtc2.video.VideoDenoiserOptions
`0`: (Default) Promotes video quality during video noise reduction.
VIDEO_DENOISER_MANUAL - Static variable in class io.agora.rtc2.video.VideoDenoiserOptions
`1`: Manual mode.
video_encoder_target_bitrate_bps - Variable in class io.agora.rtc2.IRtcEngineEventHandler.UplinkNetworkInfo
The target video encoder bitrate (bps).
VIDEO_FRAME - Enum constant in enum class io.agora.rtc2.Constants.ExternalVideoSourceType
0: The video frame is not encoded.
VIDEO_FRAME_TYPE_B_FRAME - Static variable in class io.agora.rtc2.Constants
 
VIDEO_FRAME_TYPE_BLANK_FRAME - Static variable in class io.agora.rtc2.Constants
Video Frame Type.
VIDEO_FRAME_TYPE_DELTA_FRAME - Static variable in class io.agora.rtc2.Constants
 
VIDEO_FRAME_TYPE_KEY_FRAME - Static variable in class io.agora.rtc2.Constants
 
VIDEO_FRAME_TYPE_UNKNOWN - Static variable in class io.agora.rtc2.Constants
 
VIDEO_METADATA - Static variable in interface io.agora.rtc2.IMetadataObserver
The metadata type is video.
VIDEO_MIRROR_MODE_AUTO - Static variable in class io.agora.rtc2.Constants
The default mirror mode, that is, the mode set by the SDK.
VIDEO_MIRROR_MODE_DISABLED - Static variable in class io.agora.rtc2.Constants
Disable the mirror mode
VIDEO_MIRROR_MODE_ENABLED - Static variable in class io.agora.rtc2.Constants
Enable the mirror mode.
VIDEO_MODULE_CAPTURER - Enum constant in enum class io.agora.rtc2.Constants.VIDEO_MODULE_TYPE
Video capture module
VIDEO_MODULE_HARDWARE_DECODER - Enum constant in enum class io.agora.rtc2.Constants.VIDEO_MODULE_TYPE
Video hardware decoder module
VIDEO_MODULE_HARDWARE_ENCODER - Enum constant in enum class io.agora.rtc2.Constants.VIDEO_MODULE_TYPE
Video hardware encoder module
VIDEO_MODULE_POSITION_POST_CAPTURER - Enum constant in enum class io.agora.rtc2.Constants.VideoModulePosition
1: The location of the locally collected video data after preprocessing corresponds to the `onCaptureVideoFrame` callback.
VIDEO_MODULE_POSITION_POST_CAPTURER_ORIGIN - Enum constant in enum class io.agora.rtc2.Constants.VideoModulePosition
8: The position after local video capture and before pre-processing.
VIDEO_MODULE_POSITION_PRE_ENCODER - Enum constant in enum class io.agora.rtc2.Constants.VideoModulePosition
4: The pre-encoder position , which corresponds to the video data in the `onPreEncodeVideoFrame` callback.
VIDEO_MODULE_POSITION_PRE_RENDERER - Enum constant in enum class io.agora.rtc2.Constants.VideoModulePosition
2: The pre-renderer position , which corresponds to the video data in the `onRenderVideoFrame` callback.
VIDEO_MODULE_RENDERER - Enum constant in enum class io.agora.rtc2.Constants.VIDEO_MODULE_TYPE
Video render module
VIDEO_MODULE_SOFTWARE_DECODER - Enum constant in enum class io.agora.rtc2.Constants.VIDEO_MODULE_TYPE
Video software decoder module
VIDEO_MODULE_SOFTWARE_ENCODER - Enum constant in enum class io.agora.rtc2.Constants.VIDEO_MODULE_TYPE
Video software encoder module
VIDEO_ONLY - Enum constant in enum class io.agora.rtc2.Constants.MediaType
Video only.
VIDEO_ORIENTATION_0 - Static variable in class io.agora.rtc2.Constants
0: No rotation.
VIDEO_ORIENTATION_180 - Static variable in class io.agora.rtc2.Constants
180: 180 degrees.
VIDEO_ORIENTATION_270 - Static variable in class io.agora.rtc2.Constants
270: 270 degrees.
VIDEO_ORIENTATION_90 - Static variable in class io.agora.rtc2.Constants
90: 90 degrees.
VIDEO_PIXEL_BGRA - Static variable in interface io.agora.rtc2.video.IVideoFrameObserver
2: BGRA.
VIDEO_PIXEL_DEFAULT - Static variable in interface io.agora.rtc2.video.IVideoFrameObserver
0: Default format.
VIDEO_PIXEL_I010 - Static variable in interface io.agora.rtc2.video.IVideoFrameObserver
18: I010.
VIDEO_PIXEL_I420 - Static variable in interface io.agora.rtc2.video.IVideoFrameObserver
1: I420.
VIDEO_PIXEL_I422 - Static variable in interface io.agora.rtc2.video.IVideoFrameObserver
16: I422.
VIDEO_PIXEL_NV12 - Static variable in interface io.agora.rtc2.video.IVideoFrameObserver
8: NV12.
VIDEO_PIXEL_NV21 - Static variable in interface io.agora.rtc2.video.IVideoFrameObserver
3: NV21.
VIDEO_PIXEL_RGBA - Static variable in interface io.agora.rtc2.video.IVideoFrameObserver
4: RGBA.
VIDEO_PROFILE_1080P - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_1080P - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
1920 x 1080 @ 15 fps, 2080 kbit/s
VIDEO_PROFILE_1080P_3 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_1080P_3 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
1920 x 1080 @ 30 fps, 3150 kbit/s
VIDEO_PROFILE_1080P_5 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_1080P_5 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
1920 x 1080 @ 60 fps, 4780 kbit/s
VIDEO_PROFILE_120P - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_120P - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
160 x 120 @ 15 fps, 65 kbit/s
VIDEO_PROFILE_120P_3 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_120P_3 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
120 x 120 @ 15 fps, 50 kbit/s
VIDEO_PROFILE_1440P - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_1440P - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
2560 x 1440 @ 30 fps, 4850 kbit/s
VIDEO_PROFILE_1440P_2 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_1440P_2 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
2560 x 1440 @ 60 fps, 7350 kbit/s
VIDEO_PROFILE_180P - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_180P - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
320 x 180 @ 15 fps, 140 kbit/s
VIDEO_PROFILE_180P_3 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_180P_3 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
180 x 180 @ 15 fps, 100 kbit/s
VIDEO_PROFILE_180P_4 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_180P_4 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
240 x 180 @ 15 fps, 120 kbit/s
VIDEO_PROFILE_240P - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_240P - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
320 x 240 @ 15 fps, 200 kbit/s
VIDEO_PROFILE_240P_3 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_240P_3 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
240 x 240 @ 15 fps, 140 kbit/s
VIDEO_PROFILE_240P_4 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_240P_4 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
424 x 240 @ 15 fps, 220 kbit/s
VIDEO_PROFILE_360P - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_360P - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
640 x 360 @ 15 fps, 400 kbit/s
VIDEO_PROFILE_360P_10 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_360P_11 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_360P_3 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_360P_3 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
360 x 360 @ 15 fps, 260 kbit/s
VIDEO_PROFILE_360P_4 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_360P_4 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
640 x 360 @ 30 fps, 600 kbit/s
VIDEO_PROFILE_360P_6 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_360P_6 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
360 x 360 @ 30 fps, 400 kbit/s
VIDEO_PROFILE_360P_7 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_360P_7 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
480 x 360 @ 15 fps, 320 kbit/s
VIDEO_PROFILE_360P_8 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_360P_8 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
480 x 360 @ 30 fps, 490 kbit/s
VIDEO_PROFILE_360P_9 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_480P - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_480P - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
640 x 480 @ 15 fps, 500 kbit/s
VIDEO_PROFILE_480P_10 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_480P_3 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_480P_3 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
480 x 480 @ 15 fps, 400 kbit/s
VIDEO_PROFILE_480P_4 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_480P_4 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
640 x 480 @ 30 fps, 750 kbit/s
VIDEO_PROFILE_480P_6 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_480P_6 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
480 x 480 @ 30 fps, 600 kbit/s
VIDEO_PROFILE_480P_8 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_480P_8 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
848 x 480 @ 15 fps, 610 kbit/s
VIDEO_PROFILE_480P_9 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_480P_9 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
848 x 480 @ 30 fps, 930 kbit/s
VIDEO_PROFILE_4K - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_4K - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
3840 x 2160 @ 30 fps, 8910 kbit/s
VIDEO_PROFILE_4K_3 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_4K_3 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
3840 x 2160 @ 60 fps, 13500 kbit/s
VIDEO_PROFILE_720P - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_720P - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
1280 x 720 @ 15 fps, 1130 kbit/s
VIDEO_PROFILE_720P_3 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_720P_3 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
1280 x 720 @ 30 fps, 1710 kbit/s
VIDEO_PROFILE_720P_5 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_720P_5 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
960 x 720 @ 15 fps, 910 kbit/s
VIDEO_PROFILE_720P_6 - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_720P_6 - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
960 x 720 @ 30 fps, 1380 kbit/s
VIDEO_PROFILE_DEFAULT - Static variable in class io.agora.rtc2.Constants
Deprecated.
VIDEO_PROFILE_DEFAULT - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
Default video profile: 640 x 360 @ 15 fps, 400 kbit/s
VIDEO_PUBLICATION - Enum constant in enum class io.agora.rtc2.DirectCdnStreamingReason
Deprecated.
3: An error occurs when pushing video streams.
VIDEO_QOE_PREFERENCE_BALANCE - Enum constant in enum class io.agora.rtc2.Constants.QoEPreference
0: Default QoE type, balance the delay, picture quality and fluency.
VIDEO_QOE_PREFERENCE_DELAY_FIRST - Enum constant in enum class io.agora.rtc2.Constants.QoEPreference
1: lower the e2e delay.
VIDEO_QOE_PREFERENCE_FLUENCY_FIRST - Enum constant in enum class io.agora.rtc2.Constants.QoEPreference
0: more fluency.
VIDEO_QOE_PREFERENCE_PICTURE_QUALITY_FIRST - Enum constant in enum class io.agora.rtc2.Constants.QoEPreference
1: picture quality.
VIDEO_SOURCE_CAMERA_FOURTH - Enum constant in enum class io.agora.rtc2.Constants.VideoSourceType
12: The fourth camera.
VIDEO_SOURCE_CAMERA_PRIMARY - Enum constant in enum class io.agora.rtc2.Constants.VideoSourceType
0: (Default) The primary camera.
VIDEO_SOURCE_CAMERA_PRIMARY - Static variable in class io.agora.rtc2.Constants
Video captured by the camera.
VIDEO_SOURCE_CAMERA_SECONDARY - Enum constant in enum class io.agora.rtc2.Constants.VideoSourceType
1: The secondary camera.
VIDEO_SOURCE_CAMERA_SECONDARY - Static variable in class io.agora.rtc2.Constants
Video captured by the secondary camera.
VIDEO_SOURCE_CAMERA_THIRD - Enum constant in enum class io.agora.rtc2.Constants.VideoSourceType
11: The third camera.
VIDEO_SOURCE_CUSTOM - Enum constant in enum class io.agora.rtc2.Constants.VideoSourceType
4: A custom video source.
VIDEO_SOURCE_CUSTOM - Static variable in class io.agora.rtc2.Constants
Not define.
VIDEO_SOURCE_MEDIA_PLAYER - Enum constant in enum class io.agora.rtc2.Constants.VideoSourceType
5: The media player.
VIDEO_SOURCE_MEDIA_PLAYER - Static variable in class io.agora.rtc2.Constants
Video for media player sharing.
VIDEO_SOURCE_REMOTE - Enum constant in enum class io.agora.rtc2.Constants.VideoSourceType
9: One remote video acquired by the network.
VIDEO_SOURCE_REMOTE - Static variable in class io.agora.rtc2.Constants
Remote video received from network.
VIDEO_SOURCE_RTC_IMAGE_GIF - Enum constant in enum class io.agora.rtc2.Constants.VideoSourceType
8: One GIF image.
VIDEO_SOURCE_RTC_IMAGE_GIF - Static variable in class io.agora.rtc2.Constants
Video for png image.
VIDEO_SOURCE_RTC_IMAGE_JPEG - Enum constant in enum class io.agora.rtc2.Constants.VideoSourceType
7: One JPEG image.
VIDEO_SOURCE_RTC_IMAGE_JPEG - Static variable in class io.agora.rtc2.Constants
Video for png image.
VIDEO_SOURCE_RTC_IMAGE_PNG - Enum constant in enum class io.agora.rtc2.Constants.VideoSourceType
6: One PNG image.
VIDEO_SOURCE_RTC_IMAGE_PNG - Static variable in class io.agora.rtc2.Constants
Video for png image.
VIDEO_SOURCE_SCREEN_PRIMARY - Enum constant in enum class io.agora.rtc2.Constants.VideoSourceType
2: The primary screen.
VIDEO_SOURCE_SCREEN_PRIMARY - Static variable in class io.agora.rtc2.Constants
Video for screen sharing.
VIDEO_SOURCE_SCREEN_SECONDARY - Enum constant in enum class io.agora.rtc2.Constants.VideoSourceType
3: The secondary screen.
VIDEO_SOURCE_SCREEN_SECONDARY - Static variable in class io.agora.rtc2.Constants
Video for secondary screen sharing.
VIDEO_SOURCE_SPEECH_DRIVEN - Enum constant in enum class io.agora.rtc2.Constants.VideoSourceType
15: Video processed by the speech driven extension.
VIDEO_SOURCE_TRANSCODED - Enum constant in enum class io.agora.rtc2.Constants.VideoSourceType
10: One transcoded video source.
VIDEO_SOURCE_TRANSCODED - Static variable in class io.agora.rtc2.Constants
Video for transcoded.
VIDEO_SOURCE_UNKNOWN - Enum constant in enum class io.agora.rtc2.Constants.VideoSourceType
100: An unknown video source.
VIDEO_SOURCE_UNKNOWN - Static variable in class io.agora.rtc2.Constants
 
VIDEO_STREAM_HIGH - Enum constant in enum class io.agora.rtc2.Constants.VideoStreamType
0: High-quality video stream, that is, a video stream with the highest resolution and bitrate.
VIDEO_STREAM_HIGH - Static variable in class io.agora.rtc2.Constants
0: The high-stream video, that is, the video stream featuring in high resolution and high bitrate.
VIDEO_STREAM_LAYER_1 - Enum constant in enum class io.agora.rtc2.Constants.VideoStreamType
4.
VIDEO_STREAM_LAYER_2 - Enum constant in enum class io.agora.rtc2.Constants.VideoStreamType
5: Video stream layer 2.
VIDEO_STREAM_LAYER_3 - Enum constant in enum class io.agora.rtc2.Constants.VideoStreamType
6: Video stream layer 3.
VIDEO_STREAM_LAYER_4 - Enum constant in enum class io.agora.rtc2.Constants.VideoStreamType
7: Video stream layer 4.
VIDEO_STREAM_LAYER_5 - Enum constant in enum class io.agora.rtc2.Constants.VideoStreamType
8: Video stream layer 5.
VIDEO_STREAM_LAYER_6 - Enum constant in enum class io.agora.rtc2.Constants.VideoStreamType
9: Video stream layer 6.
VIDEO_STREAM_LOW - Enum constant in enum class io.agora.rtc2.Constants.VideoStreamType
1: Low-quality video stream, that is, a video stream with the lowest resolution and bitrate.
VIDEO_STREAM_LOW - Static variable in class io.agora.rtc2.Constants
1: The low-stream video, that is, the video stream featuring in low resolution and low bitrate.
VIDEO_TEXTURE_2D - Static variable in interface io.agora.rtc2.video.IVideoFrameObserver
10: GL_TEXTURE_2D
VIDEO_TEXTURE_OES - Static variable in interface io.agora.rtc2.video.IVideoFrameObserver
11: GL_TEXTURE_OES
videoBitrate - Variable in class io.agora.rtc2.DirectCdnStreamingStats
Deprecated.
The bitrate (bps) of the current video frame.
videoBitrate - Variable in class io.agora.rtc2.live.LiveInjectStreamConfig
 
videoBitrate - Variable in class io.agora.rtc2.live.LiveTranscoding
The encoding bitrate (Kbps) of the video.
VideoCanvas - Class in io.agora.rtc2.video
 
VideoCanvas(View) - Constructor for class io.agora.rtc2.video.VideoCanvas
 
VideoCanvas(View, int, int) - Constructor for class io.agora.rtc2.video.VideoCanvas
 
VideoCanvas(View, int, int, int) - Constructor for class io.agora.rtc2.video.VideoCanvas
 
videoCaptureParameters - Variable in class io.agora.rtc2.ScreenCaptureParameters
The video configuration for the shared screen stream.
VideoCaptureParameters() - Constructor for class io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters
 
videoCodecProfile - Variable in class io.agora.rtc2.live.LiveTranscoding
Video codec profile type for Media Push.
videoCodecType - Variable in class io.agora.rtc2.live.LiveTranscoding
Video codec profile types for Media Push.
VideoCompositingLayout - Class in io.agora.rtc2.video
Deprecated.
VideoCompositingLayout() - Constructor for class io.agora.rtc2.video.VideoCompositingLayout
Deprecated.
 
VideoCompositingLayout.Builder - Class in io.agora.rtc2.video
Deprecated.
 
VideoCompositingLayout.Canvas - Class in io.agora.rtc2.video
Deprecated.
 
VideoCompositingLayout.Region - Class in io.agora.rtc2.video
Deprecated.
 
VideoDenoiserOptions - Class in io.agora.rtc2.video
 
VideoDenoiserOptions() - Constructor for class io.agora.rtc2.video.VideoDenoiserOptions
 
VideoDenoiserOptions(int, int) - Constructor for class io.agora.rtc2.video.VideoDenoiserOptions
 
VideoDimensions() - Constructor for class io.agora.rtc2.video.VideoEncoderConfiguration.VideoDimensions
 
VideoDimensions(int, int) - Constructor for class io.agora.rtc2.video.VideoEncoderConfiguration.VideoDimensions
 
VideoEncoderConfiguration - Class in io.agora.rtc2.video
 
VideoEncoderConfiguration() - Constructor for class io.agora.rtc2.video.VideoEncoderConfiguration
 
VideoEncoderConfiguration(int, int, VideoEncoderConfiguration.FRAME_RATE, int, VideoEncoderConfiguration.ORIENTATION_MODE) - Constructor for class io.agora.rtc2.video.VideoEncoderConfiguration
 
VideoEncoderConfiguration(int, int, VideoEncoderConfiguration.FRAME_RATE, int, VideoEncoderConfiguration.ORIENTATION_MODE, VideoEncoderConfiguration.MIRROR_MODE_TYPE) - Constructor for class io.agora.rtc2.video.VideoEncoderConfiguration
 
VideoEncoderConfiguration(VideoEncoderConfiguration.VideoDimensions, VideoEncoderConfiguration.FRAME_RATE, int, VideoEncoderConfiguration.ORIENTATION_MODE) - Constructor for class io.agora.rtc2.video.VideoEncoderConfiguration
 
VideoEncoderConfiguration(VideoEncoderConfiguration.VideoDimensions, VideoEncoderConfiguration.FRAME_RATE, int, VideoEncoderConfiguration.ORIENTATION_MODE, VideoEncoderConfiguration.MIRROR_MODE_TYPE) - Constructor for class io.agora.rtc2.video.VideoEncoderConfiguration
 
VideoEncoderConfiguration.AdvanceOptions - Class in io.agora.rtc2.video
 
VideoEncoderConfiguration.CODEC_CAP_MASK - Enum Class in io.agora.rtc2.video
Supported codec type bit mask.
VideoEncoderConfiguration.COMPRESSION_PREFERENCE - Enum Class in io.agora.rtc2.video
 
VideoEncoderConfiguration.DEGRADATION_PREFERENCE - Enum Class in io.agora.rtc2.video
 
VideoEncoderConfiguration.ENCODING_PREFERENCE - Enum Class in io.agora.rtc2.video
 
VideoEncoderConfiguration.FRAME_RATE - Enum Class in io.agora.rtc2.video
 
VideoEncoderConfiguration.MIRROR_MODE_TYPE - Enum Class in io.agora.rtc2.video
Video mirror mode types.
VideoEncoderConfiguration.ORIENTATION_MODE - Enum Class in io.agora.rtc2.video
 
VideoEncoderConfiguration.VIDEO_CODEC_TYPE - Enum Class in io.agora.rtc2.video
 
VideoEncoderConfiguration.VideoDimensions - Class in io.agora.rtc2.video
 
videoFramerate - Variable in class io.agora.rtc2.live.LiveInjectStreamConfig
 
videoFramerate - Variable in class io.agora.rtc2.live.LiveTranscoding
Frame rate (fps) of the output video stream set for Media Push.
videoGop - Variable in class io.agora.rtc2.live.LiveInjectStreamConfig
 
videoGop - Variable in class io.agora.rtc2.live.LiveTranscoding
GOP (Group of Pictures) in fps of the video frames for Media Push.
videoHeight - Variable in class io.agora.mediaplayer.data.PlayerUpdatedInfo
Height (pixel) of the video.
videoHeight - Variable in class io.agora.rtc2.DirectCdnStreamingStats
Deprecated.
The height (px) of the video frame.
VideoLayout() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.VideoLayout
 
VideoLayoutInfo() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.VideoLayoutInfo
 
videoOutputConfiguration - Variable in class io.agora.rtc2.LocalTranscoderConfiguration
The encoding configuration of the mixed video stream after the local video mixing.
VideoProfile() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
 
VideoRenderingTracingInfo() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.VideoRenderingTracingInfo
 
videoSourceType - Variable in class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
The type of the video source for recording.
videoState - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayout
Status of the sub-video stream on the video mixing canvas.
VideoSubscriptionOptions - Class in io.agora.rtc2.video
 
VideoSubscriptionOptions() - Constructor for class io.agora.rtc2.video.VideoSubscriptionOptions
 
VideoSubscriptionOptions(VideoSubscriptionOptions.REMOTE_VIDEO_STREAM_TYPE, boolean) - Constructor for class io.agora.rtc2.video.VideoSubscriptionOptions
 
VideoSubscriptionOptions.REMOTE_VIDEO_STREAM_TYPE - Enum Class in io.agora.rtc2.video
 
videoWidth - Variable in class io.agora.mediaplayer.data.PlayerUpdatedInfo
Width (pixel) of the video.
videoWidth - Variable in class io.agora.rtc2.DirectCdnStreamingStats
Deprecated.
The width (px) of the video frame.
view - Variable in class io.agora.rtc2.EchoTestConfiguration
The view used to render the local user's video.
view - Variable in class io.agora.rtc2.video.VideoCanvas
The video display window.
VIEW_SETUP_MODE_ADD - Static variable in class io.agora.rtc2.video.VideoCanvas
 
VIEW_SETUP_MODE_REMOVE - Static variable in class io.agora.rtc2.video.VideoCanvas
 
VIEW_SETUP_MODE_REPLACE - Static variable in class io.agora.rtc2.video.VideoCanvas
 
VirtualBackgroundSource - Class in io.agora.rtc2.video
 
VirtualBackgroundSource() - Constructor for class io.agora.rtc2.video.VirtualBackgroundSource
 
VirtualBackgroundSource(int, int, String, int) - Constructor for class io.agora.rtc2.video.VirtualBackgroundSource
 
visibleInPreview - Variable in class io.agora.rtc2.video.WatermarkOptions
Whether the watermark is visible in the local preview view: - `true`: (Default) The watermark is visible in the local preview view.
VOICE_AI_TUNER_DREAMY_FEMALE_SINGING - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
9: Dreamy female singing.
VOICE_AI_TUNER_ELEGANT_FEMALE - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
2: Elegant female voice.
VOICE_AI_TUNER_FRESH_MALE - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
1: Fresh male voice.
VOICE_AI_TUNER_GENTLE_FEMALE_SINGING - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
5: Gentle female singing.
VOICE_AI_TUNER_HUSKY_MALE_SINGING - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
6: Husky male singing.
VOICE_AI_TUNER_MATURE_MALE - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
0: Mature male voice.
VOICE_AI_TUNER_POWERFUL_MALE_SINGING - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
8: Powerful male singing.
VOICE_AI_TUNER_SWEET_FEMALE - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
3: Sweet female voice.
VOICE_AI_TUNER_WARM_ELEGANT_FEMALE_SINGING - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
7: Warm elegant female singing.
VOICE_AI_TUNER_WARM_MALE_SINGING - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
4: Warm male singing.
VOICE_BEAUTIFIER_OFF - Static variable in class io.agora.rtc2.Constants
Turn off voice beautifier effects and use the original voice.
VOICE_CHANGER_BASS - Static variable in class io.agora.rtc2.Constants
A deep voice.
VOICE_CHANGER_CARTOON - Static variable in class io.agora.rtc2.Constants
A voice like a cartoon character.
VOICE_CHANGER_CHILDLIKE - Static variable in class io.agora.rtc2.Constants
A voice like a child.
VOICE_CHANGER_CHIPMUNK - Static variable in class io.agora.rtc2.Constants
A voice like chipmunk.
VOICE_CHANGER_DARTH_VADER - Static variable in class io.agora.rtc2.Constants
A voice like Darth Vader.
VOICE_CHANGER_EFFECT_BOY - Static variable in class io.agora.rtc2.Constants
The voice of a boy.
VOICE_CHANGER_EFFECT_GIRL - Static variable in class io.agora.rtc2.Constants
The voice of a girl.
VOICE_CHANGER_EFFECT_HULK - Static variable in class io.agora.rtc2.Constants
The voice of Hulk.
VOICE_CHANGER_EFFECT_OLDMAN - Static variable in class io.agora.rtc2.Constants
The voice of an old man.
VOICE_CHANGER_EFFECT_PIGKING - Static variable in class io.agora.rtc2.Constants
The voice of Pig King, a character in Journey to the West who has a voice like a growling bear.
VOICE_CHANGER_EFFECT_SISTER - Static variable in class io.agora.rtc2.Constants
The voice of a young woman.
VOICE_CHANGER_EFFECT_UNCLE - Static variable in class io.agora.rtc2.Constants
The voice of a middle-aged man.
VOICE_CHANGER_GIRLISH_MAN - Static variable in class io.agora.rtc2.Constants
A voice like a castrato.
VOICE_CHANGER_GROOT - Static variable in class io.agora.rtc2.Constants
A voice like Groot.
VOICE_CHANGER_IRON_LADY - Static variable in class io.agora.rtc2.Constants
A rough female voice.
VOICE_CHANGER_MONSTER - Static variable in class io.agora.rtc2.Constants
A monster voice.
VOICE_CHANGER_NEUTRAL - Static variable in class io.agora.rtc2.Constants
A gender-neutral voice.
VOICE_CHANGER_PHONE_OPERATOR - Static variable in class io.agora.rtc2.Constants
A voice like a phone operator.
VOICE_CHANGER_SHIN_CHAN - Static variable in class io.agora.rtc2.Constants
A voice like Crayon Shin-chan.
VOICE_CHANGER_SOLID - Static variable in class io.agora.rtc2.Constants
A steady voice.
VOICE_CHANGER_SWEET - Static variable in class io.agora.rtc2.Constants
A sweet voice.
VOICE_CHANGER_TRANSFORMERS - Static variable in class io.agora.rtc2.Constants
A voice like Transformers.
VOICE_CONVERSION_OFF - Static variable in class io.agora.rtc2.Constants
Turn off voice conversion effects and use the original voice.
voicePitch - Variable in class io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo
The voice pitch of the local user.
volume - Variable in class io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo
The volume of the user.
VT_ERR_INTERNAL - Static variable in class io.agora.rtc2.Constants
Internal error.
VT_ERR_INVALID_IMAGE_PATH - Static variable in class io.agora.rtc2.Constants
The image url is not correctly of image source.
VT_ERR_INVALID_LAYOUT - Static variable in class io.agora.rtc2.Constants
The layout is invalid such as width is zero.
VT_ERR_INVALID_VIDEO_SOURCE_TYPE - Static variable in class io.agora.rtc2.Constants
The video source type is not supported.
VT_ERR_UNSUPPORT_IMAGE_FORMAT - Static variable in class io.agora.rtc2.Constants
The image format not the type png/jpeg/gif of image source.
VT_ERR_VIDEO_SOURCE_NOT_READY - Static variable in class io.agora.rtc2.Constants
The video track of the video source is not started.

W

WARN_ADM_GLITCH_STATE - Static variable in class io.agora.rtc2.Constants
Audio Device Module: The device is in the glitch state.
WARN_ADM_IMPROPER_SETTINGS - Static variable in class io.agora.rtc2.Constants
Audio Device Module: The settings are improper.
WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL - Static variable in class io.agora.rtc2.Constants
Audio Device Module: The playback audio volume is too low.
WARN_ADM_POP_STATE - Static variable in class io.agora.rtc2.Constants
Audio Device Module: The device is in the pop state.
WARN_ADM_RECORD_AUDIO_LOWLEVEL - Static variable in class io.agora.rtc2.Constants
Audio Device Module: The recorded audio volume is too low.
WARN_ADM_RECORD_AUDIO_SILENCE - Static variable in class io.agora.rtc2.Constants
Audio Device Module: No valid audio data is collected.
WARN_ADM_RECORD_AUDIO_SILENCE - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.WarnCode
1019: Audio Device Module: No valid audio data is collected.
WARN_ADM_RECORD_IS_OCCUPIED - Static variable in class io.agora.rtc2.Constants
Audio Device Module: The recording device is occupied.
WARN_ADM_RECORD_IS_OCCUPIED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.WarnCode
1033: Audio Device Module: The recording device is occupied.
WARN_ADM_RUNTIME_PLAYOUT_WARNING - Static variable in class io.agora.rtc2.Constants
Audio Device Module: A warning in the runtime playback device.
WARN_ADM_RUNTIME_PLAYOUT_WARNING - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.WarnCode
1014: Audio Device Module: A warning occurs in the playback device.
WARN_ADM_RUNTIME_RECORDING_WARNING - Static variable in class io.agora.rtc2.Constants
Audio Device Module: A warning in the runtime recording device.
WARN_ADM_RUNTIME_RECORDING_WARNING - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.WarnCode
1016: Audio Device Module: A warning occurs in the recording device.
WARN_APM_HOWLING - Static variable in class io.agora.rtc2.Constants
Audio Device Module: Howling is detected.
WARN_APM_HOWLING - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.WarnCode
1051: Audio Device Module: Howling is detected.
WARN_AUDIO_MIXING_OPEN_ERROR - Static variable in class io.agora.rtc2.Constants
Error in opening the audio mixing.
WARN_AUDIO_MIXING_OPEN_ERROR - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.WarnCode
701: An error occurs when opening the audio mixing file.
WARN_INIT_VIDEO - Static variable in class io.agora.rtc2.Constants
Failed to initialize the video function.
WARN_INIT_VIDEO - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.WarnCode
16: Fails to initialize the video function, possibly caused by lack of resources.
WARN_INVALID_VIEW - Static variable in class io.agora.rtc2.Constants
The specified view is invalid.
WARN_INVALID_VIEW - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.WarnCode
8: The specified view is invalid.
WARN_LOOKUP_CHANNEL_REJECTED - Static variable in class io.agora.rtc2.Constants
The server rejected the request to look up the channel.
WARN_LOOKUP_CHANNEL_REJECTED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.WarnCode
105: The server rejects the request to look up the channel.
WARN_LOOKUP_CHANNEL_TIMEOUT - Static variable in class io.agora.rtc2.Constants
A timeout when looking up the channel.
WARN_LOOKUP_CHANNEL_TIMEOUT - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.WarnCode
104: A timeout occurs when looking up the channel.
WARN_NO_AVAILABLE_CHANNEL - Static variable in class io.agora.rtc2.Constants
No channel resources are available.
WARN_NO_AVAILABLE_CHANNEL - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.WarnCode
103: No channel resources are available.
WARN_OPEN_CHANNEL_INVALID_TICKET - Static variable in class io.agora.rtc2.Constants
The ticket to open the channel is invalid.
WARN_OPEN_CHANNEL_INVALID_TICKET - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.WarnCode
121: The ticket to open the channel is invalid.
WARN_OPEN_CHANNEL_REJECTED - Static variable in class io.agora.rtc2.Constants
The server rejected the request to open the channel.
WARN_OPEN_CHANNEL_REJECTED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.WarnCode
107: The server rejects the request to open the channel.
WARN_OPEN_CHANNEL_TIMEOUT - Static variable in class io.agora.rtc2.Constants
A timeout when opening the channel.
WARN_OPEN_CHANNEL_TIMEOUT - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.WarnCode
106: A timeout occurs when opening the channel.
WARN_OPEN_CHANNEL_TRY_NEXT_VOS - Static variable in class io.agora.rtc2.Constants
Try connecting to another server.
WARN_OPEN_CHANNEL_TRY_NEXT_VOS - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.WarnCode
122: Try another server.
WARN_PENDING - Static variable in class io.agora.rtc2.Constants
The request is pending, usually due to some module not being ready, and the SDK postponed processing the request.
WARN_PENDING - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.WarnCode
20: The request is pending, usually due to some module not being ready, and the SDK postponed processing the request.
WARN_SET_CLIENT_ROLE_NOT_AUTHORIZED - Static variable in class io.agora.rtc2.Constants
The client role is not authorized.
WARN_SET_CLIENT_ROLE_TIMEOUT - Static variable in class io.agora.rtc2.Constants
A timeout when setting the client role in the broadcast mode.
WARN_SWITCH_LIVE_VIDEO_TIMEOUT - Static variable in class io.agora.rtc2.Constants
A timeout when switching the live video.
WarnCode() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.WarnCode
 
WATERMARK_BUFFER_FORMAT_BGRA - Static variable in class io.agora.rtc2.video.WatermarkBuffer
Specifies the watermark buffer format as BGRA.
WATERMARK_BUFFER_FORMAT_I420 - Static variable in class io.agora.rtc2.video.WatermarkBuffer
Specifies the watermark buffer format as I420.
WATERMARK_BUFFER_FORMAT_NV21 - Static variable in class io.agora.rtc2.video.WatermarkBuffer
Specifies the watermark buffer format as NV21.
WATERMARK_BUFFER_FORMAT_RGBA - Static variable in class io.agora.rtc2.video.WatermarkBuffer
Specifies the watermark buffer format as RGBA.
WATERMARK_TYPE_BUFFER - Static variable in class io.agora.rtc2.video.WatermarkConfig
Specifies the watermark type as buffer.
WATERMARK_TYPE_IMAGE - Static variable in class io.agora.rtc2.video.WatermarkConfig
Specifies the watermark type as image.
WatermarkBuffer - Class in io.agora.rtc2.video
 
WatermarkBuffer() - Constructor for class io.agora.rtc2.video.WatermarkBuffer
 
WatermarkConfig - Class in io.agora.rtc2.video
 
WatermarkConfig() - Constructor for class io.agora.rtc2.video.WatermarkConfig
 
WatermarkOptions - Class in io.agora.rtc2.video
 
WatermarkOptions() - Constructor for class io.agora.rtc2.video.WatermarkOptions
 
WatermarkOptions.Rectangle - Class in io.agora.rtc2.video
 
width - Variable in class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
Width (px) of the recorded video.
width - Variable in class io.agora.rtc2.IRtcEngineEventHandler.AgoraFacePositionInfo
The width (px) of the human face in the captured video.
width - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
The width (pixels) of the video.
width - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayout
Width (px) of the sub-video stream.
width - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayoutInfo
The width of the mixed video stream (px).
width - Variable in class io.agora.rtc2.live.LiveInjectStreamConfig
 
width - Variable in class io.agora.rtc2.live.LiveTranscoding.TranscodingUser
The width (pixel) of the host's video.
width - Variable in class io.agora.rtc2.live.LiveTranscoding
The width of the video in pixels.
width - Variable in class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
The width (px) of the video for local video mixing on the canvas.
width - Variable in class io.agora.rtc2.PublisherParameters
Deprecated.
 
width - Variable in class io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters
The width (px) of the video encoding resolution.
width - Variable in class io.agora.rtc2.video.AgoraImage
The width (px) of the image on the video frame.
width - Variable in class io.agora.rtc2.video.CameraCapturerConfiguration.CaptureFormat
The width (px) of the video frame.
width - Variable in class io.agora.rtc2.video.EncodedVideoFrameInfo
Width (pixel) of the video frame.
width - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Canvas
Deprecated.
 
width - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
width - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration.VideoDimensions
The width (pixels) of the video.
width - Variable in class io.agora.rtc2.video.WatermarkBuffer
Width of the watermark buffer, in pixels.
width - Variable in class io.agora.rtc2.video.WatermarkOptions.Rectangle
The width of the target area.
WIFI_BLUETOOTH_COEXIST - Static variable in class io.agora.rtc2.Constants
8: The local user enables both Wi-Fi and bluetooth, and their signals interfere with each other.
wifiRxBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.MultipathStats
The total number of bytes received over Wi-Fi.
wifiTxBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.MultipathStats
The total number of bytes sent over Wi-Fi.
WIRELESS_SIGNAL_POOR - Static variable in class io.agora.rtc2.Constants
4: The local user's Wi-Fi or mobile network signal is weak.
writeLog(int, String, Object...) - Method in class io.agora.rtc2.RtcEngine
Write the log to SDK .

X

x - Variable in class io.agora.rtc2.IRtcEngineEventHandler.AgoraFacePositionInfo
The x-coordinate (px) of the human face in the local video.
x - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayout
X-coordinate (px) of the sub-video stream on the mixing canvas.
x - Variable in class io.agora.rtc2.live.LiveTranscoding.TranscodingUser
The x coordinate (pixel) of the host's video on the output video frame (taking the upper left corner of the video frame as the origin).
x - Variable in class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
The relative lateral displacement of the top left corner of the video for local video mixing to the origin (the top left corner of the canvas).
x - Variable in class io.agora.rtc2.video.AgoraImage
The x-coordinate (px) of the image on the video frame (taking the upper left corner of the video frame as the origin).
x - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
x - Variable in class io.agora.rtc2.video.WatermarkOptions.Rectangle
The horizontal offset from the top-left corner.

Y

y - Variable in class io.agora.rtc2.IRtcEngineEventHandler.AgoraFacePositionInfo
The y-coordinate (px) of the human face in the local video.
y - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayout
Y-coordinate (px) of the sub-video stream on the mixing canvas.
y - Variable in class io.agora.rtc2.live.LiveTranscoding.TranscodingUser
The y coordinate (pixel) of the host's video on the output video frame (taking the upper left corner of the video frame as the origin).
y - Variable in class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
The relative longitudinal displacement of the top left corner of the captured video to the origin (the top left corner of the canvas).
y - Variable in class io.agora.rtc2.video.AgoraImage
The y-coordinate (px) of the image on the video frame (taking the upper left corner of the video frame as the origin).
y - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
y - Variable in class io.agora.rtc2.video.WatermarkOptions.Rectangle
The vertical offset from the top-left corner.

Z

zoneSetId - Variable in class io.agora.spatialaudio.SpatialAudioZone
The ID of the sound insulation area.
zOrder - Variable in class io.agora.rtc2.live.LiveTranscoding.TranscodingUser
The layer index number of the host's video.
zOrder - Variable in class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
The number of the layer to which the video for the local video mixing belongs.
zOrder - Variable in class io.agora.rtc2.video.AgoraImage
The layer index of the watermark or background image.
zOrder - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
zOrder - Variable in class io.agora.rtc2.video.WatermarkOptions
Layer order of the watermark image.
zOrder(int) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
A B C D E F G H I J L M N O P Q R S T U V W X Y Z 
All Classes and Interfaces|All Packages|Constant Field Values