Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- activePathNum - Variable in class io.agora.rtc2.IRtcEngineEventHandler.MultipathStats
-
Number of active 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
-
Adds the IRtcEngineEventHandler.
- 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.
- 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. This method adds a PNG watermark image to the local video stream in a live streaming. Once the watermark image is added, all the audience in the channel (CDN audience included), and the sampling device can see and capture it. Agora supports adding only one watermark image onto the local video, and the newly watermark image replaces the previous one. The watermark position depends on the settings in thesetVideoEncoderConfigurationmethod: - If the orientation mode of the encoding video is ORIENTATION_MODE_FIXED_LANDSCAPE, or the landscape mode in ORIENTATION_MODE_ADAPTIVE, the watermark uses the landscape orientation. - If the orientation mode of the encoding video is ORIENTATION_MODE_FIXED_PORTRAIT, or the portrait mode in ORIENTATION_MODE_ADAPTIVE, the watermark uses the portrait orientation. - When setting the watermark position, the region must be less than the dimensions set in the setVideoEncoderConfiguration method. Otherwise, the watermark image will be cropped. - 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. This method adds a PNG watermark image to the local video stream in a live streaming. Once the watermark image is added, all the audience in the channel (CDN audience included), and the sampling device can see and capture it. Agora supports adding only one watermark image onto the local video, and the newly watermark image replaces the previous one. The watermark position depends on the settings in thesetVideoEncoderConfigurationmethod: - If the orientation mode of the encoding video is ORIENTATION_MODE_FIXED_LANDSCAPE, or the landscape mode in ORIENTATION_MODE_ADAPTIVE, the watermark uses the landscape orientation. - If the orientation mode of the encoding video is ORIENTATION_MODE_FIXED_PORTRAIT, or the portrait mode in ORIENTATION_MODE_ADAPTIVE, the watermark uses the portrait orientation. - When setting the watermark position, the region must be less than the dimensions set in the setVideoEncoderConfiguration method. Otherwise, the watermark image will be cropped. - 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
-
Adjusts the audio mixing volume for local playback.
- adjustAudioMixingPublishVolume(int) - Method in class io.agora.rtc2.RtcEngine
-
Adjusts the audio mixing volume for publishing (for remote users).
- adjustAudioMixingVolume(int) - Method in class io.agora.rtc2.RtcEngine
-
Adjusts the volume of audio mixing.
- adjustCustomAudioPlayoutVolume(int, int) - Method in class io.agora.rtc2.RtcEngine
-
Adjust the custom audio playout volume by source id.
- adjustCustomAudioPublishVolume(int, int) - Method in class io.agora.rtc2.RtcEngine
-
Adjust the custom audio publish volume by source id.
- adjustPlaybackSignalVolume(int) - Method in class io.agora.rtc2.RtcEngine
-
Adjusts the playback volume.
- 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
-
Adjusts the recording volume.
- adjustRecordingSignalVolumeEx(int, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Adjusts the recording volume.
- adjustUserPlaybackSignalVolume(int, int) - Method in class io.agora.rtc2.RtcEngine
-
Adjust the playback volume of the user specified by uid.
- adjustUserPlaybackSignalVolumeEx(int, int, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Adjust the playback signal volume of a specified remote user.
- 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
-
Local proxy connection, advanced Config info.
- AdvancedConfigInfo() - Constructor for class io.agora.rtc2.proxy.LocalAccessPointConfiguration.AdvancedConfigInfo
- advanceOptions - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
-
The video hardwareEncoding: #hardwareEncoding and The video compressionPreference: #compressionPreference.
- 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
-
The signal delay estimated during the AEC process from nearin and farin (ms).
- AGORA_AUDIO_MONO_PROCESSING - Enum constant in enum class io.agora.rtc2.audio.AdvancedAudioOptions.AudioProcessingChannelsEnum
- AGORA_AUDIO_STEREO_PROCESSING - Enum constant in enum class io.agora.rtc2.audio.AdvancedAudioOptions.AudioProcessingChannelsEnum
- AgoraFacePositionInfo() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.AgoraFacePositionInfo
- AgoraFocalLengthInfo - Class in io.agora.rtc2.video
-
The definition of AgoraFocalLengthInfo.
- 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
-
Configurations for the local audio and video recording.
- AgoraMetadata - Class in io.agora.rtc2.video
-
The AgoraMetadata class.
- 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
-
The configuration of rhythm player, which is set in startRhythmPlayer or configRhythmPlayer.
- AgoraRhythmPlayerConfig() - Constructor for class io.agora.rtc2.audio.AgoraRhythmPlayerConfig
- AgoraVideoFrame - Class in io.agora.rtc2.video
-
The AgoraVideoFrame class, which defines the format of the external video source.
- AgoraVideoFrame() - Constructor for class io.agora.rtc2.video.AgoraVideoFrame
- allowCaptureCurrentApp - Variable in class io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters
-
Whether capture currentApp's audio - `true`:Capture(default)。 - `false`:Don't capture。
- alpha - Variable in class io.agora.rtc2.live.LiveTranscoding.TranscodingUser
-
The transparency level of the user's video that ranges between 0.0 and 1.0.
- alpha - Variable in class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
-
The transparency of the video for the video mixing on the local client.
- alpha - Variable in class io.agora.rtc2.video.AgoraImage
-
alpha of 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
-
The relative position between alphabuffer and the 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: Video Call Scenario.
- APPLICATION_SCENARIO_GENERAL - Enum constant in enum class io.agora.rtc2.Constants.VideoScenario
-
0: (Default) The general video scenario
- APPLICATION_SCENARIO_LIVESHOW - Enum constant in enum class io.agora.rtc2.Constants.VideoScenario
-
3: Live Show Scenario.
- APPLICATION_SCENARIO_MEETING - Enum constant in enum class io.agora.rtc2.Constants.VideoScenario
-
1: 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
-
(Default) 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 audience latency level type: - `AUDIENCE_LATENCY_LEVEL_LOW_LATENCY`(1): Low latency.
- audienceLatencyLevel - Variable in class io.agora.rtc2.ClientRoleOptions
-
The audience role level in broadcaster mode.
- 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
-
ChanLOut=ChanRout=ChanLin
- AUDIO_DUAL_MONO_MIX - Enum constant in enum class io.agora.mediaplayer.Constants.AudioDualMonoMode
-
ChanLout=ChanRout=(ChanLin+ChanRin)/2
- AUDIO_DUAL_MONO_R - Enum constant in enum class io.agora.mediaplayer.Constants.AudioDualMonoMode
-
ChanLOut=ChanRout=ChanRin
- AUDIO_DUAL_MONO_STEREO - Enum constant in enum class io.agora.mediaplayer.Constants.AudioDualMonoMode
-
ChanLOut=ChanLin, ChanRout=ChanRin
- 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
- AUDIO_MIXING_DUAL_MONO_L - Enum constant in enum class io.agora.rtc2.Constants.AudioMixingDualMonoMode
- AUDIO_MIXING_DUAL_MONO_MIX - Enum constant in enum class io.agora.rtc2.Constants.AudioMixingDualMonoMode
- AUDIO_MIXING_DUAL_MONO_R - Enum constant in enum class io.agora.rtc2.Constants.AudioMixingDualMonoMode
- 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: The 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.audio.
- 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: Microphone.
- AUDIO_REVERB_DRY_LEVEL - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_REVERB_TYPE
-
Level of the dry signal (-20 to 10 dB).
- AUDIO_REVERB_ROOM_SIZE - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_REVERB_TYPE
-
Room size of the reflection (0 to 100 dB).
- AUDIO_REVERB_STRENGTH - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_REVERB_TYPE
-
Strength of the late reverberation (0 to 100).
- AUDIO_REVERB_WET_DELAY - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_REVERB_TYPE
-
Length of the initial delay of the wet signal (0 to 200 ms)
- AUDIO_REVERB_WET_LEVEL - Enum constant in enum class io.agora.rtc2.Constants.AUDIO_REVERB_TYPE
-
Level of the early reflection signal (wet signal) (-20 to 10 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
-
Audio generated by the customer.
- AUDIO_SOURCE_LOOPBACK_RECORDING - Enum constant in enum class io.agora.rtc2.Constants.AudioSourceType
-
Audio of loopback recording.
- AUDIO_SOURCE_MEDIA_PLAYER - Enum constant in enum class io.agora.rtc2.Constants.AudioSourceType
-
Audio of media player.
- AUDIO_SOURCE_MICROPHONE - Enum constant in enum class io.agora.rtc2.Constants.AudioSourceType
-
Audio captured by the microphone.
- AUDIO_SOURCE_MIXED_STREAM - Enum constant in enum class io.agora.rtc2.Constants.AudioSourceType
-
Audio of mixed stream in local client.
- AUDIO_SOURCE_REMOTE_CHANNEL - Enum constant in enum class io.agora.rtc2.Constants.AudioSourceType
-
Remote audio received of per channel from network.
- AUDIO_SOURCE_REMOTE_USER - Enum constant in enum class io.agora.rtc2.Constants.AudioSourceType
-
Remote audio received of per user from network.
- AUDIO_SOURCE_UNKNOWN - Enum constant in enum class io.agora.rtc2.Constants.AudioSourceType
-
Not define.
- AUDIO_TRACK_DIRECT - Enum constant in enum class io.agora.rtc2.Constants.AudioTrackType
-
1: Direct audio track You can only push one direct (non-mixable) audio track into one RTC connection(channel id + uid).
- AUDIO_TRACK_MIXABLE - Enum constant in enum class io.agora.rtc2.Constants.AudioTrackType
-
0: Mixable audio track You can push more than one mixable Audio tracks into one RTC connection(channel id + uid), and SDK will mix these tracks into one audio track automatically.
- audioAttenuation - Variable in class io.agora.spatialaudio.SpatialAudioZone
- audioBitrate - Variable in class io.agora.rtc2.DirectCdnStreamingStats
-
Deprecated.Real-time bit rate of the audio pushed by rtmp.
- audioBitrate - Variable in class io.agora.rtc2.live.LiveInjectStreamConfig
- audioBitrate - Variable in class io.agora.rtc2.live.LiveTranscoding
-
Bitrate (Kbps) of the CDN live audio output stream.
- audioBitsPerSample - Variable in class io.agora.mediaplayer.data.PlayerUpdatedInfo
-
The bit number of each audio sample.
- 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 ranging between 0 and 5.
- audioChannels - Variable in class io.agora.mediaplayer.data.PlayerUpdatedInfo
-
The audio channel number.
- audioChannels - Variable in class io.agora.rtc2.live.LiveInjectStreamConfig
- audioChannels - Variable in class io.agora.rtc2.live.LiveTranscoding
-
The number of audio channels for the CDN live stream.
- audioCodecProfile - Variable in class io.agora.rtc2.live.LiveTranscoding
-
Audio codec profile type:
AudioCodecProfileType. - audioDelayMs - Variable in class io.agora.rtc2.ChannelMediaOptions
-
The delay in ms for sending audio frames.
- audioDeviceDelay - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalAudioStats
-
The audio delay of the device, contains record and playout delay
- 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 audio streams for the audio mixing on the local client.
- audioLossRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
-
The packet loss rate in the reported interval.
- AudioParams - Class in io.agora.rtc2.audio
-
The `AudioParams` class.
- 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
- audioSampleRate - Variable in class io.agora.mediaplayer.data.PlayerUpdatedInfo
-
Audio sample rate.
- audioSampleRate - Variable in class io.agora.rtc2.live.LiveInjectStreamConfig
- audioSampleRate - Variable in class io.agora.rtc2.live.LiveTranscoding
-
Self-defined audio-sample rate:
AudioSampleRateType. - 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
-
The configuration of custom audio track which is set in createCustomAudioTrack.
- 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
- autoSubscribeAudio - Variable in class io.agora.rtc2.ChannelMediaOptions
-
Determines whether to subscribe all remote audio streams automatically.
- autoSubscribeVideo - Variable in class io.agora.rtc2.ChannelMediaOptions
-
Determines whether to subscribe all remote video streams automatically.
- 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 offset (ms) between audio and video stream.
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
setBackgroundColormethod to set the background color. - backgroundColor - Variable in class io.agora.rtc2.video.VideoCanvas
-
A RGBA value indicates background color of the render view.
- backgroundColor - Variable in class io.agora.rtc2.video.VideoCompositingLayout
-
Deprecated.
- backgroundSourceType - Variable in class io.agora.rtc2.video.VirtualBackgroundSource
-
The source type used to substitude capture image background.
- BAD - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.Quality
-
Deprecated.
- BAD_NAME - Enum constant in enum class io.agora.rtc2.DirectCdnStreamingReason
-
Deprecated.Generally, Already exist stream name.
- 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.
- beatsPerMeasure - Variable in class io.agora.rtc2.audio.AgoraRhythmPlayerConfig
-
The number of beats per measure.
- beatsPerMinute - Variable in class io.agora.rtc2.audio.AgoraRhythmPlayerConfig
- BEAUTY - Enum constant in enum class io.agora.rtc2.IVideoEffectObject.VIDEO_EFFECT_NODE_ID
-
Beauty effect node.
- BeautyOptions - Class in io.agora.rtc2.video
-
Sets the image enhancement options.
- 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
-
The video bitrate (Kbps).
- bitrate - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
-
The bitrate of the video (Kbps).
- 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
-
Background blur degree
- buf - Variable in class io.agora.rtc2.video.AgoraVideoFrame
-
The buffer of this frame.
- buffer - Variable in class io.agora.base.AudioFrame
- buffer - Variable in class io.agora.rtc2.video.WatermarkBuffer
-
Stores the image data of the watermark.
- buffer - Variable in class io.agora.rtc2.video.WatermarkConfig
-
The buffer that contains the 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
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: Uses the extral camera.
- CAMERA_FOCAL_LENGTH_DEFAULT - Enum constant in enum class io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE
-
By default, there are no wide-angle and ultra-wide-angle properties.
- 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
-
Lens with focal length of less than 24mm.
- CAMERA_FOCAL_LENGTH_WIDE_ANGLE - Enum constant in enum class io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE
-
Lens with focal length from 24mm to 35mm.
- CAMERA_FRONT - Enum constant in enum class io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_DIRECTION
-
1: Uses the front camera.
- CAMERA_REAR - Enum constant in enum class io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_DIRECTION
-
0: Uses the rear camera.
- CameraCapturerConfiguration - Class in io.agora.rtc2.video
-
The definition of CameraCapturerConfiguration.
- 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
-
Sets the camera direction.
- CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE - Enum Class in io.agora.rtc2.video
-
Camera focal length type.
- CameraCapturerConfiguration.CaptureFormat - Class in io.agora.rtc2.video
- cameraDirection - Variable in class io.agora.rtc2.video.AgoraFocalLengthInfo
-
Camera orientation, front or back.
- cameraDirection - Variable in class io.agora.rtc2.video.CameraCapturerConfiguration
-
The camera direction.
- cameraFocalLengthType - Variable in class io.agora.rtc2.video.CameraCapturerConfiguration
- cameraId - Variable in class io.agora.rtc2.video.CameraCapturerConfiguration
-
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.
- 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
- 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 of the capture frame (px).
- captureFrameRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
-
The capture frame rate (fps) of the local video.
- captureFrameWidth - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
-
The width of the capture frame (px).
- 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
-
This is a input parameter which means the timestamp for capturing the video.
- captureVideo - Variable in class io.agora.rtc2.ScreenCaptureParameters
-
Determines whether to capture the screen during screen sharing: - `true`: (Default) Capture.
- 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`: Mono (Default) - `2`: Stereo
- channel_num - Variable in class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
-
The audio channel nums
- 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 channelId.
- 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
-
Channel Id from which this video stream come from.
- channelId - Variable in class io.agora.rtc2.LocalAudioMixerConfiguration.MixedAudioStream
-
The source type of audio for the audio mixing on the local client.
- channelId - Variable in class io.agora.rtc2.RecorderStreamInfo
-
The channel ID of the audio/video stream needs to be recorded.
- channelId - Variable in class io.agora.rtc2.RtcConnection
-
The unique channel name for the AgoraRTC session in the string format.
- channelId - Variable in class io.agora.rtc2.video.AgoraMetadata
-
The channel ID of the `metadata`.
- ChannelMediaInfo - Class in io.agora.rtc2.video
-
The ChannelMediaInfo class, which defines the media information of the channel.
- ChannelMediaInfo(String, String, int) - Constructor for class io.agora.rtc2.video.ChannelMediaInfo
- ChannelMediaOptions - Class in io.agora.rtc2
-
The channel media options.
- ChannelMediaOptions() - Constructor for class io.agora.rtc2.ChannelMediaOptions
- ChannelMediaOptions(Integer) - Constructor for class io.agora.rtc2.ChannelMediaOptions
- ChannelMediaRelayConfiguration - Class in io.agora.rtc2.video
-
The ChannelMediaRelayConfiguration class.
- 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
- channelProfile - Variable in class io.agora.rtc2.ChannelMediaOptions
-
The channel profile: - `CHANNEL_PROFILE_COMMUNICATION`(0): Communication.
- 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
-
Removes the watermark image from the video stream added by
addVideoWatermarkEx. - clearVideoWatermarks() - Method in class io.agora.rtc2.RtcEngine
-
Removes the watermark image from the video stream added by
addVideoWatermark. - 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
-
The ClientRoleOptions class.
- ClientRoleOptions() - Constructor for class io.agora.rtc2.ClientRoleOptions
- clientRoleType - Variable in class io.agora.rtc2.ChannelMediaOptions
-
The client role type: - `CLIENT_ROLE_BROADCASTER`(1): The broadcaster, who can both send and receive streams.
- 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 codec type mask.
- codecLevels - Variable in class io.agora.rtc2.video.CodecCapInfo
-
The codec capability level, estimated based on the device hardware.
- 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: - VIDEO_CODEC_VP8 = 1: VP8.
- codecType - Variable in class io.agora.rtc2.video.CodecCapInfo
-
The codec type.
- codecType - Variable in class io.agora.rtc2.video.EncodedVideoFrameInfo
-
The codec type.
- 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
-
Background color value, for example: "#aabbcc"
- ColorEnhanceOptions - Class in io.agora.rtc2.video
-
The color enhancement options.
- 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
-
Allows a user to complain about the call quality.
- compressionPreference - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration.AdvanceOptions
-
Video COMPRESSION PREFERENCE.
- configRhythmPlayer(AgoraRhythmPlayerConfig) - Method in class io.agora.rtc2.RtcEngine
-
Configures the rhythm player.
- configs - Variable in class io.agora.rtc2.SimulcastConfig
-
The array of StreamLayerConfig, which contains STREAM_LAYER_COUNT_MAX layers of video stream at most.
- 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 connection establish and connect start, 0 if not valid.
- 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
-
The audio equalization band frequency.
- 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
-
The audio mixing dual-mono output mode.
- Constants.AudioProfile - Enum Class in io.agora.rtc2
-
Sets the audio profile sampling rate, bitrate, encode mode, and the number of channels.
- Constants.AudioScenario - Enum Class in io.agora.rtc2
-
Sets the audio application scenarios.
- Constants.AudioSourceType - Enum Class in io.agora.rtc2
-
Audio source types definition.
- Constants.AudioTrackType - Enum Class in io.agora.rtc2
-
The type of custom audio track
- Constants.BytesPerSample - Enum Class in io.agora.rtc2
-
Bytes per sample
- Constants.ExternalVideoSourceType - Enum Class in io.agora.rtc2
-
External video source types definition.
- Constants.LogLevel - Enum Class in io.agora.rtc2
-
Log Level.
- Constants.MEDIA_TRACE_EVENT - Enum Class in io.agora.rtc2
-
The tracing event of media rendering.
- 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
-
Media type.
- Constants.MediaSourceType - Enum Class in io.agora.rtc2
-
The type of media device.
- 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
-
Error codes for renewing a token.
- Constants.ScreenScenarioType - Enum Class in io.agora.rtc2
-
The screen sharing scenario.
- Constants.SimulcastStreamMode - Enum Class in io.agora.rtc2
-
The dual stream mode
- 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
-
Sets the video application scenarios.
- Constants.VideoSourceType - Enum Class in io.agora.rtc2
-
Video source types definition.
- Constants.VideoStreamType - Enum Class in io.agora.rtc2
-
The dual stream mode
- 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
- CONTENT_INSPECT_TYPE_INVALID - Static variable in class io.agora.rtc2.video.ContentInspectConfig
- 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
- 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 of the screen sharing: -
SCREEN_CAPTURE_CONTENT_HINT_NONE(0)- (Default)SCREEN_CAPTURE_CONTENT_HINT_MOTION(1)-SCREEN_CAPTURE_CONTENT_HINT_DETAILS(2) - ContentInspectConfig - Class in io.agora.rtc2.video
-
The ContentInspectConfig class.
- ContentInspectConfig() - Constructor for class io.agora.rtc2.video.ContentInspectConfig
- ContentInspectConfig.ContentInspectModule - Class in io.agora.rtc2.video
-
Inner class definition of ContentInspectModule
- ContentInspectModule() - Constructor for class io.agora.rtc2.video.ContentInspectConfig.ContentInspectModule
- cpuAppUsage - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
-
The 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
-
Creates an
RtcEngineinstance. - create(RtcEngineConfig) - Static method in class io.agora.rtc2.RtcEngine
-
Creates an RtcEngine instance.
- createCustomAudioTrack(Constants.AudioTrackType, AudioTrackConfig) - Method in class io.agora.rtc2.RtcEngine
-
Create a custom audio track and get the audio track id.
- 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
-
Get an custom video track id created by internal,which could used to publish or preview
- createDataStream(boolean, boolean) - Method in class io.agora.rtc2.RtcEngine
-
Creates a data stream.
- createDataStream(DataStreamConfig) - Method in class io.agora.rtc2.RtcEngine
-
Creates a data stream.
- createDataStreamEx(boolean, boolean, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Creates a data stream.
- createDataStreamEx(DataStreamConfig, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Creates a data stream.
- createMediaPlayer() - Method in class io.agora.rtc2.RtcEngine
-
Create a media player You can use this function to create a ffmpeg or simple media player
- createMediaRecorder(RecorderStreamInfo) - Method in class io.agora.rtc2.RtcEngine
-
Create a media recorder You can use this function to create a media recorder
- 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
-
The number of pixels to crop from the bottom.
- cropLeft - Variable in class io.agora.rtc2.video.AgoraVideoFrame
-
The number of pixels to crop from the left.
- cropRight - Variable in class io.agora.rtc2.video.AgoraVideoFrame
-
The number of pixels to crop from the right.
- cropTop - Variable in class io.agora.rtc2.video.AgoraVideoFrame
-
The number of pixels to crop from the top.
- CUSTOM_VIDEO_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
-
6: Video captured by custom video source.
- customVideoTrackId - Variable in class io.agora.rtc2.ChannelMediaOptions
-
The custom video track id which will used to publish or preview.
- customVideoTrackId - Variable in class io.agora.rtc2.DirectCdnStreamingMediaOptions
-
Deprecated.The custom video track id which will used to publish.
D
- data - Variable in class io.agora.rtc2.video.AgoraMetadata
-
The buffer address of the sent or received `metadata`.
- DataStreamConfig - Class in io.agora.rtc2
- DataStreamConfig() - Constructor for class io.agora.rtc2.DataStreamConfig
- decoderOutputFrameRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
-
The decoder output frame rate (fps) of 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 to subscribe to: - `VIDEO_STREAM_HIGH`(0): (Default) The high-stream video, that is, the video stream featuring in high resolution and high bitrate.
- degradationPrefer - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
-
The video encoding degradation preference under limited bandwidth:
DEGRADATION_PREFERENCE. - delay - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
-
**DEPRECATED** Time delay (ms).
- denoiserLevel - Variable in class io.agora.rtc2.video.VideoDenoiserOptions
-
The video noise reduction level: -
VIDEO_DENOISER_LEVEL_FAST(0): (Default) Promotes video quality during video noise reduction. - denoiserMode - Variable in class io.agora.rtc2.video.VideoDenoiserOptions
-
The video noise reduction mode: -
VIDEO_DENOISER_AUTO(0): (Default) Automatic 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
-
Destroy custom audio track by trackId
- 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
-
destroy a created custom video track id
- destroyMediaRecorder(AgoraMediaRecorder) - Method in class io.agora.rtc2.RtcEngine
-
Destroy a media player source instance.
- destroyVideoEffectObject(IVideoEffectObject) - Method in class io.agora.rtc2.RtcEngine
- deviceId - Variable in class io.agora.mediaplayer.data.PlayerUpdatedInfo
-
The device ID of the playback device.
- DeviceInfo - Class in io.agora.rtc2
- DeviceInfo(boolean) - Constructor for class io.agora.rtc2.DeviceInfo
- dimensions - Variable in class io.agora.rtc2.SimulcastConfig.StreamLayerConfig
-
The video frame dimension.
- dimensions - Variable in class io.agora.rtc2.SimulcastStreamConfig
- dimensions - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
-
The video frame dimensions (px), which is used to specify the video quality and measured by the total number of pixels along a frame's width and height.
- 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
- disableAudio() - Method in class io.agora.rtc2.RtcEngine
-
Disables the audio.
- disableAudioSpectrumMonitor() - Method in class io.agora.rtc2.RtcEngine
-
Disalbe the audio spectrum monitor.
- 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
-
Disables the video.
- 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 (cm) between the human face and the screen.
- domainList - Variable in class io.agora.rtc2.proxy.LocalAccessPointConfiguration
-
Local access point domain list.
- DOWN - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.Quality
-
Deprecated.
- downlinkMultipathMode - Variable in class io.agora.rtc2.ChannelMediaOptions
-
The mode for downlink multipath transmission.
- DownlinkNetworkInfo() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.DownlinkNetworkInfo
- downlinkReport - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LastmileProbeResult
-
The downlink last-mile network report.
- dualStreamEnabled - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
-
Whether we send dual stream now.
- durationMs - Variable in class io.agora.rtc2.RecorderInfo
-
The recording duration, in milliseconds.
E
- e2eDelay - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
-
The end-to-end delay (ms) from the sender to the receiver.
- e2eDelay - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
-
End-to-end delay from video capturer to video renderer.
- 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 signal delay estimated from audio in-ear monitoring (ms).
- 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
-
Elapsed time from the start tracing time to the time when the tracing event occurred.
- enable - Variable in class io.agora.rtc2.SimulcastConfig.StreamLayerConfig
-
Whether to enable the corresponding layer of video stream.
- enable_air_absorb - Variable in class io.agora.rtc2.SpatialAudioParams
-
Enable air absorb or not for the speaker.
- enable_blur - Variable in class io.agora.rtc2.SpatialAudioParams
-
Enable blur or not for the speaker.
- enable_doppler - Variable in class io.agora.rtc2.SpatialAudioParams
-
Enable doppler factor.
- ENABLE_SIMULCAST_STREAM - Enum constant in enum class io.agora.rtc2.Constants.SimulcastStreamMode
- enableAgoraSource(boolean) - Method in class io.agora.mediaplayer.data.MediaPlayerSource
- enableAlphaMask - Variable in class io.agora.rtc2.video.VideoCanvas
-
default false.
- enableAudio - Variable in class io.agora.rtc2.EchoTestConfiguration
-
Whether to enable audio.
- enableAudio() - Method in class io.agora.rtc2.RtcEngine
-
Enables the audio.
- enableAudioProcessing - Variable in class io.agora.rtc2.audio.AudioTrackConfig
-
Enable APM processing false: AUDIO_TRACK_DIRECT is default false true: AUDIO_TRACK_DIRECT would process by APM(AEC/ANS/AGC)
- enableAudioRecordingOrPlayout - Variable in class io.agora.rtc2.ChannelMediaOptions
-
Determines whether to enable audio recording or playout.
- enableAudioSpectrumMonitor(int) - Method in class io.agora.rtc2.RtcEngine
-
Enable the audio spectrum monitor.
- enableAudioVolumeIndication(int, int, boolean) - Method in class io.agora.rtc2.RtcEngine
-
Enables the `onAudioVolumeIndication` callback to report on which users are speaking and the speakers' volume.
- enableAudioVolumeIndicationEx(int, int, boolean, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Enables the `onAudioVolumeIndication` callback to report on which users are speaking and the speakers' volume.
- enableAutoRemoveCache(boolean) - Method in interface io.agora.mediaplayer.IMediaPlayerCacheManager
-
Set whether the player will clean up the cache in the order of resource usage.
- 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
-
Enables video screenshot and upload with the connection ID.
- enableCustomAudioLocalPlayback(int, boolean) - Method in class io.agora.rtc2.RtcEngine
-
Sets the external audio track.
- enableDualStreamMode(boolean) - Method in class io.agora.rtc2.RtcEngine
-
Deprecated.v4.2.0. This method is deprecated. Use setDualStreamMode instead. If dual-stream mode is enabled, the subscriber can choose to receive the high-stream (high-resolution high-bitrate video stream) or low-stream (low-resolution low-bitrate video stream) video using
setRemoteVideoStreamType. - enableDualStreamMode(boolean, SimulcastStreamConfig) - Method in class io.agora.rtc2.RtcEngine
-
Deprecated.v4.2.0. This method is deprecated. Use setDualStreamMode instead. If dual-stream mode is enabled, the subscriber can choose to receive the high-stream (high-resolution high-bitrate video stream) or low-stream (low-resolution low-bitrate video stream) video using
setRemoteVideoStreamType. - enableDualStreamModeEx(boolean, SimulcastStreamConfig, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Deprecated.v4.2.0. This method is deprecated. Use setDualStreamModeEx instead. If dual-stream mode is enabled, the subscriber can choose to receive the high-stream (high-resolution high-bitrate video stream) or low-stream (low-resolution low-bitrate video stream) video using
setRemoteVideoStreamType. - enableEncryption(boolean, EncryptionConfig) - Method in class io.agora.rtc2.RtcEngine
-
Enables/Disables the built-in encryption.
- enableEncryptionEx(boolean, EncryptionConfig, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Enables/Disables the built-in encryption.
- 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
-
Enable/Disable an extension.
- 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
-
Enables the camera face detect.
- enableHighPerfWifiMode(boolean) - Method in class io.agora.rtc2.RtcEngine
-
Deprecated.This method is deprecated.
- enableInEarMonitoring(boolean) - Method in class io.agora.rtc2.RtcEngine
-
Enables in-ear monitoring.
- enableInEarMonitoring(boolean, int) - Method in class io.agora.rtc2.RtcEngine
-
Enables in-ear monitoring.
- 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
-
Enables or disables the local audio capture.
- enableLocalPlayback - Variable in class io.agora.rtc2.audio.AudioTrackConfig
-
Enable local playback, enabled by default true: (Default) Enable local playback false: Do not enable local playback
- enableLocalVideo(boolean) - Method in class io.agora.rtc2.RtcEngine
-
Disables or re-enables the local video capture.
- enableMultipath - Variable in class io.agora.rtc2.ChannelMediaOptions
-
Whether to enable multipath transmission.
- enableSoundPositionIndication(boolean) - Method in class io.agora.rtc2.RtcEngine
-
Enables/Disables stereo panning for remote users.
- 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 video.
- enableVideo() - Method in class io.agora.rtc2.RtcEngine
-
Enables the video.
- enableVideoImageSource(boolean, ImageTrackOptions) - Method in class io.agora.rtc2.RtcEngine
-
Enable or disable video image source to replace the current video source published or resume it
- enableVirtualBackground(boolean, VirtualBackgroundSource, SegmentationProperty) - Method in class io.agora.rtc2.RtcEngine
-
Enables/Disables portrait segmentation and repalce the background(not portrait area) with specified source.
- enableVirtualBackground(boolean, VirtualBackgroundSource, SegmentationProperty, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
-
Enables/Disables portrait segmentation and repalce the background(not portrait area) with specified source.
- enableVoiceAITuner(boolean, Constants.VOICE_AI_TUNER_TYPE) - Method in class io.agora.rtc2.RtcEngine
-
Enables or disables the voice AI tuner.
- enableWebSdkInteroperability(boolean) - Method in class io.agora.rtc2.RtcEngine
-
Enables interoperability with the Agora Web SDK (Live Broadcast only).
- encodeAlpha - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration.AdvanceOptions
-
Whether to encode and send the alpha data to the remote when alpha data is present.
- ENCODED_VIDEO_FRAME - Enum constant in enum class io.agora.rtc2.Constants.ExternalVideoSourceType
-
1: encoded video frame.
- encodedBitrate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
-
The encoding bitrate (Kbps), which does not include the bitrate of the re-transmission video after packet loss.
- encodedFrameCount - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
-
The value of the sent 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 encoding frame (px).
- encodedFrameWidth - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
-
The width of the encoding frame (px).
- EncodedVideoFrameInfo - Class in io.agora.rtc2.video
-
The EncodedVideoFrameInfo class, which defines the format of the encoded video frame.
- EncodedVideoFrameInfo() - Constructor for class io.agora.rtc2.video.EncodedVideoFrameInfo
- EncodedVideoFrameInfo(int, int, int, int, int, int, int, long, long, int, 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 encoder output frame rate (fps) of the local video.
- encodingPreference - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration.AdvanceOptions
-
The Video encoder type 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
addPublishStreamUrlmethod (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
addPublishStreamUrlmethod (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_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
-
The definition of extension context types
- 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
- extraInfo - Variable in class io.agora.rtc2.PublisherParameters
-
Deprecated.
- extraInfo - Variable in class io.agora.rtc2.video.ContentInspectConfig
-
The extra information, max lenght of extraInfo is 1024.
- 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.error.
- FAILED - Enum constant in enum class io.agora.rtc2.DirectCdnStreamingState
-
Deprecated.error.
- 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 path of the recording file.
- filePath - Variable in class io.agora.rtc2.RtcEngineConfig.LogConfig
-
The log file set by user, null for default log path.
- 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
-
The size in bytes of the recording file.
- fileSizeInKB - Variable in class io.agora.rtc2.RtcEngineConfig.LogConfig
-
The log file size set by user, 1024KB will be set for default log size if this value is less than or equal to 0.
- FILTER - Enum constant in enum class io.agora.rtc2.IVideoEffectObject.VIDEO_EFFECT_NODE_ID
-
Filter effect node.
- FilterEffectOptions - Class in io.agora.rtc2.video
-
Sets the filter effect options.
- 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 of the camera.
- followEncodeDimensionRatio - Variable in class io.agora.rtc2.video.CameraCapturerConfiguration
-
follow the dimension ratio of setVideoEncoderConfiguration.
- 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
-
Format of the incoming video frame, which must be specified as one of the following: 10: (Default)
GL_TEXTURE_2D11:OES, typically from the camera 1:I4203:NV214:RGBA - format - Variable in class io.agora.rtc2.video.WatermarkBuffer
-
The format of the watermark buffer.
- 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
- forward - Variable in class io.agora.spatialaudio.SpatialAudioZone
- forwardLength - Variable in class io.agora.spatialaudio.SpatialAudioZone
- fps - Variable in class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
-
The video fps
- fps - Variable in class io.agora.rtc2.DirectCdnStreamingStats
-
Deprecated.The frame rate of the video pushed by rtmp.
- fps - Variable in class io.agora.rtc2.video.CameraCapturerConfiguration.CaptureFormat
-
The fps of the video image captured by the local camera.
- 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 video frame loss rate (%) of the remote video stream in the reported interval.
- 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
-
The capture frame rate (fps) of the local video.
- framerate - Variable in class io.agora.rtc2.SimulcastStreamConfig
-
The video framerate.
- frameRate - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
-
The video frame rate (fps).
- 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 frames per second of this frame.
- frameType - Variable in class io.agora.rtc2.video.EncodedVideoFrameInfo
-
The frame type: - 0: `VIDEO_FRAME_TYPE_BLANK_FRAME`.
- 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 when 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
-
gateway Rtt
- 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
- 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
-
Gets the the Audio device Info
- getAudioEffectManager() - Method in class io.agora.rtc2.RtcEngine
-
Gets the IAudioEffectManager object associated with the current RTC engine.
- getAudioMixingCurrentPosition() - Method in class io.agora.rtc2.RtcEngine
-
Gets the playback position (ms) of the music file.
- getAudioMixingDuration() - Method in class io.agora.rtc2.RtcEngine
-
Gets the duration (ms) of the music file.
- getAudioMixingPlayoutVolume() - Method in class io.agora.rtc2.RtcEngine
-
Retrieves the audio mixing volume for local playback.
- getAudioMixingPublishVolume() - Method in class io.agora.rtc2.RtcEngine
-
Retrieves the audio mixing volume for publishing.
- 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
-
Get the audio track count of mixing music file.
- 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
-
Get the cache directory.
- getCacheFileCount() - Method in interface io.agora.mediaplayer.IMediaPlayerCacheManager
-
Get the number of all cache files.
- getCacheSize() - Method in class io.agora.mediaplayer.data.CacheStatistics
- getCallId() - Method in class io.agora.rtc2.RtcEngine
-
Gets the current call ID.
- getCallIdEx(RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Gets the current call ID.
- 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
-
Gets the maximum zoom ratio supported by the camera.
- 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
-
Gets the connection state of the SDK.
- getConnectionStateEx(RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Gets the connection state of the SDK.
- 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
-
Sets the audio ear monitoring format for the
onEarMonitoringAudioFramecallback. - getEffectCurrentPosition(int) - Method in class io.agora.rtc2.RtcEngine
-
Gets the playback position of the audio effect file.
- getEffectDuration(String) - Method in class io.agora.rtc2.RtcEngine
-
Gets the duration of the audio effect file.
- getEffectsVolume() - Method in interface io.agora.rtc2.IAudioEffectManager
-
Gets the volume of the audio effects.
- getEffectsVolume() - Method in class io.agora.rtc2.RtcEngine
-
Gets the volume of the audio effects.
- 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
-
Gets the warning or error description.
- 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
-
Gets the properties of an extension.
- getExtensionProperty(String, String, String, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
-
Gets the properties of an extension.
- getFaceShapeAreaOptions(int) - Method in class io.agora.rtc2.RtcEngine
-
Gets the face shape area options.
- getFaceShapeAreaOptions(int, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
-
Gets the face shape area options.
- getFaceShapeBeautyOptions() - Method in class io.agora.rtc2.RtcEngine
-
Gets the face shape beauty options.
- getFaceShapeBeautyOptions(Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
-
Gets the face shape beauty options.
- 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
-
Get the maximum number of cached files.
- getMaxCacheFileSize() - Method in interface io.agora.mediaplayer.IMediaPlayerCacheManager
-
Get the total size of the largest cache file
- getMaxMetadataSize() - Method in interface io.agora.rtc2.IMetadataObserver
-
Occurs when the SDK requests the maximum size of the metadata.
- 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
-
get an MediaPlayerCacheManager instance, which is used to set and manage the player cache, implemented in the form of a singleton, independent of the player.
- getMediaPlayerId() - Method in interface io.agora.mediaplayer.IMediaPlayer
-
Get unique source id of the media player.
- getMediaStreamType() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
- getMirrorApplied() - Method in interface io.agora.rtc2.video.IVideoFrameObserver
-
Occurs each time needs to get whether mirror is applied or not.
- getMirrorMode() - Method in class io.agora.rtc2.video.ImageTrackOptions
- getMixedAudioParams() - Method in interface io.agora.rtc2.IAudioFrameObserver
-
Sets the audio mixing format for the
onMixedFramecallback. - 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
-
Returns the native handler of the SDK Engine.
- 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
-
Get network type
- getNtpWallTimeInMs() - Method in class io.agora.rtc2.RtcEngine
-
Return current NTP(unix timestamp) time in milliseconds.
- getObservedAudioFramePosition() - Method in interface io.agora.rtc2.IAudioFrameObserver
-
Sets the audio observation positions.
- getObservedFramePosition() - Method in interface io.agora.rtc2.video.IVideoFrameObserver
-
Sets the frame position for the video observer.
- 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
-
Sets the audio playback format for the
onPlaybackFramecallback. - getPlayoutVolume() - Method in interface io.agora.mediaplayer.IMediaPlayer
- getPlayPosition() - Method in interface io.agora.mediaplayer.IMediaPlayer
-
Gets the current playback position of the media file.
- getPlaySrc() - Method in interface io.agora.mediaplayer.IMediaPlayer
-
Gets the url of the current play media file for publishing.
- 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
-
Sets the audio recording format for the
onRecordFramecallback. - 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
-
Occurs each time needs to get rotation angle.
- 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
-
Gets the SDK version.
- 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
- getUid() - Method in class io.agora.rtc2.video.EncodedVideoFrameInfo
- 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
-
Gets the user information by passing in the user ID.
- getUserInfoByUidEx(int, UserInfo, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Gets the user information by passing in the user ID.
- getUserInfoByUserAccount(String, UserInfo) - Method in class io.agora.rtc2.RtcEngine
-
Gets the user information by passing in the user account.
- getUserInfoByUserAccountEx(String, UserInfo, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Gets the user information by passing in the user account.
- 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
-
Indicate the video frame mode of the observer.
- 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
-
Get the volume of a specified sound effect.
- 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 color tolerance for green screen segmentation.
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, which is the high-efficiency audio codec type.
- HE_AAC_V2 - Enum constant in enum class io.agora.rtc2.live.LiveTranscoding.AudioCodecProfileType
-
2: HE-AACv2, which is the high-efficiency audio codec type.
- 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
-
The video height
- 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
-
Height (pixels) of the video stream.
- height - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayout
-
height of video stream on a transcoded video stream canvas.
- height - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayoutInfo
-
height of transcoded video stream.
- 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
-
Height of the video frame of the user on the CDN live streaming.
- height - Variable in class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
-
The height (px) of the video for the video mixing on the local client.
- height - Variable in class io.agora.rtc2.PublisherParameters
-
Deprecated.
- height - Variable in class io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters
-
The height of the video encoding resolution.
- height - Variable in class io.agora.rtc2.video.AgoraImage
-
Height of the image on the video.
- height - Variable in class io.agora.rtc2.video.AgoraVideoFrame
-
The height of this frame.
- height - Variable in class io.agora.rtc2.video.CameraCapturerConfiguration.CaptureFormat
-
The height (px) of the video image captured by the local camera.
- height - Variable in class io.agora.rtc2.video.EncodedVideoFrameInfo
-
The height of this 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 of the video.
- height - Variable in class io.agora.rtc2.video.WatermarkBuffer
-
The height of the watermark buffer in pixels.
- height - Variable in class io.agora.rtc2.video.WatermarkOptions.Rectangle
-
The height of the watermark image, in pixels.
- 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.
- HIGHEST - Enum constant in enum class io.agora.rtc2.Constants.ThreadPriorityType
-
4.
- hwDecodingLevel - Variable in class io.agora.rtc2.video.CodecCapLevels
- hwEncoderAccelerating - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
-
The encoder is hardware or software: - hwEncoderAccelerating = 0: the encoder is software.
I
- IAudioEffectManager - Interface in io.agora.rtc2
-
Provides the methods to manage the audio effects.
- 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
-
The unique identifier of the watermark.
- 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.idle.
- 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 URL of the image.
- imageUrl - Variable in class io.agora.rtc2.video.WatermarkConfig
-
The URL from which 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.
- 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 type
- internalPlayerUuid - Variable in class io.agora.mediaplayer.data.PlayerUpdatedInfo
- interval - Variable in class io.agora.rtc2.video.ContentInspectConfig.ContentInspectModule
-
The content inspect module's upload image frequency The frequency unit is second.
- intervalInSeconds - Variable in class io.agora.rtc2.EchoTestConfiguration
-
The time interval (s) between when you speak and when the recording plays back.
- 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
-
Local access point IP address list.
- IRtcEngineEventHandler - Class in io.agora.rtc2
-
Callback methods.
- IRtcEngineEventHandler() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler
- IRtcEngineEventHandler.AgoraFacePositionInfo - Class in io.agora.rtc2
-
The information of the detected human face.
- IRtcEngineEventHandler.AudioVolumeInfo - Class in io.agora.rtc2
-
Audio volume information.
- IRtcEngineEventHandler.ClientRole - Class in io.agora.rtc2
-
Deprecated.Use the new
Constantsclass 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
-
Statistics of the last-mile probe.
- IRtcEngineEventHandler.LastmileProbeResult.LastmileProbeOneWayResult - Class in io.agora.rtc2
-
The one-way last-mile probe result.
- IRtcEngineEventHandler.LocalAudioStats - Class in io.agora.rtc2
-
The statistics of the local audio.
- IRtcEngineEventHandler.LocalVideoStats - Class in io.agora.rtc2
-
Statistics of the local video.
- 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
Constantsclass with the same constants value - IRtcEngineEventHandler.RemoteAudioStats - Class in io.agora.rtc2
-
Statistics of the remote audio.
- IRtcEngineEventHandler.RemoteVideoStats - Class in io.agora.rtc2
-
Statistics of the remote video.
- IRtcEngineEventHandler.RtcStats - Class in io.agora.rtc2
-
Statistics of RtcEngine.
- IRtcEngineEventHandler.UplinkNetworkInfo - Class in io.agora.rtc2
-
The statistics of the uplink network info.
- IRtcEngineEventHandler.UserOfflineReason - Class in io.agora.rtc2
-
Deprecated.Use the new
Constantsclass 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
Constantsclass with the same constants value - IRtcEngineEventHandler.VideoRenderingTracingInfo - Class in io.agora.rtc2
-
The video rendering tracing result
- 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
-
Determines whether local audio stream can be 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
-
Checks whether the camera auto focus function is supported.
- isCameraExposurePositionSupported() - Method in class io.agora.rtc2.RtcEngine
-
Checks whether the camera exposure function is supported.
- isCameraExposureSupported() - Method in class io.agora.rtc2.RtcEngine
-
Checks whether camera supports to set exposure value.
- isCameraFaceDetectSupported() - Method in class io.agora.rtc2.RtcEngine
-
Checks whether the camera face detect function is supported.
- isCameraFocusSupported() - Method in class io.agora.rtc2.RtcEngine
-
Checks whether the camera manual focus function is supported.
- isCameraTorchSupported() - Method in class io.agora.rtc2.RtcEngine
-
Checks whether the camera flash function is supported.
- isCameraZoomSupported() - Method in class io.agora.rtc2.RtcEngine
-
Checks whether the camera zoom function is supported.
- 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
-
This mode is only used for audience.
- 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 device support low latency audio.
- 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
-
Checks whether the speakerphone is enabled.
- 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
-
Checks whether texture encoding is supported.
- isValid - Variable in class io.agora.rtc2.ExtensionContext
-
Whether 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 jitter buffer delay at the receiver.
- join2JoinSuccess - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoRenderingTracingInfo
-
Elapsed time from joining channel to finishing joining channel.
- joinChannel(String, String, int, ChannelMediaOptions) - Method in class io.agora.rtc2.RtcEngine
-
Joins a channel with media options.
- joinChannel(String, String, String, int) - Method in class io.agora.rtc2.RtcEngine
-
Joins a channel.
- joinChannelEx(String, RtcConnection, ChannelMediaOptions, IRtcEngineEventHandler) - Method in class io.agora.rtc2.RtcEngineEx
-
Joins a channel with the connection ID.
- joinChannelWithUserAccount(String, String, String) - Method in class io.agora.rtc2.RtcEngine
-
Joins the channel with a user account.
- joinChannelWithUserAccount(String, String, String, ChannelMediaOptions) - Method in class io.agora.rtc2.RtcEngine
-
Joins the channel with a user account, and configures whether to automatically subscribe to audio or video streams after joining the channel.
- joinChannelWithUserAccountEx(String, String, String, ChannelMediaOptions, IRtcEngineEventHandler) - Method in class io.agora.rtc2.RtcEngineEx
-
Joins the channel with a user account.
- joinSuccess2RemoteJoined - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoRenderingTracingInfo
-
Elapsed time from finishing joining channel to remote user joined.
L
- lanAccelerateState - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
-
The local network acceleration state.
- lanRxBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.MultipathStats
-
Total bytes received over LAN.
- lanTxBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.MultipathStats
-
Total bytes transmitted 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 VOS client-server latency (ms).
- 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
-
count of video layout info in transcoded video stream.
- layoutList - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayoutInfo
-
video layout info in transcoded video stream.
- LC_AAC - Enum constant in enum class io.agora.rtc2.live.LiveTranscoding.AudioCodecProfileType
-
0: LC-AAC, which is the low-complexity audio codec type.
- leaveChannel() - Method in class io.agora.rtc2.RtcEngine
-
Leaves the channel.
- leaveChannel(LeaveChannelOptions) - Method in class io.agora.rtc2.RtcEngine
-
Leaves the channel.
- leaveChannelEx(RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Leaves the channel with the specified connection ID.
- leaveChannelEx(RtcConnection, LeaveChannelOptions) - Method in class io.agora.rtc2.RtcEngineEx
-
Leaves the channel with the specified connection ID.
- LeaveChannelOptions - Class in io.agora.rtc2
-
The leave channel options.
- 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 log level set by user, INFO is default level.
- 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 lightening contrast level, used with
lighteningLevel:LIGHTENING_CONTRAST_LOW(0): low contrast level. - lighteningLevel - Variable in class io.agora.rtc2.video.BeautyOptions
-
The brightness level.
- 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
-
A class for managing user-specific CDN live audio/video transcoding settings.
- LiveTranscoding() - Constructor for class io.agora.rtc2.live.LiveTranscoding
- LiveTranscoding.AudioCodecProfileType - Enum Class in io.agora.rtc2.live
-
Self-defined audio codec profile.
- LiveTranscoding.AudioSampleRateType - Enum Class in io.agora.rtc2.live
-
Audio sample rate (Hz).
- LiveTranscoding.TranscodingUser - Class in io.agora.rtc2.live
-
The transcodingUser class which defines the video properties of the user displaying the video in the CDN live.
- LiveTranscoding.VideoCodecProfileType - Enum Class in io.agora.rtc2.live
-
Self-defined video codec profile.
- LiveTranscoding.VideoCodecType - Enum Class in io.agora.rtc2.live
-
The video codec type of the output video stream.
- 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_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_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
-
The configuration of the audio mixing on the local client.
- LocalAudioMixerConfiguration() - Constructor for class io.agora.rtc2.LocalAudioMixerConfiguration
- LocalAudioMixerConfiguration.MixedAudioStream - Class in io.agora.rtc2
-
The audio streams for the audio mixing on the local client.
- 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
-
The configuration of the video mixing on the local client.
- LocalTranscoderConfiguration() - Constructor for class io.agora.rtc2.LocalTranscoderConfiguration
- LocalTranscoderConfiguration.TranscodingVideoStream - Class in io.agora.rtc2
-
The video streams for the video mixing on the local client.
- 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 user ID.
- 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
-
Outputs logs of the ERROR level.
- 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
-
Outputs logs of the CRITICAL level.
- 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
-
Outputs logs of the INFO level.
- 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
-
Outputs no log.
- 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
-
Outputs logs of the WARNING level.
- 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
-
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. Latency mode:
- true: Low latency with unassured quality.
- false: (Default) High latency with assured quality.
- lowlightEnhanceLevel - Variable in class io.agora.rtc2.video.LowLightEnhanceOptions
-
The low-light enhancement level: -
LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY(0): (Default) Promotes video quality during low-light enhancement. - lowlightEnhanceMode - Variable in class io.agora.rtc2.video.LowLightEnhanceOptions
-
The low-light enhancement mode: -
LOW_LIGHT_ENHANCE_AUTO(0): (Default) Automatic mode. - LowLightEnhanceOptions - Class in io.agora.rtc2.video
-
The low-light enhancement options.
- 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.
- MAINTAIN_AUTO - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.DEGRADATION_PREFERENCE
-
-1: (Default) SDK uses option MAINTAIN_RESOLUTION By default.
- MAINTAIN_BALANCED - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.DEGRADATION_PREFERENCE
-
2: Maintain resolution in video quality control process.
- 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: (Deprecated) Degrade the frame rate and keep resolution to guarantee the video quality.
- MAINTAIN_RESOLUTION - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.DEGRADATION_PREFERENCE
-
3: Degrade framerate in order to maintain resolution.
- 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 to you by Agora.
- mAreaCode - Variable in class io.agora.rtc2.RtcEngineConfig
-
The region for connection.
- mAudioScenario - Variable in class io.agora.rtc2.RtcEngineConfig
-
The audio application scenario.
- mAutoRegisterAgoraExtensions - Variable in class io.agora.rtc2.RtcEngineConfig
-
Whether to automatically register 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
-
The 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 of the Agora
RtcEngine. - mContext - Variable in class io.agora.rtc2.RtcEngineConfig
-
The context of Android Activity.
- mDomainLimit - Variable in class io.agora.rtc2.RtcEngineConfig
-
Determines whether to enable domain limit -true: only connect to servers which already parsed by DNS -false: (Default) connect to servers with no limit
- 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 media frame has been decoded.
- MEDIA_TRACE_EVENT_VIDEO_RENDERED - Enum constant in enum class io.agora.rtc2.Constants.MEDIA_TRACE_EVENT
-
0: The media 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
-
MediaPlayer id if sourceType is MEDIA_PLAYER_SOURCE.
- mediaPlayerId - Variable in class io.agora.rtc2.video.VideoCanvas
-
The media player id of AgoraMediaPlayer.
- 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 application memory usage (Kbyte).
- memoryAppUsageRatio - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
-
The application memory usage (%).
- memoryTotalUsageRatio - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
-
The system memory usage (%).
- metadata - Variable in class io.agora.rtc2.live.LiveTranscoding
-
Deprecated.This parameter is deprecated.
- mEventHandler - Variable in class io.agora.rtc2.RtcEngineConfig
-
IRtcEngineEventHandleris an abstract class providing default implementation. - mExtensionList - Variable in class io.agora.rtc2.RtcEngineConfig
-
The extension list need to preload
- mExtensionObserver - Variable in class io.agora.rtc2.RtcEngineConfig
- 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
-
(For future use) The minimum encoding bitrate (Kbps).
- 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 video mixing on the local client.
- 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
-
The video mirror mode: - `VIDEO_MIRROR_MODE_AUTO(0)`: (Default) The mirror mode determined by the SDK.
- mirrorMode - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
-
If mirror_type is set to VIDEO_MIRROR_MODE_ENABLED, then the video frame would be mirrored before encoding.
- 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
- mMakeUpEnable - Variable in class io.agora.rtc2.video.MakeUpOptions
- mNativeLibPath - Variable in class io.agora.rtc2.RtcEngineConfig
-
native c++ dynamic library path.
- mobileRxBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.MultipathStats
-
Total bytes received over mobile.
- mobileTxBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.MultipathStats
-
Total bytes transmitted over mobile.
- mode - Variable in class io.agora.rtc2.audio.AudioParams
-
The use mode of the audio data: -
RAW_AUDIO_FRAME_OP_MODE_READ_ONLY(0): (Default) Read-only mode, in which users can only read theAudioFramewithout modifying anything. - mode - Variable in class io.agora.rtc2.proxy.LocalAccessPointConfiguration
-
Local proxy connection mode, connectivity first or local only.
- modelType - Variable in class io.agora.rtc2.video.SegmentationProperty
-
The type of segmentation algorithm.
- moduleCount - Variable in class io.agora.rtc2.video.ContentInspectConfig
-
The actual content inspect count, defalut value is 0.
- modules - Variable in class io.agora.rtc2.video.ContentInspectConfig
-
The content inspect module array, max lenght of the array is 32.
- 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 as determined by the Agora real-time audio MOS (Mean Opinion Score) measurement method 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
- 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 mode, where the SDK dynamically selects the best path for data transmission.
- MULTIPATH_TYPE_LAN - Enum constant in enum class io.agora.rtc2.Constants.MultipathType
-
0: LAN type, indicating that the data is transmitted over a local area network.
- MULTIPATH_TYPE_MOBILE - Enum constant in enum class io.agora.rtc2.Constants.MultipathType
-
2: Mobile type, indicating that the data is transmitted over a mobile network.
- MULTIPATH_TYPE_UNKNOWN - Enum constant in enum class io.agora.rtc2.Constants.MultipathType
-
99: Unknown type, indicating that the path type is not recognized.
- MULTIPATH_TYPE_WIFI - Enum constant in enum class io.agora.rtc2.Constants.MultipathType
-
1: WIFI type, indicating that the 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
-
Stops or resumes receiving all remote audio streams.
- muteAllRemoteAudioStreams(boolean) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
- muteAllRemoteAudioStreamsEx(boolean, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Stops or resumes receiving all remote audio stream with connection.
- muteAllRemoteVideoStreams(boolean) - Method in class io.agora.rtc2.RtcEngine
-
Stops or resumes receiving all remote video streams.
- muteAllRemoteVideoStreamsEx(boolean, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Stops or resumes receiving all remote video stream with connection.
- muteLocalAudioStream(boolean) - Method in class io.agora.rtc2.RtcEngine
-
Stops or resumes sending the local audio stream.
- muteLocalAudioStream(boolean) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
- muteLocalAudioStreamEx(boolean, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Stops or resumes sending the local audio stream with connection.
- muteLocalVideoStream(boolean) - Method in class io.agora.rtc2.RtcEngine
-
Stops or resumes sending the local video stream.
- muteLocalVideoStreamEx(boolean, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Stops or resumes sending the local video stream with connection.
- muteRecordingSignal(boolean) - Method in class io.agora.rtc2.RtcEngine
-
Mute or resume recording signal volume.
- 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
-
Stops or resumes receiving the audio stream of a specified user.
- muteRemoteAudioStream(int, boolean) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
- muteRemoteAudioStreamEx(int, boolean, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Stops or resumes receiving the audio stream of a specified user with specified connection.
- muteRemoteVideoStream(int, boolean) - Method in class io.agora.rtc2.RtcEngine
-
Stops or resumes receiving the video stream of a specified user.
- muteRemoteVideoStreamEx(int, boolean, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Stops or resumes receiving the video stream of a specified user with specified connection.
- 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.net connect.
- 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 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 channels.
- numChannels - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
-
The number of 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.success.
- onActiveSpeaker(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when an active speaker is detected.
- onAgoraCDNTokenWillExpire() - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
-
Deprecated.4.6.0
- onAudioEffectFinished(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
The local audio effect playback has finished.
- onAudioMetadataReceived(int, byte[]) - Method in class io.agora.rtc2.IRtcEngineEventHandler
- onAudioMixingFinished() - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Deprecated.Use
onAudioMixingStateChangedinstead.If you failed to execute the
startAudioMixingmethod, it returns the error code in theonErrorcallback. - onAudioMixingPositionChanged(long) - Method in class io.agora.rtc2.IRtcEngineEventHandler
- onAudioMixingStateChanged(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the state of the local user's audio mixing file changes.
- onAudioPublishStateChanged(String, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the audio publish state changed.
- onAudioQuality(int, int, short, short) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
The audio quality of the specified user every two seconds.
- onAudioRouteChanged(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the local audio playback route changes.
- onAudioSubscribeStateChanged(String, int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the audio subscribe state changed.
- onAudioVolumeIndication(int) - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
- onAudioVolumeIndication(IRtcEngineEventHandler.AudioVolumeInfo[], int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Reports which users are speaking and the speaker's volume.
- onCameraExposureAreaChanged(Rect) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the camera exposure area has changed.
- onCameraFocusAreaChanged(Rect) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the camera focus area has changed.
- onCameraReady() - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Deprecated.Use
onLocalVideoStateChangedinstead.If the camera fails to turn on, an error is passed in the
onErrormethod. - onCaptureVideoFrame(int, VideoFrame) - Method in interface io.agora.rtc2.video.IVideoFrameObserver
-
Occurs each time the SDK receives a video frame captured by the local camera.
- onChannelMediaRelayStateChanged(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the state of the media stream relay changes.
- onClientRoleChanged(int, int, ClientRoleOptions) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the user role in a Live-Broadcast channel has switched, for example, from a broadcaster to an audience or vice versa.
- onClientRoleChangeFailed(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the user role in a Live-Broadcast channel has switched, for example, from a broadcaster to an audience or vice versa.
- onConnectionBanned() - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Your connection is banned by the Agora Server.
- onConnectionInterrupted() - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
The SDK has lost connection to the server.
- onConnectionLost() - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the SDK cannot reconnect to the server 10 seconds after its connection to the server is interrupted.
- onConnectionStateChanged(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the network connection state changes.
- onContentInspectResult(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
- onDirectCdnStreamingStateChanged(DirectCdnStreamingState, DirectCdnStreamingReason, String) - Method in interface io.agora.rtc2.IDirectCdnStreamingEventHandler
-
Deprecated.Event callback of Direct Cdn Streaming
- onDirectCdnStreamingStats(DirectCdnStreamingStats) - Method in interface io.agora.rtc2.IDirectCdnStreamingEventHandler
-
Deprecated.Current status data of rtmp streaming.
- onEarMonitoringAudioFrame(int, int, int, int, int, ByteBuffer, long, int) - Method in interface io.agora.rtc2.IAudioFrameObserver
-
Occurs when the ear monitoring audio frame is received.
- onEnableTranscode(int) - Method in interface io.agora.rtc2.IH265TranscoderObserver
-
Use to notify the result of invoking enableTranscode interface.
- onEncodedVideoFrameReceived(ByteBuffer, EncodedVideoFrameInfo) - Method in interface io.agora.rtc2.video.IVideoEncodedFrameObserver
-
Occurs each time the SDK receives an encoded video image.
- onEncryptionError(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Reports the error type of encryption.
- onEngineReleased() - Method in interface io.agora.rtc2.IRtcEngineReleaseCallback
- onError(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
An error occurred during SDK runtime.
- 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
-
Occurs when the face info is received.
- onFacePositionChanged(int, int, IRtcEngineEventHandler.AgoraFacePositionInfo[]) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the camera exposure area has changed.
- onFirstLocalAudioFramePublished(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the first audio frame is published.
- onFirstLocalVideoFrame(Constants.VideoSourceType, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
The first local video frame is displayed on the screen.
- onFirstLocalVideoFramePublished(Constants.VideoSourceType, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the first video frame is published.
- onFirstRemoteAudioDecoded(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the SDK decodes the first remote audio frame for playback.
- onFirstRemoteAudioFrame(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the first remote audio frame is received.
- 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
onRemoteVideoStateChangedcallback instead. This callback is triggered in either of the following scenarios:- The remote user joins the channel and sends the video stream.
- The remote user stops sending the video stream and re-sends it after 15 seconds.
Possible reasons include:
- The remote user leaves channel.
- The remote user drops offline.
- The remote user calls the
muteLocalVideoStreammethod. - The remote user calls the
disableVideomethod.
- onFirstRemoteVideoFrame(int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
The first frame of the remote video appears in the user's video window.
- onFrame(AudioFrame) - Method in interface io.agora.mediaplayer.IMediaPlayerAudioFrameObserver
-
Occurs when one audio frame was captured.
- onFrame(VideoFrame) - Method in interface io.agora.mediaplayer.IMediaPlayerVideoFrameObserver
-
Occurs when one video frame was captured.
- 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
-
Occurs when the local user successfully joins the specified channel.
- onLastmileProbeResult(IRtcEngineEventHandler.LastmileProbeResult) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Reports the last-mile network probe result.
- onLastmileQuality(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Reports the last-mile network quality of the local user.
- onLeaveChannel(IRtcEngineEventHandler.RtcStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the local user successfully leaves the channel.
- 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
-
Reports the audio spectrum of audio recording.
- onLocalAudioStateChanged(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the local audio stream state changes.
- onLocalAudioStats(IRtcEngineEventHandler.LocalAudioStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Reports the statistics of the local audio stream.
- onLocalUserRegistered(int, String) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the local user registers a user account.
- 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
-
Occurs when the local video stream state changes.
- onLocalVideoStats(Constants.VideoSourceType, IRtcEngineEventHandler.LocalVideoStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Reports the statistics of the local video streams.
- onLocalVideoTranscoderError(LocalTranscoderConfiguration.TranscodingVideoStream, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when local video transcoder stream has an error.
- 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
-
Occurs when the local user receives the metadata.
- onMixedAudioEncodedFrame(ByteBuffer, int, int, int, int) - Method in interface io.agora.rtc2.IAudioEncodedFrameObserver
-
Occurs when the mixed playback audio frame is received.
- onMixedAudioFrame(String, int, int, int, int, int, ByteBuffer, long, int) - Method in interface io.agora.rtc2.IAudioFrameObserver
-
Occurs when the mixed playback audio frame is received.
- onMultipathStats(IRtcEngineEventHandler.MultipathStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
- onNetworkQuality(int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Reports the network quality of each user.
- onNetworkTypeChanged(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the network type is changed.
- onPermissionError(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Reports the permission error.
- onPlaybackAudioEncodedFrame(ByteBuffer, int, int, int, int) - Method in interface io.agora.rtc2.IAudioEncodedFrameObserver
-
Occurs when the playback audio frame is received.
- onPlaybackAudioFrame(String, int, int, int, int, int, ByteBuffer, long, int) - Method in interface io.agora.rtc2.IAudioFrameObserver
-
Occurs when the playback audio frame is received.
- onPlaybackAudioFrameBeforeMixing(String, int, int, int, int, int, int, ByteBuffer, long, int, int, long) - Method in interface io.agora.rtc2.IAudioFrameObserver
-
Occurs when the playback audio frame before mixing is received.
- 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
-
Occurs each time the SDK receives a video frame before encoding.
- onPreloadEvent(String, Constants.MediaPlayerPreloadEvent) - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
- onProxyConnected(String, int, int, String, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the local user joins a specified channel after calling
setLocalAccessPointorsetCloudProxy. - 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
-
Occurs when the SDK is ready to receive and send metadata.
- onRecordAudioEncodedFrame(ByteBuffer, int, int, int, int) - Method in interface io.agora.rtc2.IAudioEncodedFrameObserver
-
Occurs when the recorded audio frame is received.
- onRecordAudioFrame(String, int, int, int, int, int, ByteBuffer, long, int) - Method in interface io.agora.rtc2.IAudioFrameObserver
-
Occurs when the recorded audio frame is received.
- onRecorderInfoUpdated(String, int, RecorderInfo) - Method in interface io.agora.rtc2.IMediaRecorderCallback
-
Occurs when the recording information is updated.
- onRecorderStateChanged(String, int, int, int) - Method in interface io.agora.rtc2.IMediaRecorderCallback
-
Occurs when the recording state changes.
- onRejoinChannelSuccess(String, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the local user rejoins the channel after being disconnected due to network problems.
- onRemoteAudioSpectrum(UserAudioSpectrumInfo[], int) - Method in interface io.agora.rtc2.audio.IAudioSpectrumObserver
-
Reports the audio spectrum of remote user.
- onRemoteAudioStateChanged(int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the remote audio state changes.
- onRemoteAudioStats(IRtcEngineEventHandler.RemoteAudioStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Reports the statistics of the audio from each remote user or broadcaster.
- onRemoteAudioTransportStats(int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Deprecated.Use
onRemoteAudioStatsinstead. - 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
-
Occurs when the remote video state has changed.
- onRemoteVideoStats(IRtcEngineEventHandler.RemoteVideoStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Reports the statistics of the video stream from each remote user/host.
- onRemoteVideoTransportStats(int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Deprecated.Use
onRemoteVideoStatsinstead. - onRenderVideoFrame(String, int, VideoFrame) - Method in interface io.agora.rtc2.video.IVideoFrameObserver
-
Occurs each time the SDK receives a video frame sent by the remote user.
- onRenewTokenResult(String, Constants.RenewTokenErrorCode) - Method in class io.agora.rtc2.IRtcEngineEventHandler
- onRequestToken() - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the token has expired.
- onRhythmPlayerStateChanged(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the state of the local user's rhythm player changes.
- onRtcStats(IRtcEngineEventHandler.RtcStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Reports the statistics of the current call.
- onRtmpStreamingEvent(String, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Reports events during the RTMP or RTMPS streaming.
- onRtmpStreamingStateChanged(String, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the state of the RTMP streaming changes.
- onSeek(long, int) - Method in interface io.agora.mediaplayer.IMediaPlayerCustomDataProvider
- onSnapshotTaken(int, String, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when takeSnapshot API result is obtained
- 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
-
Receives the data stream.
- onStreamMessageError(int, int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Fails to receive the data stream.
- onTokenPrivilegeWillExpire(String) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the token will expire in 30 seconds.
- onTranscodedStreamLayoutInfo(int, IRtcEngineEventHandler.VideoLayoutInfo) - Method in class io.agora.rtc2.IRtcEngineEventHandler
- onTranscodingUpdated() - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Transcoding was successfully updated.
- 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
-
Occurs when uplink network info is updated.
- 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
onRemoteVideoStateChangedcallback 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)`. The SDK triggers this callback when the remote user resumes or stops capturing the video stream by calling theenableLocalVideomethod. This callback is only applicable to the scenario when the remote user only wants to watch the remote video without sending any video stream to the other user. - onUserEnableVideo(int, boolean) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when a remote user enables/disables the video module.
- onUserInfoUpdated(int, UserInfo) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the SDK gets the user ID and user account of the remote user.
- onUserJoined(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when a remote user or broadcaster joins the channel.
- onUserMuteAudio(int, boolean) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when a remote user stops/resumes sending the audio stream.
- onUserMuteVideo(int, boolean) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when a remote user stops/resumes sending the video stream.
- onUserOffline(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when a remote user or broadcaster goes offline.
- 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
-
Occurs when the audio publish state changed.
- onVideoRenderingTracingResult(int, Constants.MEDIA_TRACE_EVENT, IRtcEngineEventHandler.VideoRenderingTracingInfo) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Reports the tracing result of video rendering event of the user.
- onVideoSizeChanged(Constants.VideoSourceType, int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the local or remote video size or rotation has changed.
- onVideoStopped() - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Deprecated.Use
onLocalVideoStateChangedinstead.The application can use this callback to change the configuration of the view (for example, display other pictures in the view) after the video stops.
- onVideoSubscribeStateChanged(String, int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
-
Occurs when the video subscribe state changed.
- 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
-
Opens a media file with a specified URL.
- openWithAgoraCDNSrc(String, long) - Method in interface io.agora.mediaplayer.IMediaPlayer
-
Deprecated.4.6.0
- openWithMediaSource(MediaPlayerSource) - Method in interface io.agora.mediaplayer.IMediaPlayer
-
Opens a media file with a media file source.
- options - Variable in class io.agora.rtc2.video.WatermarkConfig
-
The options that define the position and size of the watermark.
- ordered - Variable in class io.agora.rtc2.DataStreamConfig
- ORIENTATION_MODE_ADAPTIVE - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.ORIENTATION_MODE
-
0: (Default) The adaptive mode.
- ORIENTATION_MODE_FIXED_LANDSCAPE - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.ORIENTATION_MODE
-
1.
- ORIENTATION_MODE_FIXED_PORTRAIT - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.ORIENTATION_MODE
-
2.
- orientationMode - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
-
The orientation mode.
- 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
-
Packet loss rate (%) of the remote video stream after using the anti-packet-loss method.
- 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
-
3d lut path
- pathStats - Variable in class io.agora.rtc2.IRtcEngineEventHandler.MultipathStats
-
Array of path statistics.
- PathStats() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.PathStats
- pathType - Variable in class io.agora.rtc2.IRtcEngineEventHandler.PathStats
-
Type of the path (e.g., LAN, WiFi, Mobile).
- pause() - Method in interface io.agora.mediaplayer.IMediaPlayer
-
Pauses playing the media file.
- pauseAllChannelMediaRelay() - Method in class io.agora.rtc2.RtcEngine
-
pause the channels for media stream relay.
- 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
-
Pauses playing all audio effects.
- pauseAudio() - Method in class io.agora.rtc2.RtcEngine
-
Disables the audio function in the channel.
- pauseAudioMixing() - Method in class io.agora.rtc2.RtcEngine
-
Pauses playing and mixing the music file.
- pauseEffect(int) - Method in interface io.agora.rtc2.IAudioEffectManager
-
Pauses playing the specified audio effect.
- pauseEffect(int) - Method in class io.agora.rtc2.RtcEngine
-
Pauses playing the specified audio effect.
- 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
-
Plays the media file.
- PLAY_REASON_SRC_BUFFER_UNDERFLOW - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-
Insufficient buffer data
- playAllEffects(int, double, double, double, boolean) - Method in class io.agora.rtc2.RtcEngine
-
Plays all audio effects.
- 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
-
Plays a specified audio effect.
- 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
-
Plays a specified audio effect.
- 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
-
Plays a specified audio effect to a specified channel.
- 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
-
Plays a specified audio effect to a specified channel.
- PLAYER_EVENT_AUDIO_TRACK_CHANGED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
-
audio track changed
- PLAYER_EVENT_BUFFER_LOW - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
-
player buffer low
- PLAYER_EVENT_BUFFER_RECOVER - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
-
player buffer recover
- PLAYER_EVENT_FIRST_DISPLAYED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
-
first video displayed
- PLAYER_EVENT_FREEZE_START - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
-
The video or audio is interrupted
- PLAYER_EVENT_FREEZE_STOP - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
-
Interrupt at the end of the video or audio
- 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
-
reach cache max file count
- PLAYER_EVENT_REACH_CACHE_FILE_MAX_SIZE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
-
reach cache max file size
- PLAYER_EVENT_SEEK_BEGIN - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
-
seek complete
- PLAYER_EVENT_SEEK_COMPLETE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
-
seek complete
- PLAYER_EVENT_SEEK_ERROR - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
-
seek failed
- PLAYER_EVENT_SWITCH_BEGIN - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
-
switch source begin
- PLAYER_EVENT_SWITCH_COMPLETE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
-
switch source complete
- PLAYER_EVENT_SWITCH_ERROR - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerEvent
-
switch source 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
-
Event unknown
- PLAYER_METADATA_TYPE_SEI - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerMetadataType
-
sei data
- PLAYER_METADATA_TYPE_UNKNOWN - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerMetadataType
-
data type unknown
- PLAYER_PRELOAD_EVENT_BEGIN - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerPreloadEvent
- PLAYER_PRELOAD_EVENT_COMPLETE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerPreloadEvent
- PLAYER_PRELOAD_EVENT_ERROR - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerPreloadEvent
- PLAYER_REASON_CODEC_NOT_SUPPORTED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-
Decoder codec not supported
- PLAYER_REASON_INTERNAL - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-
Internel error
- PLAYER_REASON_INTERRUPTED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-
Url not found
- PLAYER_REASON_INVALID_ARGUMENTS - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-
The parameter is incorrect
- PLAYER_REASON_INVALID_CONNECTION_STATE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-
Invalid connection state
- PLAYER_REASON_INVALID_MEDIA_SOURCE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-
Media source is invalid
- PLAYER_REASON_INVALID_STATE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-
Internal state error
- 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
-
No resource error
- PLAYER_REASON_NONE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-
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
-
format not support
- PLAYER_REASON_OBJ_NOT_INITIALIZED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-
Object is not initialized
- PLAYER_REASON_TOKEN_EXPIRED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-
token expired
- PLAYER_REASON_UNKNOWN - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-
Error unknown
- PLAYER_REASON_UNKNOWN_STREAM_TYPE - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-
Unknown stream type
- PLAYER_REASON_URL_NOT_FOUND - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-
Url not found
- PLAYER_REASON_VIDEO_RENDER_FAILED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerReason
-
Video renderer is invalid
- 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
-
Player failed
- 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
-
Player idle
- 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
-
Media file opened successfully
- PLAYER_STATE_OPENING - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
-
Opening media file
- PLAYER_STATE_PAUSED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
-
Player paused
- 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
-
Player playback all loops completed
- PLAYER_STATE_PLAYBACK_COMPLETED - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
-
Player playback one loop completed
- PLAYER_STATE_PLAYING - Enum constant in enum class io.agora.mediaplayer.Constants.MediaPlayerState
-
Player 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
-
The playback is stopped.
- 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
-
Player unknown
- PlayerPlaybackStats - Class in io.agora.mediaplayer.data
-
The real time statistics of the media stream being played.
- PlayerPlaybackStats() - Constructor for class io.agora.mediaplayer.data.PlayerPlaybackStats
- PlayerTextureHelper - Class in io.agora.mediaplayer.gl
- PlayerUpdatedInfo - Class in io.agora.mediaplayer.data
-
Call back PlayerUpdatedInfo to the user, when some information of the media player is updated.
- 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 inspect module
- position - Variable in class io.agora.rtc2.video.SnapshotConfig
- position - Variable in class io.agora.rtc2.video.VideoCanvas
-
The video frame position in pipeline.
- position - Variable in class io.agora.spatialaudio.RemoteVoicePositionInfo
- position - Variable in class io.agora.spatialaudio.SpatialAudioZone
- 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
onPlaybackFrameBeforeMixingoronPlaybackFrameBeforeMixingExcallback. - 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
onEarMonitoringAudioFramecallback. - 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
onMixedFramecallback. - 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
onPlaybackFramecallback. - 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
onRecordFramecallback. - positionInLandscapeMode - Variable in class io.agora.rtc2.video.WatermarkOptions
-
The watermark position in the landscape mode.
- positionInPortraitMode - Variable in class io.agora.rtc2.video.WatermarkOptions
-
The watermark position in the portrait mode.
- PREFER_AUTO - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.ENCODING_PREFERENCE
-
Default hardware encoding.
- PREFER_COMPRESSION_AUTO - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.COMPRESSION_PREFERENCE
-
(Default) SDK uses compression preference according to setVideoScenario API settings, real-time network state and other relevant data information.
- PREFER_HARDWARE - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.ENCODING_PREFERENCE
-
Hardware encoding
- PREFER_LOW_LATENCY - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.COMPRESSION_PREFERENCE
-
Prefer low latency, normally used in real-time communication
- PREFER_QUALITY - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.COMPRESSION_PREFERENCE
-
Prefer quality in sacrifice of a degree of latency, usually around 30ms ~ 150ms, depends target fps
- PREFER_SOFTWARE - Enum constant in enum class io.agora.rtc2.video.VideoEncoderConfiguration.ENCODING_PREFERENCE
-
Software encoding.
- preferMultipathType - Variable in class io.agora.rtc2.ChannelMediaOptions
-
The preferred type of multipath transmission.
- PREFIX_ASSETS - Static variable in class io.agora.mediaplayer.AssetsFileReader
- preloadChannel(String, String, int) - Method in class io.agora.rtc2.RtcEngine
-
Preload a channel.
- preloadChannelWithUserAccount(String, String, String) - Method in class io.agora.rtc2.RtcEngine
-
Preload a channel.
- 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
-
Preloads a specified audio effect.
- 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
-
Preloads a specified audio effect to a specified channel.
- 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
-
Preloads a specified audio effect to a specified channel.
- preloadSrc(String, long) - Method in interface io.agora.mediaplayer.IMediaPlayer
- PRIMARY_CAMERA_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
-
2: Video captured by 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
- 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
-
Determines whether to publish the video of the camera track.
- publishCameraTrack - Variable in class io.agora.rtc2.DirectCdnStreamingMediaOptions
-
Deprecated.Determines whether to publish the video of the camera track.
- publishCustomAudioTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
-
Determines whether to publish the audio of the custom audio track.
- publishCustomAudioTrack - Variable in class io.agora.rtc2.DirectCdnStreamingMediaOptions
-
Deprecated.Determines whether to publish the audio of the custom audio track.
- publishCustomAudioTrackId - Variable in class io.agora.rtc2.ChannelMediaOptions
-
The custom audio track id.
- publishCustomVideoTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
-
Determines whether to publish the video of the custom video track.
- publishCustomVideoTrack - Variable in class io.agora.rtc2.DirectCdnStreamingMediaOptions
-
Deprecated.Determines whether to publish the video of the custom video track.
- publishDuration - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
-
The total publish duration (ms) of the remote audio stream.
- publishDuration - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
-
The total publish duration (ms) of the remote video stream.
- publishEncodedVideoTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
-
Determines whether to publish the video of the encoded video track.
- 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
setLiveTranscodingmethod. - 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.
- publishFourthCameraTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
-
Whether to publish the video of the fourth camera track.
- publishLipSyncTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
-
Whether to publish the local lip sync video track.
- publishMediaPlayerAudioTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
-
Determines whether to publish the audio track of media player source.
- 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
-
Determines which media player source should 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
-
Determines whether to publish the video track of media player source.
- publishMicrophoneTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
-
Determines whether to publish the recorded audio of microphone.
- publishMicrophoneTrack - Variable in class io.agora.rtc2.DirectCdnStreamingMediaOptions
-
Deprecated.Determines whether to publish the audio of the Microphonetrack.
- publishMixedAudioTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
-
Whether to publish the local mixed audio track.
- publishRhythmPlayerTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
-
Determines whether to publish the sound of the rhythm player to remote users.
- publishScreenCaptureAudio - Variable in class io.agora.rtc2.ChannelMediaOptions
-
Determines whether to publish the audio track of the screen capturer.
- publishScreenCaptureVideo - Variable in class io.agora.rtc2.ChannelMediaOptions
-
Determines whether to publish the video track of the capturer .
- 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 of the third camera track.
- 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
-
Pulls the remote audio frame.
- pullPlaybackAudioFrame(ByteBuffer, int) - Method in class io.agora.rtc2.RtcEngine
-
Pulls the remote audio frame.
- 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
-
Pushes the external audio data to the app.
- 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. Call the
setExternalVideoSourcemethod and set `pushMode` as `true` before calling this method. Otherwise, a failure returns after calling this method. - pushExternalVideoFrameById(VideoFrame, int) - Method in class io.agora.rtc2.RtcEngine
-
Pushes the external video frame to the app.
Q
- qoeQuality - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
-
Quality of experience (QoE) of the local user when receiving a remote audio stream.
- quality - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
-
The receiving audio quality: - `QUALITY_UNKNOWN(0)`: The quality is unknown.
- 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
-
Quality change of the local video in terms of target frame rate and target bit rate since last count.
- qualityChangedReason - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
-
The reason for poor QoE of the local user when receiving a remote audio stream.
- queryCameraFocalLengthCapability() - Method in class io.agora.rtc2.RtcEngine
-
Query all focal attributes supported by the camera.
- 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
-
queryCodecCapability.
- queryDeviceScore() - Method in class io.agora.rtc2.RtcEngine
-
Queries the score of the current device.
- 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
-
Queries the ability of screen sharing to support the minimum frame rate.
R
- rate(String, int, String) - Method in class io.agora.rtc2.RtcEngine
-
Allows a user to rate the call.
- 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 bitrate (Kbps) of the received audio stream, represented by an instantaneous value.
- receivedBitrate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
-
Bitrate (Kbps) received since the last count.
- receivedSampleRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
-
The sample rate (Hz) of the received audio stream, represented by an instantaneous value.
- 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
-
Information for the recording file.
- RecorderInfo(String, int, int) - Constructor for class io.agora.rtc2.RecorderInfo
- recorderInfoUpdateInterval - Variable in class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
-
The interval (ms) of updating the recording information.
- RecorderStreamInfo - Class in io.agora.rtc2
-
The information about recorded media streams.
- 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
-
the recorderStreamType , now we support: 0 the stream in (rtc)channel 1 the stream out channel
- RECOVERING - Enum constant in enum class io.agora.rtc2.DirectCdnStreamingState
-
Deprecated.Recovering.
- rect - Variable in class io.agora.rtc2.video.VideoCanvas
-
If you want to display a certain part of a video frame, you can set this value to crop the video frame to show.
- 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.
- 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
-
Registers an encoded audio frame observer object.
- registerAudioFrameObserver(IMediaPlayerAudioFrameObserver, int) - Method in interface io.agora.mediaplayer.IMediaPlayer
- registerAudioFrameObserver(IAudioFrameObserver) - Method in class io.agora.rtc2.RtcEngine
-
Registers an audio frame observer object.
- registerAudioSpectrumObserver(IAudioSpectrumObserver) - Method in class io.agora.rtc2.RtcEngine
-
Registers an audio spectrum observer.
- registerExtension(String, String, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
-
Registers an extension.
- registerFaceInfoObserver(IFaceInfoObserver) - Method in class io.agora.rtc2.RtcEngine
-
Registers an face info observer object.
- registerLocalUserAccount(String, String) - Method in class io.agora.rtc2.RtcEngine
-
Registers a user account.
- registerMediaMetadataObserver(IMetadataObserver, int) - Method in class io.agora.rtc2.RtcEngine
-
Registers the metadata observer.
- 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
-
Registers a media player observer.
- registerTranscoderObserver(IH265TranscoderObserver) - Method in interface io.agora.rtc2.IH265Transcoder
-
Register a IH265TranscoderObserver object.
- registerVideoEncodedFrameObserver(IVideoEncodedFrameObserver) - Method in class io.agora.rtc2.RtcEngine
-
Registers a receiver object for the encoded video image.
- registerVideoFrameObserver(IMediaPlayerVideoFrameObserver) - Method in interface io.agora.mediaplayer.IMediaPlayer
- registerVideoFrameObserver(IVideoFrameObserver) - Method in class io.agora.rtc2.RtcEngine
-
Registers a video frame observer object.
- regulatedCaptureFrameHeight - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
-
The regulated frame height (px) of capture frame height according to video encoder configuration.
- regulatedCaptureFrameRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
-
The regulated frame rate of capture frame rate according to video encoder configuration.
- regulatedCaptureFrameWidth - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
-
The regulated frame width (px) of capture frame width according to video encoder configuration.
- 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
-
Elapsed time from remote user joined to the remote video packet received.
- remoteJoined2SetView - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoRenderingTracingInfo
-
Elapsed time from remote user joined to set the view.
- remoteJoined2UnmuteVideo - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoRenderingTracingInfo
-
Elapsed time from remote user joined to the time subscribing 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 ID of the remote user.
- remoteUserUid - Variable in class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
-
The 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
-
Remove all media resource cache files.
- 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
-
Remove the cache file by uri, setting by MediaSource.
- removeDestChannelInfo(String) - Method in class io.agora.rtc2.video.ChannelMediaRelayConfiguration
-
Removes the destination channel.
- removeHandler(IRtcEngineEventHandler) - Method in class io.agora.rtc2.RtcEngine
-
Removes the specified IRtcEngineEventHandler object.
- removeHandlerEx(IRtcEngineEventHandler, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Removes the IRtcEngineEventHandler.
- removeOldCache() - Method in interface io.agora.mediaplayer.IMediaPlayerCacheManager
-
Remove the latest media resource cache file.
- 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 render output frame rate (fps) of the local video.
- rendererOutputFrameRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
-
The render output frame rate (fps) of the remote video.
- renderMode - Variable in class io.agora.rtc2.video.VideoCanvas
-
The video render mode: - `RENDER_MODE_HIDDEN(1)`: (Default)Uniformly scale the video until it fills the visible boundaries (cropped).
- 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: The token renewal was canceled because a new request was made, and the previous one was canceled.
- RENEW_TOKEN_FAILURE - Enum constant in enum class io.agora.rtc2.Constants.RenewTokenErrorCode
-
1: The token renewal failed because of some unknown server error.
- RENEW_TOKEN_INCONSISTENT_APPID - Enum constant in enum class io.agora.rtc2.Constants.RenewTokenErrorCode
-
5: The token renewal 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: The token renewal failed because the channel name is invalid.
- RENEW_TOKEN_INVALID_TOKEN - Enum constant in enum class io.agora.rtc2.Constants.RenewTokenErrorCode
-
3: The token renewal failed because the token is not valid.
- RENEW_TOKEN_SUCCESS - Enum constant in enum class io.agora.rtc2.Constants.RenewTokenErrorCode
-
0: The token is renewed successfully.
- RENEW_TOKEN_TOKEN_EXPIRED - Enum constant in enum class io.agora.rtc2.Constants.RenewTokenErrorCode
-
2: The token renewal 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
-
Renews the token.
- 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
-
Reset the video effect to its 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
-
Resumes playing the media file.
- resumeAllChannelMediaRelay() - Method in class io.agora.rtc2.RtcEngine
-
resume the channels for media stream relay.
- resumeAllChannelMediaRelayEx(RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
resume the channels for media stream relay.
- resumeAllEffects() - Method in interface io.agora.rtc2.IAudioEffectManager
-
Resumes playing all audio effects.
- resumeAllEffects() - Method in class io.agora.rtc2.RtcEngine
-
Resumes playing all audio effects.
- resumeAudio() - Method in class io.agora.rtc2.RtcEngine
-
Enables the audio function in the channel.
- resumeAudioMixing() - Method in class io.agora.rtc2.RtcEngine
-
Resumes playing and mixing the music file.
- resumeEffect(int) - Method in interface io.agora.rtc2.IAudioEffectManager
-
Resumes playing the specific audio effect.
- resumeEffect(int) - Method in class io.agora.rtc2.RtcEngine
-
Resumes playing the specified audio effect.
- 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
- rightLength - Variable in class io.agora.spatialaudio.SpatialAudioZone
- 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
-
The rotation information (clockwise) of this frame.
- rotation - Variable in class io.agora.rtc2.video.EncodedVideoFrameInfo
-
The rotation information (clockwise) of this frame.
- 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
-
The RtcConnection class.
- 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
-
Configurations for the
RtcEngineinstance. - RtcEngineConfig() - Constructor for class io.agora.rtc2.RtcEngineConfig
- RtcEngineConfig.AreaCode - Class in io.agora.rtc2
-
Regions for connection
- 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 delay time (ms).
- RUNNING - Enum constant in enum class io.agora.rtc2.DirectCdnStreamingState
-
Deprecated.running.
- 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
-
Total number of audio bytes received (bytes) before network countermeasures, represented by an aggregate value.
- rxAudioKBitRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
-
The audio receiving bitrate in Kbps, represented by an instantaneous value.
- rxBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
-
The total number of bytes received, represented by an aggregate value.
- rxKBitRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.PathStats
-
Reception bitrate in Kbps for the path.
- rxKBitRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
-
The receiving bitrate in Kbps, represented by an instantaneous value.
- rxPacketLossRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
-
The packet loss rate of receiver(audience).
- rxStreamType - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
-
Remote video stream type
- 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
-
Total number of video bytes received (bytes), represented by an aggregate value.
- rxVideoKBitRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
-
The video receiving bitrate in Kbps, represented by an instantaneous value.
S
- sample_rate - Variable in class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
-
The audio sample rate
- sampleRataHz - Variable in class io.agora.base.AudioFrame
- 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` - `16000` (Default) - `32000` - `44100` - `48000`
- sampleRate - Variable in class io.agora.rtc2.ScreenCaptureParameters.AudioCaptureParameters
-
The audio sample rate (Hz).
- samplesPerCall - Variable in class io.agora.rtc2.audio.AudioParams
-
The number of samples.
- samplesPerChannel - Variable in class io.agora.base.AudioFrame
- SAVE - Enum constant in enum class io.agora.rtc2.IVideoEffectObject.VIDEO_EFFECT_ACTION
-
Save the current parameters of the video effect.
- 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: 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: (Default) Video.
- ScreenCaptureParameters - Class in io.agora.rtc2
-
The configuration of the screen sharing
- ScreenCaptureParameters() - Constructor for class io.agora.rtc2.ScreenCaptureParameters
- ScreenCaptureParameters.AudioCaptureParameters - Class in io.agora.rtc2
-
The audio configuration for the shared screen stream.
- ScreenCaptureParameters.VideoCaptureParameters - Class in io.agora.rtc2
-
The video configuration for the shared screen stream.
- screenColorType - Variable in class io.agora.rtc2.video.SegmentationProperty
-
The color of the screen for green screen segmentation.
- SECONDARY_CAMERA_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
-
3: Video captured by 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
-
Sets the current playback position of the media file.
- 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
-
The properties for virtual background algorithm.
- 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
-
Select playback audio track of the media file
- selectAudioTrack(int) - Method in class io.agora.rtc2.RtcEngine
-
select the track of the mixing music file.
- selectInternalSubtitle(int) - Method in interface io.agora.mediaplayer.IMediaPlayer
-
select internal subtitles in video
- selectMultiAudioTrack(int, int) - Method in interface io.agora.mediaplayer.IMediaPlayer
-
Selects multi audio track of the media file for playback or publish to channel.
- 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
-
Agora supports reporting and analyzing customized messages.
- sendCustomReportMessageEx(String, String, String, String, int, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Report custom event to argus.
- 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
-
Sends a data stream.
- sendStreamMessageEx(int, byte[], RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Sends data stream messages to all users in a channel.
- sentBitrate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalAudioStats
-
The average sending bitrate (Kbps).
- sentBitrate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
- sentFrameRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
-
Frame rate (fps) sent in the reported interval, which does not include the frame rate of the retransmission video after packet loss.
- sentSampleRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalAudioStats
-
The sample rate (Hz).
- 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
-
The specific server configuration for image moderation.
- serverDomain - Variable in class io.agora.rtc2.proxy.LocalAccessPointConfiguration.LogUploadServerInfo
-
Log upload server domain
- serverHttps - Variable in class io.agora.rtc2.proxy.LocalAccessPointConfiguration.LogUploadServerInfo
-
Whether to use HTTPS request: - true: Use HTTPS request - fasle: Use HTTP request
- serverPath - Variable in class io.agora.rtc2.proxy.LocalAccessPointConfiguration.LogUploadServerInfo
-
Log upload server path
- serverPort - Variable in class io.agora.rtc2.proxy.LocalAccessPointConfiguration.LogUploadServerInfo
-
Log upload server port
- 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
-
set advanced audio option
- 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
-
Enables/Disables Agora AI Noise Suppression(AINS) with preset mode.
- 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
-
Set dual-mono output mode of the music file.
- setAudioEffectParameters(int, int, int) - Method in class io.agora.rtc2.RtcEngine
-
Sets parameters for SDK preset audio effects.
- setAudioEffectPreset(int) - Method in class io.agora.rtc2.RtcEngine
-
Sets an SDK preset audio effect.
- setAudioMixingDualMonoMode(Constants.AudioMixingDualMonoMode) - Method in class io.agora.rtc2.RtcEngine
-
In dual-channel music files, different audio data can be stored on the left and right channels.
- setAudioMixingPitch(int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the pitch of the music file.
- setAudioMixingPlaybackSpeed(int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the playback speed of the current music file.
- setAudioMixingPosition(int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the playback position (ms) of the music file to a different starting position (the default plays from the beginning).
- setAudioPitch(int) - Method in interface io.agora.mediaplayer.IMediaPlayer
-
Sets the pitch of the current media file.
- setAudioProfile(int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the audio profile.
- setAudioProfile(int, int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the audio parameters and application scenarios.
- 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
-
Bind local user and a remote user as an audio&video sync group.
- 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
-
Enables/Disables image enhancement and sets the options.
- setBeautyEffectOptions(boolean, BeautyOptions, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
-
Enables/Disables image enhancement and sets the options.
- 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
-
Set cache file path that files will be saved to.
- setCacheSize(long) - Method in class io.agora.mediaplayer.data.CacheStatistics
- setCameraAutoFocusFaceModeEnabled(boolean) - Method in class io.agora.rtc2.RtcEngine
-
Enables the camera auto focus face function.
- setCameraCapturerConfiguration(CameraCapturerConfiguration) - Method in class io.agora.rtc2.RtcEngine
-
Sets the camera capturer configuration.
- setCameraExposureFactor(int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the camera exposure ratio.
- setCameraExposurePosition(float, float) - Method in class io.agora.rtc2.RtcEngine
-
Sets the camera exposure position.
- setCameraFocusPositionInPreview(float, float) - Method in class io.agora.rtc2.RtcEngine
-
Sets the manual focus position.
- setCameraTorchOn(boolean) - Method in class io.agora.rtc2.RtcEngine
-
Enables the camera flash.
- setCameraZoomFactor(float) - Method in class io.agora.rtc2.RtcEngine
-
Sets the camera zoom ratio.
- 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
-
Sets the channel profile.
- setClientRole(int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the role of a user.
- setClientRole(int, ClientRoleOptions) - Method in class io.agora.rtc2.RtcEngine
-
Sets the role of a user (`LIVE_BROADCASTING` profile only).
- setCloudProxy(int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the Agora cloud proxy service.
- 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
-
Sets color enhancement.
- setColorEnhanceOptions(boolean, ColorEnhanceOptions, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
-
Sets color enhancement.
- setDefaultAudioRoutetoSpeakerphone(boolean) - Method in class io.agora.rtc2.RtcEngine
-
Sets the default audio route.
- 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
-
Enables, disables or auto enable the dual video stream mode.
- setDualStreamMode(Constants.SimulcastStreamMode, SimulcastStreamConfig) - Method in class io.agora.rtc2.RtcEngine
-
Enables, disables or auto enable the dual video stream mode.
- setDualStreamModeEx(Constants.SimulcastStreamMode, SimulcastStreamConfig, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Enables, disables or auto enable the dual video stream mode.
- setDuration(long) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
- setEarMonitoringAudioFrameParameters(int, int, int, int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the audio ear monitoring format for the
onEarMonitoringAudioFramecallback. - setEffectPosition(int, int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the playback position of an audio effect file.
- setEffectsVolume(double) - Method in interface io.agora.rtc2.IAudioEffectManager
-
Sets the volume of audio effects.
- setEffectsVolume(double) - Method in class io.agora.rtc2.RtcEngine
-
Sets the volume of audio effects.
- 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
-
Enables or disables the speakerphone temporarily.
- 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
-
Sets the properties of an extension.
- 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
-
Sets the provider property of an extension.
- setExternalAudioSink(boolean, int, int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the external audio sink.
- 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
-
Sets screen sharing using the Android native class MediaProjection.
- setExternalRemoteEglContext(Object) - Method in class io.agora.rtc2.RtcEngine
-
Set remote eglContext.
- 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
-
Sets the external video source.
- 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
-
Sets the face shape area options.
- setFaceShapeAreaOptions(FaceShapeAreaOptions, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
-
Sets the face shape area options.
- setFaceShapeBeautyOptions(boolean, FaceShapeBeautyOptions) - Method in class io.agora.rtc2.RtcEngine
-
Enables/Disables face shape and sets the beauty options.
- setFaceShapeBeautyOptions(boolean, FaceShapeBeautyOptions, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
-
Enables/Disables face shape and sets the beauty options.
- setFileSize(long) - Method in class io.agora.mediaplayer.data.CacheStatistics
- setFilterEffectOptions(boolean, FilterEffectOptions) - Method in class io.agora.rtc2.RtcEngine
-
Sets filter effect option.
- setFilterEffectOptions(boolean, FilterEffectOptions, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
-
Sets filter effect option.
- 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
-
Sets the parameters of audio playback effect for remote headphones after remote audio is mixed.
- setHeadphoneEQPreset(int) - Method in class io.agora.rtc2.RtcEngine
-
Sets preset audio playback effect for remote headphones after remote audio is mixed.
- 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
-
Sets the volume of the in-ear monitoring.
- 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
-
set local access point addresses in local proxy mode, use this method before join channel.
- setLocalRenderMode(int) - Method in class io.agora.rtc2.RtcEngine
-
Deprecated.
- setLocalRenderMode(int, int) - Method in class io.agora.rtc2.RtcEngine
-
Updates the display mode of the local video view.
- setLocalRenderTargetFps(Constants.VideoSourceType, int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the target frames per second (FPS) for the local render target.
- setLocalVideoMirrorMode(int) - Method in class io.agora.rtc2.RtcEngine
-
Deprecated.
- setLocalVoiceEqualization(Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY, int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the local voice equalization effect.
- setLocalVoiceFormant(double) - Method in class io.agora.rtc2.RtcEngine
-
Sets the voice formant ratio for local speaker.
- setLocalVoicePitch(double) - Method in class io.agora.rtc2.RtcEngine
-
Sets the voice pitch of the local speaker.
- setLocalVoiceReverb(Constants.AUDIO_REVERB_TYPE, int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the local voice reverberation.
- setLogFile(String) - Method in class io.agora.rtc2.RtcEngine
-
Specifies an SDK output log file.
- setLogFileSize(long) - Method in class io.agora.rtc2.RtcEngine
-
Sets the log file size (KB).
- setLogFilter(int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the output log filter level of the SDK.
- setLogLevel(int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the output log level of the SDK.
- setLoopCount(int) - Method in interface io.agora.mediaplayer.IMediaPlayer
-
Sets whether to loop the media file for playback.
- setLowlightEnhanceOptions(boolean, LowLightEnhanceOptions) - Method in class io.agora.rtc2.RtcEngine
-
Sets low-light enhancement.
- setLowlightEnhanceOptions(boolean, LowLightEnhanceOptions, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
-
Sets low-light enhancement.
- setMaxAudioRecvCount(int) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
- setMaxCacheFileCount(int) - Method in interface io.agora.mediaplayer.IMediaPlayerCacheManager
-
Set the maximum number of cached files.
- setMaxCacheFileSize(long) - Method in interface io.agora.mediaplayer.IMediaPlayerCacheManager
-
Set the total size of the largest cache file.
- setMediaRecorderObserver(IMediaRecorderCallback) - Method in class io.agora.rtc2.AgoraMediaRecorder
-
Registers the IMediaRecorderCallback object.
- setMediaStreamType(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
- setMixedAudioFrameParameters(int, int, int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the mixed audio format for the
onMixedAudioFramecallback. - 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
-
Provides technical preview functionalities or special customizations by configuring the SDK with JSON options.
- 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
-
Sets the audio playback format before mixing for the
onPlaybackAudioFrameBeforeMixingcallback. - setPlaybackAudioFrameBeforeMixingParameters(int, int, int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the audio playback format before mixing for the
onPlaybackAudioFrameBeforeMixingcallback. - setPlaybackAudioFrameParameters(int, int, int, int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the audio recording format for the
onPlaybackAudioFramecallback. - setPlaybackSpeed(int) - Method in interface io.agora.mediaplayer.IMediaPlayer
-
Change playback speed
- setPlayerAttenuation(int, double, boolean) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
- setPlayerOption(String, int) - Method in interface io.agora.mediaplayer.IMediaPlayer
-
change player option before play a file
- setPlayerOptionString(String, String) - Method in interface io.agora.mediaplayer.IMediaPlayer
-
change player option before play a file
- 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
-
Sets the audio recording format for the
onRecordAudioFramecallback. - 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
-
Sets the default stream type of the remote video if the remote user has enabled dual-stream.
- setRemoteRenderMode(int, int) - Method in class io.agora.rtc2.RtcEngine
-
Deprecated.
- setRemoteRenderMode(int, int, int) - Method in class io.agora.rtc2.RtcEngine
-
Updates the display mode of the video view of a remote user.
- setRemoteRenderModeEx(int, int, int, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Updates the display mode of the video view of a remote user with the specified connection.
- setRemoteRenderTargetFps(int) - Method in class io.agora.rtc2.RtcEngine
-
Sets the target frames per second (FPS) for the remote render target.
- setRemoteSubscribeFallbackOption(int) - Method in class io.agora.rtc2.RtcEngine
-
Deprecated.
- setRemoteSubscribeFallbackOption(Constants.StreamFallbackOptions) - Method in class io.agora.rtc2.RtcEngine
-
Sets the fallback option for the remotely subscribed video stream based on the network conditions.
- 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
-
Sets the remote video stream type.
- setRemoteVideoStreamTypeEx(int, int, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Deprecated.
- setRemoteVideoStreamTypeEx(int, Constants.VideoStreamType, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Sets the remote video stream type.
- 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
-
Sets the sound position and gain of a remote user.
- setRemoteVoicePositionEx(int, double, double, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Sets the sound position and gain of a remote user.
- setRenderMode(int) - Method in interface io.agora.mediaplayer.IMediaPlayer
- setRouteInCommunicationMode(int) - Method in class io.agora.rtc2.RtcEngine
-
Select preferred route in android communication mode.
- setScreenCaptureScenario(Constants.ScreenScenarioType) - Method in class io.agora.rtc2.RtcEngine
-
Sets the screen sharing scenario.
- setSimulcastConfig(SimulcastConfig) - Method in class io.agora.rtc2.RtcEngine
-
Sets the multi-layer video stream configuration.
- setSimulcastConfigEx(SimulcastConfig, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Set the multi-layer video stream configuration.
- setSpatialAudioParams(SpatialAudioParams) - Method in interface io.agora.mediaplayer.IMediaPlayer
-
Set spatial audio params for the music file.
- 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
-
Sets the allowlist of subscribe remote stream audio.
- setSubscribeAudioAllowlistEx(int[], RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Sets the allowlist of subscribe remote stream audio.
- setSubscribeAudioBlocklist(int[]) - Method in class io.agora.rtc2.RtcEngine
-
Sets the blocklist of subscribe remote stream audio.
- setSubscribeAudioBlocklistEx(int[], RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Sets the blocklist of subscribe remote stream audio.
- setSubscribeVideoAllowlist(int[]) - Method in class io.agora.rtc2.RtcEngine
-
Sets the whitelist of subscribe remote stream video.
- setSubscribeVideoAllowlistEx(int[], RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Sets the whitelist of subscribe remote stream video.
- setSubscribeVideoBlocklist(int[]) - Method in class io.agora.rtc2.RtcEngine
-
Sets the blocklist of subscribe remote stream video.
- setSubscribeVideoBlocklistEx(int[], RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Sets the blocklist of subscribe remote stream video.
- 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
-
Initializes the local video view.
- setupMode - Variable in class io.agora.rtc2.video.VideoCanvas
-
The mode of setting up video view.
- setupRemoteVideo(VideoCanvas) - Method in class io.agora.rtc2.RtcEngine
-
Initializes the video view of a remote user.
- setupRemoteVideoEx(VideoCanvas, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Initializes the video view of a remote user with a specified connection ID.
- 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
-
Sets video noise reduction.
- setVideoDenoiserOptions(boolean, VideoDenoiserOptions, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
-
Sets video noise reduction.
- 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
-
Sets the video encoder configuration.
- setVideoEncoderConfigurationEx(VideoEncoderConfiguration, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Sets the video encoder configuration with specified connection.
- 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
-
You can call this method to set the expected video scenario.
- 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
-
Sets parameters for SDK preset voice beautifier effects.
- setVoiceBeautifierPreset(int) - Method in class io.agora.rtc2.RtcEngine
-
Sets an SDK preset voice beautifier effect.
- 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
-
Sets an SDK preset voice conversion effect.
- 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
-
Sets the volume of the specified audio effect.
- setZones(SpatialAudioZone[]) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
- shapeArea - Variable in class io.agora.rtc2.video.FaceShapeAreaOptions
-
The specific facial area to be adjusted, used with
shapeArea:FACE_SHAPE_AREA_NONE(-1): (default) invalid area. - shapeIntensity - Variable in class io.agora.rtc2.video.FaceShapeAreaOptions
-
The intensity of the pinching effect applied to the specified facial area.
- shapeStyle - Variable in class io.agora.rtc2.video.FaceShapeBeautyOptions
-
The face shape style, used with
shapeStyle:FACE_SHAPE_BEAUTY_STYLE_FEMALE(0): (default) Female face shape style. - sharpnessLevel - Variable in class io.agora.rtc2.video.BeautyOptions
-
The smoothness level.
- SimulcastConfig - Class in io.agora.rtc2
-
The configuration of the multi-layer video stream.
- SimulcastConfig() - Constructor for class io.agora.rtc2.SimulcastConfig
- SimulcastConfig.StreamLayerConfig - Class in io.agora.rtc2
-
The configuration of a specific layer in the multi-layer video stream.
- SimulcastConfig.StreamLayerIndex - Enum Class in io.agora.rtc2
-
The index of multi-layer video stream
- 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.
- SnapshotConfig - Class in io.agora.rtc2.video
-
The SnapshotConfig class.
- 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
-
Background image file path
- sourceType - Variable in class io.agora.rtc2.LocalAudioMixerConfiguration.MixedAudioStream
-
The source type of audio for the audio mixing on the local client.
- sourceType - Variable in class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
-
The source type of video for the video mixing on the local client.
- sourceType - Variable in class io.agora.rtc2.video.VideoCanvas
-
The video source type.
- 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
-
Speaker attenuation factor.
- speaker_azimuth - Variable in class io.agora.rtc2.SpatialAudioParams
-
Speaker azimuth in a spherical coordinate system centered on the listener.
- speaker_distance - Variable in class io.agora.rtc2.SpatialAudioParams
-
Distance between speaker and listener.
- speaker_elevation - Variable in class io.agora.rtc2.SpatialAudioParams
-
Speaker elevation in a spherical coordinate system centered on the listener.
- speaker_orientation - Variable in class io.agora.rtc2.SpatialAudioParams
-
Speaker orientation [0-180], 0 degree is the same with listener orientation.
- SPEECH_DRIVEN_VIDEO_SOURCE - Enum constant in enum class io.agora.rtc2.Constants.MediaSourceType
-
13: Video for voice drive.
- 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 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
-
Elapsed time from the start tracing time to the time when join channel.
- startAudioMixing(String, boolean, int) - Method in class io.agora.rtc2.RtcEngine
-
Starts playing and mixing the music file.
- startAudioMixing(String, boolean, int, int) - Method in class io.agora.rtc2.RtcEngine
-
Starts playing and mixing the music file.
- startAudioRecording(AudioRecordingConfiguration) - Method in class io.agora.rtc2.RtcEngine
-
Starts an audio recording.
- startAudioRecording(String, int) - Method in class io.agora.rtc2.RtcEngine
-
Starts an audio recording.
- startCameraCapture(Constants.VideoSourceType, CameraCapturerConfiguration) - Method in class io.agora.rtc2.RtcEngine
-
Starts video capture with a specified camera.
- startDirectCdnStreaming(IDirectCdnStreamingEventHandler, String, DirectCdnStreamingMediaOptions) - Method in class io.agora.rtc2.RtcEngine
-
Deprecated.v4.6.0.
- startEchoTest(EchoTestConfiguration) - Method in class io.agora.rtc2.RtcEngine
-
Starts a video call test.
- startLastmileProbeTest(LastmileProbeConfig) - Method in class io.agora.rtc2.RtcEngine
-
Starts the last-mile network probe test before joining a channel to get the uplink and downlink last-mile network statistics, including the bandwidth, packet loss, jitter, and round-trip time (RTT).
- startLocalAudioMixer(LocalAudioMixerConfiguration) - Method in class io.agora.rtc2.RtcEngine
-
Starts the local audio with a mixed audio stream.
- startLocalVideoTranscoder(LocalTranscoderConfiguration) - Method in class io.agora.rtc2.RtcEngine
-
Starts the local video with a transcoding video stream.
- 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
-
Starts or update to relay media streams across channels.
- startOrUpdateChannelMediaRelayEx(ChannelMediaRelayConfiguration, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Starts or update to relay media streams across channels.
- startPlaybackDeviceTest(String) - Method in class io.agora.rtc2.RtcEngine
-
Starts a playback device test.
- 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
-
Starts the local video preview before joining a channel.
- startPreview(Constants.VideoSourceType) - Method in class io.agora.rtc2.RtcEngine
-
Starts the local video preview before joining a channel.
- startRecording(AgoraMediaRecorder.MediaRecorderConfiguration) - Method in class io.agora.rtc2.AgoraMediaRecorder
-
Starts recording the local or remote audio and video.
- startRecordingDeviceTest(int) - Method in class io.agora.rtc2.RtcEngine
-
Starts the microphone test.
- startRhythmPlayer(String, String, AgoraRhythmPlayerConfig) - Method in class io.agora.rtc2.RtcEngine
-
Enables the rhythm player.
- startRtmpStreamWithoutTranscoding(String) - Method in class io.agora.rtc2.RtcEngine
-
Publishes the local stream without transcoding to a specified CDN live RTMP address.
- startRtmpStreamWithoutTranscodingEx(String, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Publishes the local stream without transcoding to a specified CDN live RTMP address.
- startRtmpStreamWithTranscoding(String, LiveTranscoding) - Method in class io.agora.rtc2.RtcEngine
-
Publishes the local stream with transcoding to a specified CDN live RTMP address.
- startRtmpStreamWithTranscodingEx(String, LiveTranscoding, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Publishes the local stream with transcoding to a specified CDN live RTMP address.
- startScreenCapture(ScreenCaptureParameters) - Method in class io.agora.rtc2.RtcEngine
-
Starts screen sharing.
- state - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LastmileProbeResult
-
The state of the probe test:
LASTMILE_PROBE_RESULT_COMPLETE(1): the last-mile network probe test is complete. - stop() - Method in interface io.agora.mediaplayer.IMediaPlayer
-
Stops playing the current media file.
- stopAllEffect - Variable in class io.agora.rtc2.LeaveChannelOptions
-
Determines whether to stop all music effects when leave channel.
- stopAllEffects() - Method in interface io.agora.rtc2.IAudioEffectManager
-
Stops playing all audio effects.
- stopAllEffects() - Method in class io.agora.rtc2.RtcEngine
-
Stops playing all audio effects.
- stopAudioMixing - Variable in class io.agora.rtc2.LeaveChannelOptions
-
Determines whether to stop playing and mixing the music file when leave channel.
- stopAudioMixing() - Method in class io.agora.rtc2.RtcEngine
-
Stops playing or mixing the music file.
- stopAudioRecording() - Method in class io.agora.rtc2.RtcEngine
-
Stops the audio recording on the client.
- stopCameraCapture(Constants.VideoSourceType) - Method in class io.agora.rtc2.RtcEngine
-
Stops video capture with a specified camera.
- stopChannelMediaRelay() - Method in class io.agora.rtc2.RtcEngine
-
Stops the media stream relay.
- stopChannelMediaRelayEx(RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Stops the media stream relay.
- stopDirectCdnStreaming() - Method in class io.agora.rtc2.RtcEngine
-
Deprecated.v4.6.0.
- stopEchoTest() - Method in class io.agora.rtc2.RtcEngine
-
Stops an audio call test.
- stopEffect(int) - Method in interface io.agora.rtc2.IAudioEffectManager
-
Stops playing the specific audio effect.
- stopEffect(int) - Method in class io.agora.rtc2.RtcEngine
-
Stops playing the specified audio effect.
- stopLastmileProbeTest() - Method in class io.agora.rtc2.RtcEngine
-
Stops the last-mile network probe test.
- stopLocalAudioMixer() - Method in class io.agora.rtc2.RtcEngine
-
Stops a mixed audio track.
- stopLocalVideoTranscoder() - Method in class io.agora.rtc2.RtcEngine
-
Stops a transcoding video stream.
- stopMicrophoneRecording - Variable in class io.agora.rtc2.LeaveChannelOptions
-
Determines whether to stop microphone recording when leave channel.
- STOPPED - Enum constant in enum class io.agora.rtc2.DirectCdnStreamingState
-
Deprecated.stopped.
- stopPlaybackDeviceTest() - Method in class io.agora.rtc2.RtcEngine
-
Stops the playback device test.
- stopPreview() - Method in class io.agora.rtc2.RtcEngine
-
Stops the local video preview and the video.
- stopPreview(Constants.VideoSourceType) - Method in class io.agora.rtc2.RtcEngine
-
Stops the local video preview and the video.
- stopRecording() - Method in class io.agora.rtc2.AgoraMediaRecorder
-
Stops recording the audio and video.
- stopRecordingDeviceTest() - Method in class io.agora.rtc2.RtcEngine
-
Stops the microphone test.
- stopRhythmPlayer() - Method in class io.agora.rtc2.RtcEngine
-
Disables the rhythm player.
- stopRtmpStream(String) - Method in class io.agora.rtc2.RtcEngine
-
Stop an RTMP stream with transcoding or without transcoding from the CDN.
- stopRtmpStreamEx(String, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Stop an RTMP stream with transcoding or without transcoding from the CDN.
- stopScreenCapture() - Method in class io.agora.rtc2.RtcEngine
-
Stops screen sharing.
- storagePath - Variable in class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
-
The absolute path (including the filename extensions) for the recording file.
- STREAM_FALLBACK_OPTION_AUDIO_ONLY - Enum constant in enum class io.agora.rtc2.Constants.StreamFallbackOptions
-
2: Under poor network conditions, the SDK may receive agora::rtc::VIDEO_STREAM_LOW first, then agora::rtc::VIDEO_STREAM_LAYER_1 to agora::rtc::VIDEO_STREAM_LAYER_6 if the related layer exists.
- 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 operation to a lower resolution stream when the network condition is poor.
- 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: (Default) Under poor network conditions, the receiver SDK will receive agora::rtc::VIDEO_STREAM_LOW.
- 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: The video stream of layer_1, which has a lower resolution and bitrate than STREAM_HIGH.
- STREAM_LAYER_2 - Enum constant in enum class io.agora.rtc2.SimulcastConfig.StreamLayerIndex
-
1: The video stream of layer_2, which has a lower resolution and bitrate than VIDEO_STREAM_LAYER_1.
- STREAM_LAYER_3 - Enum constant in enum class io.agora.rtc2.SimulcastConfig.StreamLayerIndex
-
2: The video stream of layer_3, which has a lower resolution and bitrate than VIDEO_STREAM_LAYER_2.
- STREAM_LAYER_4 - Enum constant in enum class io.agora.rtc2.SimulcastConfig.StreamLayerIndex
-
3: The video stream of layer_4, which has a lower resolution and bitrate than VIDEO_STREAM_LAYER_3.
- STREAM_LAYER_5 - Enum constant in enum class io.agora.rtc2.SimulcastConfig.StreamLayerIndex
-
4: The video stream of layer_5, which has a lower resolution and bitrate than VIDEO_STREAM_LAYER_4.
- STREAM_LAYER_6 - Enum constant in enum class io.agora.rtc2.SimulcastConfig.StreamLayerIndex
-
5: The video stream of layer_6, which has a lower resolution and bitrate than VIDEO_STREAM_LAYER_5.
- STREAM_LAYER_COUNT_MAX - Enum constant in enum class io.agora.rtc2.SimulcastConfig.StreamLayerIndex
-
7: Max count 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: The low-quality video stream, which has the lowest resolution and bitrate.
- STREAM_TYPE_AUDIO - Enum constant in enum class io.agora.mediaplayer.Constants.MediaStreamType
-
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
-
Subtitle stream
- STREAM_TYPE_UNKNOWN - Enum constant in enum class io.agora.mediaplayer.Constants.MediaStreamType
-
Unknown stream type
- STREAM_TYPE_VIDEO - Enum constant in enum class io.agora.mediaplayer.Constants.MediaStreamType
-
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
-
The recording content: -
STREAM_TYPE_AUDIO(0x1): Only audio. - streamType - Variable in class io.agora.rtc2.video.EncodedVideoFrameInfo
-
The stream type of video frame.
- strength - Variable in class io.agora.rtc2.video.FilterEffectOptions
-
fliter effect strength
- strengthLevel - Variable in class io.agora.rtc2.video.ColorEnhanceOptions
-
The level of color enhancement.
- stride - Variable in class io.agora.rtc2.video.AgoraVideoFrame
-
The stride of this frame, which means the number of pixels between two consecutive rows.
- strUid - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayout
-
User account of video stream.
- STYLE_MAKEUP - Enum constant in enum class io.agora.rtc2.IVideoEffectObject.VIDEO_EFFECT_NODE_ID
-
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 pinching effect applied to the specified facial style.
- 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 user id of video stream composing the video stream from transcoder which will be drawn on this video canvas.
- 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
-
Set
VideoCanvas.surfaceTexturemakes Agora SDK as a video content provider, like Camera. - swDecodingLevel - Variable in class io.agora.rtc2.video.CodecCapLevels
- 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
-
Switches between front and rear cameras.
- switchCamera(String) - Method in class io.agora.rtc2.RtcEngine
-
Switches to appoint cameraId
- switchSrc(String, boolean) - Method in interface io.agora.mediaplayer.IMediaPlayer
- syncMode - Variable in class io.agora.rtc2.video.AgoraVideoFrame
-
Determines whether to enable the sync mode, which means that the SDK waits while the texture is being processed.
- syncWithAudio - Variable in class io.agora.rtc2.DataStreamConfig
- syncWithLocalMic - Variable in class io.agora.rtc2.LocalAudioMixerConfiguration
-
Whether to use the timestamp follow the local mic's audio frame.
- 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
-
Takes a snapshot of a video stream.
- takeSnapshot(int, String) - Method in class io.agora.rtc2.RtcEngine
-
Takes a snapshot of a video stream.
- takeSnapshotEx(RtcConnection, int, SnapshotConfig) - Method in class io.agora.rtc2.RtcEngineEx
-
Takes a snapshot of a video stream.
- takeSnapshotEx(RtcConnection, int, String) - Method in class io.agora.rtc2.RtcEngineEx
-
Takes a snapshot of a video stream.
- 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
-
The ID of the texture.
- 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
- timeStamp - Variable in class io.agora.rtc2.video.AgoraVideoFrame
-
The timestamp (ms) of this frame.
- timeStampMs - Variable in class io.agora.rtc2.video.AgoraMetadata
-
The NTP timestamp (ms) when the metadata is sent.
- toJsonString() - Method in class io.agora.rtc2.PublisherConfiguration
- token - Variable in class io.agora.rtc2.ChannelMediaOptions
-
The token to be renewed.
- token - Variable in class io.agora.rtc2.EchoTestConfiguration
-
The token for join channel.
- 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 time (ms) when the remote user neither stops sending the audio stream nor disables the audio module after joining the channel.
- totalActiveTime - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
-
The total time (ms) when the remote user neither stops sending the video stream nor disables the video module after joining the channel.
- totalDuration - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
-
The call duration 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 track id for custom track.
- trackId - Variable in class io.agora.rtc2.video.EncodedVideoFrameInfo
-
The track ID.
- 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 the video mixing on the local client.
- transform - Variable in class io.agora.rtc2.video.AgoraVideoFrame
-
The extra transform for the texture.
- 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
-
Total number of audio bytes sent (bytes), represented by an aggregate value.
- txAudioKBitRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
-
The audio transmission bitrate in Kbps, represented by an instantaneous value.
- txBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
-
The total number of bytes transmitted, represented by an aggregate value.
- txKBitRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.PathStats
-
Transmission bitrate in Kbps for the path.
- txKBitRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
-
The transmission bitrate in Kbps, represented by an instantaneous value.
- txPacketLossRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalAudioStats
-
The audio packet loss rate (%) from the local client to the Agora edge 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 edge server before applying the anti-packet loss strategies.
- txPacketLossRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
-
The packet loss rate of sender(broadcaster).
- txVideoBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
-
Total number of video bytes sent (bytes), represented by an aggregate value.
- txVideoKBitRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
-
The video transmission bitrate in Kbps, represented by an instantaneous value.
- type - Variable in class io.agora.rtc2.video.ContentInspectConfig.ContentInspectModule
-
The content inspect module ype
- type - Variable in class io.agora.rtc2.video.WatermarkConfig
-
The type of the watermark.
- TYPE_32000 - Enum constant in enum class io.agora.rtc2.live.LiveInjectStreamConfig.AudioSampleRateType
- 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
- 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
- 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 ID of the user.
- uid - Variable in class io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo
-
The user ID of the speaker.
- uid - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
-
ID of the local user whose video is sent.
- uid - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
-
ID of the user sending the audio streams.
- uid - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
-
User ID of the remote user sending the video streams.
- uid - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayout
-
User id of video stream.
- uid - Variable in class io.agora.rtc2.live.LiveTranscoding.TranscodingUser
-
ID of the user in the CDN live streaming.
- uid - Variable in class io.agora.rtc2.RecorderStreamInfo
-
The user ID.
- uid - Variable in class io.agora.rtc2.UserInfo
-
The user ID.
- uid - Variable in class io.agora.rtc2.video.AgoraMetadata
-
The User ID that sent the metadata.
- uid - Variable in class io.agora.rtc2.video.ChannelMediaInfo
-
The user ID.
- uid - Variable in class io.agora.rtc2.video.EncodedVideoFrameInfo
-
ID of the user who sends this video.
- uid - Variable in class io.agora.rtc2.video.VideoCanvas
-
The user id of local video.
- 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
-
Releases the specific preloaded audio effect from the memory.
- unloadSrc(String) - Method in interface io.agora.mediaplayer.IMediaPlayer
-
Unload a preloaded media source
- unRegisterAudioSpectrumObserver(IAudioSpectrumObserver) - Method in class io.agora.rtc2.RtcEngine
-
Releases the audio spectrum observer.
- unregisterMediaMetadataObserver(IMetadataObserver, int) - Method in class io.agora.rtc2.RtcEngine
-
Unregisters the metadata observer.
- unregisterMediaPlayerAudioSpectrumObserver(IAudioSpectrumObserver) - Method in interface io.agora.mediaplayer.IMediaPlayer
-
Releases the audio frame spectrum observer.
- unRegisterPlayerObserver(IMediaPlayerObserver) - Method in interface io.agora.mediaplayer.IMediaPlayer
-
Releases the media player observer.
- unregisterTranscoderObserver(IH265TranscoderObserver) - Method in interface io.agora.rtc2.IH265Transcoder
-
Unregister a IH265TranscoderObserver object.
- up - Variable in class io.agora.spatialaudio.SpatialAudioZone
- updateAppData(String) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Builder
-
Deprecated.
- updateChannelMediaOptions(ChannelMediaOptions) - Method in class io.agora.rtc2.RtcEngine
-
Updates the channel media options after joining the channel.
- updateChannelMediaOptionsEx(ChannelMediaOptions, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Updates the media options after joining the channel with specified connection.
- updateDirectCdnStreamingMediaOptions(DirectCdnStreamingMediaOptions) - Method in class io.agora.rtc2.RtcEngine
-
Deprecated.v4.6.0.
- updateLocalAudioMixerConfiguration(LocalAudioMixerConfiguration) - Method in class io.agora.rtc2.RtcEngine
-
Update the source stream settings for the mixed audio stream.
- updateLocalTranscoderConfiguration(LocalTranscoderConfiguration) - Method in class io.agora.rtc2.RtcEngine
-
Update the video layout settings for the transcoding video stream.
- updatePlayerPositionInfo(int, RemoteVoicePositionInfo) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
- updatePreloadChannelToken(String) - Method in class io.agora.rtc2.RtcEngine
-
Update token of the preloaded channels.
- 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
-
Update the video layout and audio settings for CDN live.
- updateRtmpTranscodingEx(LiveTranscoding, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
-
Update the video layout and audio settings for CDN live.
- updateScreenCaptureParameters(ScreenCaptureParameters) - Method in class io.agora.rtc2.RtcEngine
-
Updates the screen sharing configuration.
- 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
- uplinkMultipathMode - Variable in class io.agora.rtc2.ChannelMediaOptions
-
The mode for uplink multipath transmission.
- UplinkNetworkInfo() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.UplinkNetworkInfo
- uplinkReport - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LastmileProbeResult
-
The uplink last-mile network report.
- uploadLogFile() - Method in class io.agora.rtc2.RtcEngine
-
Upload current log file immediately to server.
- url - Variable in class io.agora.rtc2.video.AgoraImage
-
HTTP/HTTPS URL address of the image on the 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
-
The 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
getUserCountmethod. - 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
- 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
-
Certificate domain name installed on specific local access point.
- 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
- 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 encoder target bitrate bps.
- VIDEO_FRAME - Enum constant in enum class io.agora.rtc2.Constants.ExternalVideoSourceType
-
0: non-encoded video frame.
- 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
-
The position after capturing the video data and pre-processing.
- VIDEO_MODULE_POSITION_POST_CAPTURER_ORIGIN - Enum constant in enum class io.agora.rtc2.Constants.VideoModulePosition
-
The position after capturing the video data and before pre-processing.
- VIDEO_MODULE_POSITION_PRE_ENCODER - Enum constant in enum class io.agora.rtc2.Constants.VideoModulePosition
-
The position before encoding the video data.
- VIDEO_MODULE_POSITION_PRE_RENDERER - Enum constant in enum class io.agora.rtc2.Constants.VideoModulePosition
-
The position before receiving the remote video data.
- 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.video.
- 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
-
Video captured by the fourth camera.
- VIDEO_SOURCE_CAMERA_PRIMARY - Enum constant in enum class io.agora.rtc2.Constants.VideoSourceType
-
Video captured by the 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
-
Video captured by 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
-
Video captured by the third camera.
- VIDEO_SOURCE_CUSTOM - Enum constant in enum class io.agora.rtc2.Constants.VideoSourceType
-
Video for external video frame
- 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
-
Video for media player sharing.
- 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
-
Remote video received from 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
-
Video for png 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
-
Video for png 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
-
Video for 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
-
Video for screen sharing.
- 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
-
Video for secondary screen sharing.
- 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
-
Video for voice drive.
- VIDEO_SOURCE_TRANSCODED - Enum constant in enum class io.agora.rtc2.Constants.VideoSourceType
-
Video for transcoded.
- 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
-
Not define.
- 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: The high-quality video stream, which has a 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: The video stream of layer_1, which has a lower resolution and bitrate than VIDEO_STREAM_HIGH.
- VIDEO_STREAM_LAYER_2 - Enum constant in enum class io.agora.rtc2.Constants.VideoStreamType
-
5: The video stream of layer_2, which has a lower resolution and bitrate than VIDEO_STREAM_LAYER_1.
- VIDEO_STREAM_LAYER_3 - Enum constant in enum class io.agora.rtc2.Constants.VideoStreamType
-
6: The video stream of layer_3, which has a lower resolution and bitrate than VIDEO_STREAM_LAYER_2.
- VIDEO_STREAM_LAYER_4 - Enum constant in enum class io.agora.rtc2.Constants.VideoStreamType
-
7: The video stream of layer_4, which has a lower resolution and bitrate than VIDEO_STREAM_LAYER_3.
- VIDEO_STREAM_LAYER_5 - Enum constant in enum class io.agora.rtc2.Constants.VideoStreamType
-
8: The video stream of layer_5, which has a lower resolution and bitrate than VIDEO_STREAM_LAYER_4.
- VIDEO_STREAM_LAYER_6 - Enum constant in enum class io.agora.rtc2.Constants.VideoStreamType
-
9: The video stream of layer_6, which has a lower resolution and bitrate than VIDEO_STREAM_LAYER_5.
- VIDEO_STREAM_LOW - Enum constant in enum class io.agora.rtc2.Constants.VideoStreamType
-
1: The low-quality video stream, which has a 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.Real-time bit rate of the video streamed by rtmp.
- videoBitrate - Variable in class io.agora.rtc2.live.LiveInjectStreamConfig
- videoBitrate - Variable in class io.agora.rtc2.live.LiveTranscoding
-
The bitrate (Kbps) of the video.
- VideoCanvas - Class in io.agora.rtc2.video
-
The VideoCanvas class.
- 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:
VideoCodecProfileType. - videoCodecType - Variable in class io.agora.rtc2.live.LiveTranscoding
-
The video codec type of the output video stream.
- 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
-
The video noise reduction options.
- 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
-
The video encoder configuration.
- 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
-
The video advanceoptions.
- 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
-
Video COMPRESSION PREFERENCE.
- VideoEncoderConfiguration.DEGRADATION_PREFERENCE - Enum Class in io.agora.rtc2.video
-
The video encoding degradation preference under limited bandwidth.
- VideoEncoderConfiguration.ENCODING_PREFERENCE - Enum Class in io.agora.rtc2.video
-
The Video encoder type preference.
- VideoEncoderConfiguration.FRAME_RATE - Enum Class in io.agora.rtc2.video
-
The frame rate of the 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
-
The video orientation mode of the video.
- VideoEncoderConfiguration.VIDEO_CODEC_TYPE - Enum Class in io.agora.rtc2.video
-
Video code types.
- VideoEncoderConfiguration.VideoDimensions - Class in io.agora.rtc2.video
-
The video dimensions.
- videoFramerate - Variable in class io.agora.rtc2.live.LiveInjectStreamConfig
- videoFramerate - Variable in class io.agora.rtc2.live.LiveTranscoding
-
The frame rate (fps) of the video.
- videoGop - Variable in class io.agora.rtc2.live.LiveInjectStreamConfig
- videoGop - Variable in class io.agora.rtc2.live.LiveTranscoding
-
Gop of the video frames in the CDN live stream.
- videoHeight - Variable in class io.agora.mediaplayer.data.PlayerUpdatedInfo
-
Video height.
- videoHeight - Variable in class io.agora.rtc2.DirectCdnStreamingStats
-
Deprecated.Height of the video pushed by rtmp.
- 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 video mixing on the local client.
- 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 video source just for out channel recoder
- videoState - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayout
-
video state of video stream on a transcoded video stream 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
-
Video width.
- videoWidth - Variable in class io.agora.rtc2.DirectCdnStreamingStats
-
Deprecated.Width of the video pushed by rtmp.
- view - Variable in class io.agora.rtc2.EchoTestConfiguration
-
The view for remote render.
- view - Variable in class io.agora.rtc2.video.VideoCanvas
-
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
-
Background substitude meta data.
- 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
-
Sets whether or not the watermark image is visible in the local video preview: - true: (Default) The watermark image is visible in preview.
- VOICE_AI_TUNER_DREAMY_FEMALE_SINGING - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
-
Dreamy female singing, dreamlike and soft female voice that is suitable for airy and dream-like songs.
- VOICE_AI_TUNER_ELEGANT_FEMALE - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
-
Big sister, deep and charming female voice.
- VOICE_AI_TUNER_FRESH_MALE - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
-
Fresh male, refreshing and sweet male voice.
- VOICE_AI_TUNER_GENTLE_FEMALE_SINGING - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
-
Gentle female singing, soft and delicate female voice that is suitable for female lyrical songs.
- VOICE_AI_TUNER_HUSKY_MALE_SINGING - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
-
Smoky uncle singing, unique husky male voice that is suitable for rock or blues songs.
- VOICE_AI_TUNER_MATURE_MALE - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
-
Uncle, deep and magnetic male voice.
- VOICE_AI_TUNER_POWERFUL_MALE_SINGING - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
-
Forceful male singing, strong and powerful male voice that is suitable for passionate songs.
- VOICE_AI_TUNER_SWEET_FEMALE - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
-
Lolita, high-pitched and cute female voice.
- VOICE_AI_TUNER_WARM_ELEGANT_FEMALE_SINGING - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
-
Warm big sister singing, warm and mature female voice that is suitable for emotionally powerful songs.
- VOICE_AI_TUNER_WARM_MALE_SINGING - Enum constant in enum class io.agora.rtc2.Constants.VOICE_AI_TUNER_TYPE
-
Warm man singing, warm and melodic male voice that is suitable for male lyrical songs.
- 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
-
Voice pitch frequency in Hz
- volume - Variable in class io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo
-
The volume of the speaker that ranges from 0 (lowest volume) to 255 (highest volume).
- 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 that the watermark is provided as a buffer.
- WATERMARK_TYPE_IMAGE - Static variable in class io.agora.rtc2.video.WatermarkConfig
-
Specifies that the watermark is an 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
-
The video width
- 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
-
Width (pixels) of the video stream.
- width - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayout
-
width of video stream on a transcoded video stream canvas.
- width - Variable in class io.agora.rtc2.IRtcEngineEventHandler.VideoLayoutInfo
-
width of transcoded video stream.
- width - Variable in class io.agora.rtc2.live.LiveInjectStreamConfig
- width - Variable in class io.agora.rtc2.live.LiveTranscoding.TranscodingUser
-
Width of the video frame of the user on the CDN live streaming.
- 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 the video mixing on the local client.
- width - Variable in class io.agora.rtc2.PublisherParameters
-
Deprecated.
- width - Variable in class io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters
-
The width of the video encoding resolution.
- width - Variable in class io.agora.rtc2.video.AgoraImage
-
Width of the image on the video.
- width - Variable in class io.agora.rtc2.video.CameraCapturerConfiguration.CaptureFormat
-
The width (px) of the video image captured by the local camera.
- width - Variable in class io.agora.rtc2.video.EncodedVideoFrameInfo
-
The width of this 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 of the video.
- width - Variable in class io.agora.rtc2.video.WatermarkBuffer
-
The width of the watermark buffer in pixels.
- width - Variable in class io.agora.rtc2.video.WatermarkOptions.Rectangle
-
The width of the watermark image, in pixels.
- 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
-
Total bytes received over WiFi.
- wifiTxBytes - Variable in class io.agora.rtc2.IRtcEngineEventHandler.MultipathStats
-
Total bytes transmitted over WiFi.
- 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 of video stream on a transcoded video stream canvas.
- x - Variable in class io.agora.rtc2.live.LiveTranscoding.TranscodingUser
-
Horizontal position of the video frame of the user from the top left corner of the CDN live streaming.
- x - Variable in class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
-
The horizontal displacement of the top-left corner of the video for the video mixing on the client relative to the top-left corner (origin) of the canvas for this video mixing.
- x - Variable in class io.agora.rtc2.video.AgoraImage
-
Position of the image on the upper left of the video on the horizontal axis.
- x - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Region
-
Deprecated.
- x - Variable in class io.agora.rtc2.video.WatermarkOptions.Rectangle
-
The horizontal position of the watermark's top-left corner, in pixels.
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 of video stream on a transcoded video stream canvas.
- y - Variable in class io.agora.rtc2.live.LiveTranscoding.TranscodingUser
-
Vertical position of the video frame of the user from the top left corner of the CDN live streaming.
- y - Variable in class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
-
The vertical displacement of the top-left corner of the video for the video mixing on the client relative to the top-left corner (origin) of the canvas for this video mixing.
- y - Variable in class io.agora.rtc2.video.AgoraImage
-
Position of the image on the upper left of the video on the vertical axis.
- y - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Region
-
Deprecated.
- y - Variable in class io.agora.rtc2.video.WatermarkOptions.Rectangle
-
The vertical position of the watermark's top-left corner, in pixels.
Z
- zoneSetId - Variable in class io.agora.spatialaudio.SpatialAudioZone
- zOrder - Variable in class io.agora.rtc2.live.LiveTranscoding.TranscodingUser
-
The layer index of the video frame.
- zOrder - Variable in class io.agora.rtc2.LocalTranscoderConfiguration.TranscodingVideoStream
-
The number of the layer to which the video for the video mixing on the local client belongs.
- zOrder - Variable in class io.agora.rtc2.video.AgoraImage
-
layer of image
- zOrder - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Region
-
Deprecated.
- zOrder - Variable in class io.agora.rtc2.video.WatermarkOptions
- zOrder(int) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Region
-
Deprecated.
All Classes and Interfaces|All Packages|Constant Field Values
addVideoWatermark2 method instead. This method adds a PNG watermark image to the local video stream for the sampling device, channel audience, or CDN live audience to see and capture. To add the PNG file to a CDN live publishing stream, see thesetLiveTranscodingmethod.