Skip navigation links
A B C D E F G H I J L M N O P Q R S T U V W X Y Z 

A

addBackgroundImage(AgoraImage) - Method in class io.agora.rtc2.live.LiveTranscoding
add background image to backgroundImageList
addEventHandler(ICloudSpatialAudioEventHandler) - Method in class io.agora.spatialaudio.ICloudSpatialAudioEngine
 
addExtension(String) - Method in class io.agora.rtc2.RtcEngineConfig
 
addHandler(IRtcEngineEventHandler) - Method in class io.agora.rtc2.RtcEngine
Adds the IRtcEngineEventHandler.
addUser(LiveTranscoding.TranscodingUser) - Method in class io.agora.rtc2.live.LiveTranscoding
Adds a user displaying the video in CDN live.
addVideoWatermark(AgoraImage) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
From v2.9.1. We recommend using the addVideoWatermark2 method instead. 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 the setLiveTranscoding method.
addVideoWatermark(String, WatermarkOptions) - Method in class io.agora.rtc2.RtcEngine
Adds a watermark image to the local video.
addVideoWatermarkEx(String, WatermarkOptions, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Adds a watermark image to the local video.
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.
adjustUserPlaybackSignalVolume(int, int) - Method in class io.agora.rtc2.RtcEngine
Adjust the playback volume of the user specified by uid.
AdvancedAudioOptions - Class in io.agora.rtc2.audio
 
AdvancedAudioOptions(AdvancedAudioOptions.AudioProcessingChannelsEnum) - Constructor for class io.agora.rtc2.audio.AdvancedAudioOptions
 
AdvancedAudioOptions() - Constructor for class io.agora.rtc2.audio.AdvancedAudioOptions
 
AdvancedAudioOptions.AudioProcessingChannelsEnum - Enum in io.agora.rtc2.audio
 
AgoraFacePositionInfo() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.AgoraFacePositionInfo
 
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.MediaRecorderConfiguration - Class in io.agora.rtc2
Configurations for the local audio and video recording.
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
 
allocate(int, int) - Static method in class io.agora.base.JavaI420Buffer
Allocates an empty I420Buffer suitable for an image of the given dimensions.
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.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.
 
appData - Variable in class io.agora.rtc2.video.VideoCompositingLayout
Deprecated.
 
appData - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Builder
Deprecated.
 
applyNewI420Handler(Handler, YuvConverter) - Method in class io.agora.base.TextureBuffer
Create a new TextureBuffer with an applied transform toI420Handler and a new yuvConverter.
applyTransformMatrix(Matrix, int, int) - Method in class io.agora.base.TextureBuffer
Create a new TextureBuffer with an applied transform matrix and a new size.
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
 
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_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_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_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_REASON_ALL_LOOPS_COMPLETED - Static variable in class io.agora.rtc2.Constants
716: 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
715: The audio mixing file is played once.
AUDIO_MIXING_REASON_STOPPED_BY_USER - Static variable in class io.agora.rtc2.Constants
716: 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_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_RANGE_MODE_TEAM - Static variable in class io.agora.spatialaudio.ICloudSpatialAudioEngine.AudioRangeMode
 
AUDIO_RANGE_MODE_WORLD - Static variable in class io.agora.spatialaudio.ICloudSpatialAudioEngine.AudioRangeMode
 
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_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_HEADSET - Static variable in class io.agora.rtc2.Constants
0: Headset.
AUDIO_ROUTE_HEADSETBLUETOOTH - Static variable in class io.agora.rtc2.Constants
5: Bluetooth 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_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.
audioAttenuation - Variable in class io.agora.spatialaudio.SpatialAudioZone
 
audioBitrate - Variable in class io.agora.rtc2.DirectCdnStreamingStats
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.
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.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
 
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
 
audioProcessingChannels - Variable in class io.agora.rtc2.audio.AdvancedAudioOptions
 
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
 
AudioVolumeInfo() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo
 
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: Background source is hex color string.
BACKGROUND_IMG - Static variable in class io.agora.rtc2.video.VirtualBackgroundSource
2: Background source is image path, only support png format.
backgroundColor - Variable in class io.agora.rtc2.live.LiveTranscoding
Deprecated.
This parameter is deprecated. We recommend using the setBackgroundColor method to set the background color.
backgroundColor - Variable in class io.agora.rtc2.video.VideoCompositingLayout
Deprecated.
 
backgroundImage - Variable in class io.agora.rtc2.live.LiveTranscoding
Deprecated.
Deprecated from v4.0.0. Use addBackgroundImage instead.
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.
 
bandwidth_estimation_bps - Variable in class io.agora.rtc2.IRtcEngineEventHandler.DownlinkNetworkInfo
The bandwidth estimation bitrate in bps.
beatsPerMeasure - Variable in class io.agora.rtc2.audio.AgoraRhythmPlayerConfig
The number of beats per measure.
beatsPerMinute - Variable in class io.agora.rtc2.audio.AgoraRhythmPlayerConfig
 
BeautyOptions - Class in io.agora.rtc2.video
Sets the image enhancement options.
BeautyOptions(int, float, float, float, float) - Constructor for class io.agora.rtc2.video.BeautyOptions
The image enhancement options.
BeautyOptions() - Constructor for class io.agora.rtc2.video.BeautyOptions
 
bgColor - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Canvas
Deprecated.
 
bitRate(int) - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
Sets the stream's bitrate.
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).
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_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
 
cacheStatistics - Variable in class io.agora.mediaplayer.data.PlayerUpdatedInfo
 
CAMERA - Static variable in class io.agora.rtc2.Constants
 
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.CaptureFormat) - Constructor for class io.agora.rtc2.video.CameraCapturerConfiguration
The camera capture configuration.
CameraCapturerConfiguration(CameraCapturerConfiguration.CAMERA_DIRECTION, CameraCapturerConfiguration.CaptureFormat) - Constructor for class io.agora.rtc2.video.CameraCapturerConfiguration
The camera capture configuration.
CameraCapturerConfiguration.CAMERA_DIRECTION - Enum in io.agora.rtc2.video
Sets the camera direction.
CameraCapturerConfiguration.CaptureFormat - Class in io.agora.rtc2.video
 
cameraDirection - Variable in class io.agora.rtc2.video.CameraCapturerConfiguration
The camera direction.
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(int, int, int) - Constructor for class io.agora.rtc2.video.CameraCapturerConfiguration.CaptureFormat
 
CaptureFormat() - 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_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.RtcConnection
The unique channel name for the AgoraRTC session in the string format.
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.
clearRemotePositions() - Method in class io.agora.spatialaudio.ILocalSpatialAudioEngine
 
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.
CloudSpatialAudioConfig - Class in io.agora.spatialaudio
 
CloudSpatialAudioConfig() - Constructor for class io.agora.spatialaudio.CloudSpatialAudioConfig
 
CloudSpatialAudioConfig.SaeDeployRegion - Class in io.agora.spatialaudio
Regions for connection
CodecCapInfo - Class in io.agora.rtc2.video
 
CodecCapInfo(int, int) - Constructor for class io.agora.rtc2.video.CodecCapInfo
 
codecCapMask - Variable in class io.agora.rtc2.video.CodecCapInfo
The codec type mask.
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.
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.
configRhythmPlayer(AgoraRhythmPlayerConfig) - Method in class io.agora.rtc2.RtcEngine
Configures the rhythm player.
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_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_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 - 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 - Static variable in class io.agora.rtc2.Constants
2: The SDK is connecting to Agora 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 - Static variable in class io.agora.rtc2.Constants
5: The SDK fails to connect to Agora edge server or join the channel.
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() - Constructor for class io.agora.mediaplayer.Constants
 
Constants - Class in io.agora.rtc2
Rating of the media or network quality.
Constants() - Constructor for class io.agora.rtc2.Constants
 
Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY - Enum in io.agora.rtc2
The audio equalization band frequency.
Constants.AUDIO_REVERB_TYPE - Enum in io.agora.rtc2
 
Constants.AudioDualMonoMode - Enum in io.agora.mediaplayer
 
Constants.AudioMixingDualMonoMode - Enum in io.agora.rtc2
The audio mixing dual-mono output mode.
Constants.AudioProfile - Enum in io.agora.rtc2
Sets the audio profile sampling rate, bitrate, encode mode, and the number of channels.
Constants.AudioScenario - Enum in io.agora.rtc2
Sets the audio application scenarios.
Constants.ExternalVideoSourceType - Enum in io.agora.rtc2
External video source types definition.
Constants.LogLevel - Enum in io.agora.rtc2
Log Level.
Constants.MediaPlayerError - Enum in io.agora.mediaplayer
 
Constants.MediaPlayerEvent - Enum in io.agora.mediaplayer
 
Constants.MediaPlayerMetadataType - Enum in io.agora.mediaplayer
 
Constants.MediaPlayerPreloadEvent - Enum in io.agora.mediaplayer
 
Constants.MediaPlayerState - Enum in io.agora.mediaplayer
Media type.
Constants.MediaSourceType - Enum in io.agora.rtc2
The type of media device.
Constants.MediaStreamType - Enum in io.agora.mediaplayer
 
Constants.MediaType - Enum in io.agora.rtc2
Media type.
Constants.SimulcastStreamMode - Enum in io.agora.rtc2
The dual stream mode
Constants.ThreadPriorityType - Enum in io.agora.rtc2
Thread priority type.
Constants.VideoSourceType - Enum in io.agora.rtc2
Video source types definition.
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_INVALID - Static variable in class io.agora.rtc2.video.ContentInspectConfig
 
CONTENT_INSPECT_TYPE_MODERATION - Static variable in class io.agora.rtc2.video.ContentInspectConfig
 
CONTENT_INSPECT_TYPE_SUPERVISE - Static variable in class io.agora.rtc2.video.ContentInspectConfig
 
contentHint - Variable in class io.agora.rtc2.ScreenCaptureParameters.VideoCaptureParameters
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
 
convertToRGBA(TextureBuffer, int) - Method in class io.agora.base.TextureBufferHelper
This can only be called from the |handler| thread.
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(String, EglBase.Context) - Static method in class io.agora.base.TextureBufferHelper
Construct a new TextureBufferHelper sharing OpenGL resources with |sharedContext|.
create() - Static method in class io.agora.mediaplayer.gl.PlayerTextureHelper
Construct a new SurfaceTextureHelperTest sharing OpenGL resources with |sharedContext|.
create(Context, String, IRtcEngineEventHandler) - Static method in class io.agora.rtc2.RtcEngine
Creates an RtcEngine instance.
create(RtcEngineConfig) - Static method in class io.agora.rtc2.RtcEngine
Creates an RtcEngine instance.
create() - Method in class io.agora.rtc2.video.VideoCompositingLayout.Builder
Deprecated.
 
create() - Static method in class io.agora.spatialaudio.ICloudSpatialAudioEngine
 
create() - Static method in class io.agora.spatialaudio.ILocalSpatialAudioEngine
 
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
CreateRendererView(Context) - Static method in class io.agora.rtc2.RtcEngine
Deprecated.
This method is deprecated. You can use SurfaceView or TextureView created by Android system.

It returns the SurfaceView type. The operation and layout of the view are managed by the application, and the Agora SDK renders the view provided by the application. The view to display videos must be created using this method instead of directly calling SurfaceView.

CreateTextureView(Context) - Static method in class io.agora.rtc2.RtcEngine
Deprecated.
This method is deprecated. You can use SurfaceView or TextureView created by Android system.

It returns the TextureView type. The operation and layout of the view are managed by the application, and the Agora SDK renders the view provided by the application. The view to display videos must be created using this method instead of directly calling TextureView.

cropAndScale(int, int, int, int, int, int) - Method in class io.agora.base.JavaI420Buffer
 
cropAndScale(int, int, int, int, int, int) - Method in class io.agora.base.NV12Buffer
 
cropAndScale(int, int, int, int, int, int) - Method in class io.agora.base.NV21Buffer
 
cropAndScale(int, int, int, int, int, int) - Method in class io.agora.base.TextureBuffer
 
cropAndScale(int, int, int, int, int, int) - Method in interface io.agora.base.VideoFrame.Buffer
Crops a region defined by |cropx|, |cropY|, |cropWidth| and |cropHeight|.
cropAndScaleI420(VideoFrame.I420Buffer, int, int, int, int, int, int) - Static method in class io.agora.base.JavaI420Buffer
Crops a region defined by |cropx|, |cropY|, |cropWidth| and |cropHeight|.
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.
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
The custom video track id which will used to publish.

D

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.
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(int) - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
Sets the default layout.
defaultLayout - Variable in class io.agora.rtc2.PublisherParameters
Deprecated.
 
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
Releases all the resources used by the Agora SDK.
destroy() - Static method in class io.agora.spatialaudio.ICloudSpatialAudioEngine
 
destroy() - Static method in class io.agora.spatialaudio.ILocalSpatialAudioEngine
 
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
DeviceInfo - Class in io.agora.rtc2
 
DeviceInfo(boolean) - Constructor for class io.agora.rtc2.DeviceInfo
 
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.
DirectCdnStreamingError - Enum in io.agora.rtc2
Direct Cdn Streaming Error Code.
DirectCdnStreamingMediaOptions - Class in io.agora.rtc2
The channel media options.
DirectCdnStreamingMediaOptions() - Constructor for class io.agora.rtc2.DirectCdnStreamingMediaOptions
 
DirectCdnStreamingState - Enum in io.agora.rtc2
Direct Cdn Streaming State.
DirectCdnStreamingStats - Class in io.agora.rtc2
Direct Cdn Streaming State.
DirectCdnStreamingStats() - Constructor for class io.agora.rtc2.DirectCdnStreamingStats
 
DirectCdnStreamingStats(int, int, int, int, int) - Constructor for class io.agora.rtc2.DirectCdnStreamingStats
 
disableAudio() - Method in class io.agora.rtc2.RtcEngine
Disables the audio.
disableAudioSpectrumMonitor() - Method in class io.agora.rtc2.RtcEngine
Disalbe the audio spectrum monitor.
disableVideo() - Method in class io.agora.rtc2.RtcEngine
Disables the video.
dispose() - Method in class io.agora.base.TextureBufferHelper
Call dispose() to stop receiving frames.
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.
 
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.RemoteVideoStats
End-to-end delay from video capturer to video renderer.
e2eDelayPercent - Variable in class io.agora.rtc2.IRtcEngineEventHandler.WlAccStats
End-to-end delay optimization percentage.
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.
EchoTestConfiguration - Class in io.agora.rtc2
 
EchoTestConfiguration(SurfaceView, boolean, boolean, String, String) - Constructor for class io.agora.rtc2.EchoTestConfiguration
 
EchoTestConfiguration() - 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.
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.
enableAgoraSource(boolean) - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
enableAudio - Variable in class io.agora.rtc2.EchoTestConfiguration
Whether to enable audio.
enableAudio() - Method in class io.agora.rtc2.RtcEngine
Enables the audio.
enableAudioQualityIndication(boolean) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
From v2.4.1.

The onAudioQuality callback triggers periodically after this callback is enabled.

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
Enable automatic CDN line switching.
enableBuiltInMediaEncryption - Variable in class io.agora.rtc2.ChannelMediaOptions
Enable media packet encryption.
enableContentInspect(boolean, ContentInspectConfig) - Method in class io.agora.rtc2.RtcEngine
 
enableCustomAudioLocalPlayback(int, boolean) - Method in class io.agora.rtc2.RtcEngine
Sets the external audio source.
enableDualStreamMode(boolean) - Method in class io.agora.rtc2.RtcEngine
Enables or disables the dual video stream mode.
enableDualStreamMode(boolean, SimulcastStreamConfig) - Method in class io.agora.rtc2.RtcEngine
Enables or disables the dual video stream mode.
enableDualStreamModeEx(boolean, SimulcastStreamConfig, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Enables or disables the dual video stream mode.
enableEchoCancellationExternal(boolean, int) - Method in class io.agora.rtc2.RtcEngine
 
enableEncryption(boolean, EncryptionConfig) - Method in class io.agora.rtc2.RtcEngine
Enables/Disables the built-in encryption.
enableExtension(String, String, boolean) - Method in class io.agora.rtc2.RtcEngine
 
enableExtension(String, String, boolean, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
 
enableExtension(String, String, ExtensionInfo, boolean) - Method in class io.agora.rtc2.RtcEngine
Enable/Disable 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.
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.
enableLocalVideo(boolean) - Method in class io.agora.rtc2.RtcEngine
Disables or re-enables the local video capture.
enableRecap(int) - Method in class io.agora.rtc2.RtcEngineInternal
 
enableRemoteSuperResolution(int, boolean) - Method in class io.agora.rtc2.RtcEngine
Enables/Disables the super resolution feature for a remote user's video.
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
 
enableSpatializer(boolean, boolean) - Method in class io.agora.spatialaudio.ICloudSpatialAudioEngine
 
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.
enableWebSdkInteroperability(boolean) - Method in class io.agora.rtc2.RtcEngine
Enables interoperability with the Agora Web SDK (Live Broadcast only).
enableWirelessAccelerate(boolean) - Method in class io.agora.rtc2.RtcEngine
Turn WIFI acceleration on or off.
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.
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, 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.
ENCRYPTION_ERROR_DECRYPTION_FAILURE - Static variable in class io.agora.rtc2.Constants
 
ENCRYPTION_ERROR_ENCRYPTION_FAILURE - Static variable in class io.agora.rtc2.Constants
 
ENCRYPTION_ERROR_INTERNAL_FAILURE - Static variable in class io.agora.rtc2.Constants
Error type of encryption.
enterRoom(String, String, int) - Method in class io.agora.spatialaudio.ICloudSpatialAudioEngine
 
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_DECRYPTION_FAILED - Static variable in class io.agora.rtc2.Constants
Failed to decrypt.
ERR_DECRYPTION_FAILED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
120: Decryption fails.
ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH - Static variable in class io.agora.rtc2.Constants
Encryption is enabled when the user calls the addPublishStreamUrl method (CDN live streaming does not support encrypted streams).
ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
130: Encryption is enabled when the user calls the addPublishStreamUrl method (CDN live streaming does not support encrypted streams).
ERR_FAILED - Static variable in class io.agora.rtc2.Constants
A general error occurs (no specified reason).
ERR_FAILED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
1: A general error occurs (no specified reason).
ERR_INIT_NET_ENGINE - Static variable in class io.agora.rtc2.Constants
On Windows, specific firewall settings can cause the SDK to fail to initialize and crash.
ERR_INIT_NET_ENGINE - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
21: On Windows, specific firewall settings can cause the SDK to fail to initialize and crash.
ERR_INVALID_APP_ID - Static variable in class io.agora.rtc2.Constants
The specified App ID is invalid.
ERR_INVALID_APP_ID - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
101: The specified App ID is invalid.
ERR_INVALID_ARGUMENT - Static variable in class io.agora.rtc2.Constants
An invalid parameter is used.
ERR_INVALID_ARGUMENT - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
2: An invalid parameter is used.
ERR_INVALID_CHANNEL_NAME - Static variable in class io.agora.rtc2.Constants
The specified channel name is invalid.
ERR_INVALID_CHANNEL_NAME - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
102: The specified channel name is invalid.
ERR_INVALID_STATE - Static variable in class io.agora.rtc2.Constants
The state is invalid.
ERR_INVALID_TOKEN - Static variable in class io.agora.rtc2.Constants
The Token is invalid due to one of the following reasons: The App Certificate for the project is enabled on the Dashboard, but the user is still using the App ID.
ERR_INVALID_TOKEN - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
110: The token is invalid due to one of the following reasons: - The App Certificate for the project is enabled in Console, but the user is still using the App ID.
ERR_INVALID_USER_ACCOUNT - Static variable in class io.agora.rtc2.Constants
The user account is invalid, usually because the data format of the user account is incorrect.
ERR_INVALID_USER_ACCOUNT - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
134: The user account is invalid, usually because the data format of the user account is incorrect.
ERR_INVALID_USER_ID - Static variable in class io.agora.rtc2.Constants
The user ID is invalid.
ERR_INVALID_USER_ID - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
121: The user ID is invalid.
ERR_JOIN_CHANNEL_REJECTED - Static variable in class io.agora.rtc2.Constants
The request to join the channel is rejected.
ERR_JOIN_CHANNEL_REJECTED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
17: The request to join the channel is rejected.
ERR_LEAVE_CHANNEL_REJECTED - Static variable in class io.agora.rtc2.Constants
The request to leave the channel is rejected.
ERR_LEAVE_CHANNEL_REJECTED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
18: The request to leave the channel is rejected.
ERR_LICENSE_CREDENTIAL_INVALID - Static variable in class io.agora.rtc2.Constants
License credential is invalid
ERR_LICENSE_CREDENTIAL_INVALID - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
131: License credential is invalid
ERR_LOAD_MEDIA_ENGINE - Static variable in class io.agora.rtc2.Constants
Failed to load the media engine.
ERR_LOAD_MEDIA_ENGINE - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
1001: Fails to load the media engine.
ERR_MODULE_NOT_FOUND - Static variable in class io.agora.rtc2.Constants
The extension library is not integrated, such as the library for enabling deep-learning noise reduction.
ERR_MODULE_NOT_FOUND - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
157: The extension library is not integrated, such as the library for enabling deep-learning noise reduction.
ERR_NET_DOWN - Static variable in class io.agora.rtc2.Constants
The network is unavailable.
ERR_NET_DOWN - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
14: The network is unavailable.
ERR_NO_PERMISSION - Static variable in class io.agora.rtc2.Constants
No permission.
ERR_NO_PERMISSION - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
9: No permission.
ERR_NO_SERVER_RESOURCES - Static variable in class io.agora.rtc2.Constants
Fails to get server resources in the specified region.
ERR_NO_SERVER_RESOURCES - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
103: Fails to get server resources in the specified region.
ERR_NOT_IN_CHANNEL - Static variable in class io.agora.rtc2.Constants
The user is not in the channel.
ERR_NOT_IN_CHANNEL - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
113: The user is not in the channel.
ERR_NOT_INITIALIZED - Static variable in class io.agora.rtc2.Constants
The SDK is not initialized before calling this API.
ERR_NOT_INITIALIZED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
7: The SDK is not initialized before calling this API.
ERR_NOT_READY - Static variable in class io.agora.rtc2.Constants
The SDK module is not ready.
ERR_NOT_READY - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
3: The SDK module is not ready.
ERR_NOT_SUPPORTED - Static variable in class io.agora.rtc2.Constants
The SDK does not support this function.
ERR_NOT_SUPPORTED - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
4: The SDK does not support this function.
ERR_OK - Static variable in class io.agora.rtc2.Constants
No error occurs.
ERR_OK - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.ErrorCode
0: No error occurs.
ERR_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.
 
exitRoom() - Method in class io.agora.spatialaudio.ICloudSpatialAudioEngine
 
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.
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
 
extraInfo(String) - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
Adds extra information.
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.

F

FaceDetectionInfo - Class in io.agora.base
 
FaceDetectionInfo(int, Rect, double) - Constructor for class io.agora.base.FaceDetectionInfo
 
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.
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.
followEncodeDimensionRatio - Variable in class io.agora.rtc2.video.CameraCapturerConfiguration
follow the dimension ratio of setVideoEncoderConfiguration.
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_2D 11: OES, typically from the camera 1: I420 3: NV21 4: RGBA
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.DirectCdnStreamingStats
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.
frameLossRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
The video frame loss rate (%) of the remote video stream in the reported interval.
frameRate(int) - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
Sets the stream's frame rate.
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.SimulcastStreamConfig
The video framerate.
frameRate - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
The video frame rate (fps).
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 io.agora.rtc2.Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY
 
fromInt(int) - Static method in enum io.agora.rtc2.Constants.AUDIO_REVERB_TYPE
 
fromInt(int) - Static method in enum io.agora.rtc2.Constants.VideoSourceType
 
fromInt(int) - Static method in enum io.agora.rtc2.DirectCdnStreamingError
 
fromInt(int) - Static method in enum io.agora.rtc2.DirectCdnStreamingState
 
fromNativeIndex(int) - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerError
 
fromNativeIndex(int) - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerEvent
 
fromNativeIndex(int) - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerMetadataType
 
fromNativeIndex(int) - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerPreloadEvent
 
fromNativeIndex(int) - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerState
 
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.
frozenRatioPercent - Variable in class io.agora.rtc2.IRtcEngineEventHandler.WlAccStats
Frozen Ratio optimization percentage.

G

gatewayRtt - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
gateway Rtt
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
Gets the number of Agora CDN lines.
getAirAbsorbFlag() - Method in class io.agora.rtc2.SpatialAudioParams
get air absorb enabled flag
getAlphaBuffer() - Method in class io.agora.base.VideoFrame
 
getAppId() - Method in class io.agora.rtc2.RtcEngineConfig
 
getAppId() - Method in class io.agora.spatialaudio.CloudSpatialAudioConfig
 
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
 
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.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.
getAudioOptionParams() - Method in class io.agora.rtc2.RtcEngine
 
getAudioSampleRate() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
getAudioScenario() - Method in class io.agora.rtc2.RtcEngineConfig
 
getAudioSessionParams() - Method in class io.agora.rtc2.RtcEngine
 
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.
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
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.base.VideoFrame
 
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
 
getCacheStatistics() - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
 
getCallId() - Method in class io.agora.rtc2.RtcEngine
Gets the current call ID.
getCameraDirection() - 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
 
getColorSpace() - Method in class io.agora.base.VideoFrame
 
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
 
getCurrentAgoraCDNIndex() - Method in interface io.agora.mediaplayer.IMediaPlayer
Gets the line of the current CDN.
getCurrentMonotonicTimeInMs() - Method in class io.agora.rtc2.RtcEngine
 
getCustomMetaInfo(String) - Method in class io.agora.base.VideoFrameMetaInfo
 
getCustomMetaInfoAt(String, int) - Method in class io.agora.base.VideoFrameMetaInfo
 
getCustomMetaInfoSize(String) - Method in class io.agora.base.VideoFrameMetaInfo
 
getCustomVideoTrackId() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getCustomVideoTrackId() - Method in class io.agora.rtc2.DirectCdnStreamingMediaOptions
 
getData() - Method in interface io.agora.base.VideoFrame.RgbaBuffer
 
getDataLength() - Method in class io.agora.rtc2.audio.AudioSpectrumInfo
 
getDataU() - Method in class io.agora.base.JavaI420Buffer
 
getDataU() - Method in interface io.agora.base.VideoFrame.I420Buffer
Returns a direct ByteBuffer containing U-plane data.
getDataU() - Method in interface io.agora.base.VideoFrame.I422Buffer
 
getDataV() - Method in class io.agora.base.JavaI420Buffer
 
getDataV() - Method in interface io.agora.base.VideoFrame.I420Buffer
Returns a direct ByteBuffer containing V-plane data.
getDataV() - Method in interface io.agora.base.VideoFrame.I422Buffer
 
getDataY() - Method in class io.agora.base.JavaI420Buffer
 
getDataY() - Method in interface io.agora.base.VideoFrame.I420Buffer
Returns a direct ByteBuffer containing Y-plane data.
getDataY() - Method in interface io.agora.base.VideoFrame.I422Buffer
 
getDefaultVideoStreamType() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getDeployRegion() - Method in class io.agora.spatialaudio.CloudSpatialAudioConfig
 
getDepth() - Method in class io.agora.base.FaceDetectionInfo
 
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.SimulcastStreamConfig
 
getDimensionsWidth() - Method in class io.agora.rtc2.SimulcastStreamConfig
 
getDomainLimit() - Method in class io.agora.rtc2.RtcEngineConfig
 
getDopplerFlag() - Method in class io.agora.rtc2.SpatialAudioParams
 
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 onEarMonitoringAudioFrame callback.
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.
getEglBase() - Method in class io.agora.base.TextureBufferHelper
Retrieve the EglBase instance.
getEglBaseContext() - Method in class io.agora.base.TextureBuffer
 
getEglBaseContext() - Method in interface io.agora.base.VideoFrame.TextureBuffer
Retrieve the wrapped eglcontext EglBase.Context
getEglContextHandler() - Method in class io.agora.mediaplayer.gl.PlayerTextureHelper
 
getEglContextHandler() - Method in interface io.agora.mediaplayer.IPlayerTextureHelper
 
getEglContextType() - Method in class io.agora.base.TextureBuffer
 
getEglContextType() - Method in interface io.agora.base.VideoFrame.TextureBuffer
 
getErrorByValue(int) - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerError
 
getErrorDescription(int) - Static method in class io.agora.rtc2.RtcEngine
Gets the warning or error description.
getEventByValue(int) - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerEvent
 
getExtensionObserver() - Method in class io.agora.rtc2.RtcEngineConfig
 
getExtensionProperty(String, String, String) - Method in class io.agora.rtc2.RtcEngine
Get local video filter property
getExtensionProperty(String, String, String, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
 
getExtensionProperty(String, String, ExtensionInfo, String) - Method in class io.agora.rtc2.RtcEngine
Get extension specific property.
getFaceRect() - Method in class io.agora.base.FaceDetectionInfo
 
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.data.CacheStatistics
 
getFileSize() - Method in class io.agora.rtc2.RtcEngineConfig.LogConfig
 
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.SimulcastStreamConfig
 
getFramesPerSecond() - Method in class io.agora.rtc2.video.EncodedVideoFrameInfo
 
getFrameType() - Method in class io.agora.rtc2.video.EncodedVideoFrameInfo
 
getGlTarget() - Method in enum io.agora.base.VideoFrame.TextureBuffer.Type
 
getGreen() - Method in class io.agora.rtc2.live.LiveTranscoding
Deprecated.
Gets the background color's green component.
getHandler() - Method in class io.agora.base.TextureBufferHelper
Retrieve the handler.
getHeight() - Method in class io.agora.base.JavaI420Buffer
 
getHeight() - Method in class io.agora.base.NV12Buffer
 
getHeight() - Method in class io.agora.base.NV21Buffer
 
getHeight() - Method in class io.agora.base.TextureBuffer
 
getHeight() - Method in interface io.agora.base.VideoFrame.Buffer
Resolution of the buffer in pixels.
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
 
getId() - Method in class io.agora.base.FaceDetectionInfo
 
getId() - Method in interface io.agora.base.IMetaInfo
 
getImageUrl() - Method in class io.agora.rtc2.video.ImageTrackOptions
 
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
 
getMatrix() - Method in interface io.agora.base.VideoFrame.ColorSpace
 
getMatrix() - Method in enum io.agora.base.VideoFrame.ColorSpace.Matrix
 
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.
getMediaRecorder(RtcEngine) - Static method in class io.agora.rtc2.AgoraMediaRecorder
Gets the `AgoraMediaRecorder` object.
getMediaStreamType() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
getMetaInfo() - Method in class io.agora.base.VideoFrame
 
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 onMixedFrame callback.
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
 
getNativeEglContext() - Method in class io.agora.base.TextureBuffer
 
getNativeEglContext() - Method in interface io.agora.base.VideoFrame.TextureBuffer
 
getNativeHandle() - Method in class io.agora.rtc2.RtcEngine
Returns the native handler of the SDK Engine.
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
getNtpTimeInMs() - Method in class io.agora.rtc2.RtcEngine
Return current NTP(Network Time Protocol) 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.
getParameter(String, String) - Method in class io.agora.rtc2.RtcEngine
Gets the Agora SDK’s parameters for customization purposes.
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 onPlaybackFrame callback.
getPlayerId() - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
 
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
 
getPrimary() - Method in interface io.agora.base.VideoFrame.ColorSpace
 
getPrimary() - Method in enum io.agora.base.VideoFrame.ColorSpace.Primary
 
getProvider() - Method in class io.agora.mediaplayer.data.MediaPlayerSource
 
getPublishCustomAudioSourceId() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getPublishMediaPlayerId() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getPublishMediaPlayerId() - Method in class io.agora.rtc2.DirectCdnStreamingMediaOptions
 
getPublishRhythmPlayerTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getPublishSignalVolume() - Method in interface io.agora.mediaplayer.IMediaPlayer
 
getRange() - Method in interface io.agora.base.VideoFrame.ColorSpace
 
getRange() - Method in enum io.agora.base.VideoFrame.ColorSpace.Range
 
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 onRecordFrame callback.
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
 
getRotatedHeight() - Method in class io.agora.base.VideoFrame
 
getRotatedWidth() - Method in class io.agora.base.VideoFrame
 
getRotation() - Method in class io.agora.base.VideoFrame
Rotation of the frame in degrees.
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.
getSampleAspectRatio() - Method in class io.agora.base.VideoFrame
 
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.
getSequence() - Method in class io.agora.base.TextureBuffer
 
getSequence() - Method in interface io.agora.base.VideoFrame.TextureBuffer
Sequence number managed by texture buffer creator.
getSourceType() - Method in class io.agora.base.VideoFrame
 
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 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
 
getStrideU() - Method in class io.agora.base.JavaI420Buffer
 
getStrideU() - Method in interface io.agora.base.VideoFrame.I420Buffer
 
getStrideU() - Method in interface io.agora.base.VideoFrame.I422Buffer
 
getStrideV() - Method in class io.agora.base.JavaI420Buffer
 
getStrideV() - Method in interface io.agora.base.VideoFrame.I420Buffer
 
getStrideV() - Method in interface io.agora.base.VideoFrame.I422Buffer
 
getStrideY() - Method in class io.agora.base.JavaI420Buffer
 
getStrideY() - Method in interface io.agora.base.VideoFrame.I420Buffer
 
getStrideY() - Method in interface io.agora.base.VideoFrame.I422Buffer
 
getTag() - Method in class io.agora.base.FaceDetectionInfo
 
getTag() - Method in interface io.agora.base.IMetaInfo
 
getTargetBitrate() - Method in class io.agora.rtc2.EncodedVideoTrackOptions
 
getTeammates(ArrayList<Integer>) - Method in class io.agora.spatialaudio.ICloudSpatialAudioEngine
 
getTextureId() - Method in class io.agora.base.TextureBuffer
 
getTextureId() - Method in interface io.agora.base.VideoFrame.TextureBuffer
 
getThreadPriority() - Method in class io.agora.rtc2.RtcEngineConfig
 
getTimestamp() - Method in class io.agora.base.AudioFrame
 
getTimestampNs() - Method in class io.agora.base.VideoFrame
Timestamp of the frame in nano seconds.
getToI420Handler() - Method in class io.agora.base.TextureBuffer
 
getToken() - Method in class io.agora.rtc2.ChannelMediaOptions
 
getToken() - Method in class io.agora.rtc2.video.ChannelMediaInfo
 
getTrackId() - Method in class io.agora.rtc2.video.EncodedVideoFrameInfo
 
getTransfer() - Method in interface io.agora.base.VideoFrame.ColorSpace
 
getTransfer() - Method in enum io.agora.base.VideoFrame.ColorSpace.Transfer
 
getTransformMatrix() - Method in class io.agora.base.TextureBuffer
 
getTransformMatrix() - Method in interface io.agora.base.VideoFrame.TextureBuffer
Retrieve the transform matrix associated with the frame.
getTransformMatrixArray() - Method in class io.agora.base.TextureBuffer
 
getTransformMatrixArray() - Method in interface io.agora.base.VideoFrame.TextureBuffer
 
getType() - Method in class io.agora.base.TextureBuffer
 
getType() - Method in interface io.agora.base.VideoFrame.TextureBuffer
 
getTypeByValue(int) - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerMetadataType
 
getTypeByValue(int) - Static method in enum 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
 
getUp() - Method in class io.agora.spatialaudio.SpatialAudioZone
 
getUpLength() - Method in class io.agora.spatialaudio.SpatialAudioZone
 
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(Constants.AudioDualMonoMode) - Static method in enum io.agora.mediaplayer.Constants.AudioDualMonoMode
 
getValue(Constants.MediaPlayerError) - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerError
 
getValue(Constants.MediaPlayerEvent) - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerEvent
 
getValue(Constants.MediaPlayerMetadataType) - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerMetadataType
 
getValue(Constants.MediaPlayerPreloadEvent) - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerPreloadEvent
 
getValue(Constants.MediaPlayerState) - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerState
 
getValue(Constants.MediaStreamType) - Static method in enum io.agora.mediaplayer.Constants.MediaStreamType
 
getValue() - Method in enum io.agora.rtc2.audio.AdvancedAudioOptions.AudioProcessingChannelsEnum
 
getValue() - Method in enum io.agora.rtc2.Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY
 
getValue() - Method in enum io.agora.rtc2.Constants.AUDIO_REVERB_TYPE
 
getValue(Constants.AudioMixingDualMonoMode) - Static method in enum io.agora.rtc2.Constants.AudioMixingDualMonoMode
 
getValue(Constants.AudioProfile) - Static method in enum io.agora.rtc2.Constants.AudioProfile
 
getValue(Constants.AudioScenario) - Static method in enum io.agora.rtc2.Constants.AudioScenario
 
getValue(Constants.ExternalVideoSourceType) - Static method in enum io.agora.rtc2.Constants.ExternalVideoSourceType
 
getValue(Constants.LogLevel) - Static method in enum io.agora.rtc2.Constants.LogLevel
 
getValue(Constants.MediaSourceType) - Static method in enum io.agora.rtc2.Constants.MediaSourceType
 
getValue(Constants.MediaType) - Static method in enum io.agora.rtc2.Constants.MediaType
 
getValue(Constants.SimulcastStreamMode) - Static method in enum io.agora.rtc2.Constants.SimulcastStreamMode
 
getValue(Constants.ThreadPriorityType) - Static method in enum io.agora.rtc2.Constants.ThreadPriorityType
 
getValue() - Method in enum io.agora.rtc2.Constants.VideoSourceType
 
getValue(Constants.VideoSourceType) - Static method in enum io.agora.rtc2.Constants.VideoSourceType
 
getValue() - Method in enum io.agora.rtc2.DirectCdnStreamingError
 
getValue() - Method in enum io.agora.rtc2.DirectCdnStreamingState
 
getValue(LiveInjectStreamConfig.AudioSampleRateType) - Static method in enum io.agora.rtc2.live.LiveInjectStreamConfig.AudioSampleRateType
 
getValue(LiveTranscoding.AudioCodecProfileType) - Static method in enum io.agora.rtc2.live.LiveTranscoding.AudioCodecProfileType
 
getValue(LiveTranscoding.AudioSampleRateType) - Static method in enum io.agora.rtc2.live.LiveTranscoding.AudioSampleRateType
 
getValue(LiveTranscoding.VideoCodecProfileType) - Static method in enum io.agora.rtc2.live.LiveTranscoding.VideoCodecProfileType
 
getValue(LiveTranscoding.VideoCodecType) - Static method in enum io.agora.rtc2.live.LiveTranscoding.VideoCodecType
 
getValue(RtcConnection.CONNECTION_STATE_TYPE) - Static method in enum io.agora.rtc2.RtcConnection.CONNECTION_STATE_TYPE
 
getValue() - Method in enum io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_DIRECTION
 
getValue() - Method in enum io.agora.rtc2.video.VideoEncoderConfiguration.CODEC_CAP_MASK
 
getValue() - Method in enum io.agora.rtc2.video.VideoEncoderConfiguration.DEGRADATION_PREFERENCE
 
getValue() - Method in enum io.agora.rtc2.video.VideoEncoderConfiguration.FRAME_RATE
 
getValue() - Method in enum io.agora.rtc2.video.VideoEncoderConfiguration.MIRROR_MODE_TYPE
 
getValue() - Method in enum io.agora.rtc2.video.VideoEncoderConfiguration.ORIENTATION_MODE
 
getVideoBitRate() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
getVideoCaptureParameters() - Method in class io.agora.rtc2.ScreenCaptureParameters
 
getVideoFormatPreference() - Method in interface io.agora.rtc2.video.IVideoFrameObserver
 
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
 
getVideoRotation() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
getVideoWidth() - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
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.base.JavaI420Buffer
 
getWidth() - Method in class io.agora.base.NV12Buffer
 
getWidth() - Method in class io.agora.base.NV21Buffer
 
getWidth() - Method in class io.agora.base.TextureBuffer
 
getWidth() - Method in interface io.agora.base.VideoFrame.Buffer
Resolution of the buffer in pixels.
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
 
getYuvConverter() - Method in class io.agora.base.TextureBuffer
 
getZoneSetId() - Method in class io.agora.spatialaudio.SpatialAudioZone
 
GOOD - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.Quality
Deprecated.
 
greenCapacity - Variable in class io.agora.rtc2.video.SegmentationProperty
greenscreen open

H

HARDWARE_ENCODER - Static variable in class io.agora.rtc2.Constants
Hardware encoder.
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.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.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.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.WatermarkOptions.Rectangle
The height (pixels) of the watermark image.

I

IAgoraEventHandler - Interface in io.agora.rtc2
Created by eaglewangy on 29/03/2018.
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
 
ICloudSpatialAudioEngine - Class in io.agora.spatialaudio
 
ICloudSpatialAudioEngine() - Constructor for class io.agora.spatialaudio.ICloudSpatialAudioEngine
 
ICloudSpatialAudioEngine.AudioRangeMode - Class in io.agora.spatialaudio
Audio range mode
ICloudSpatialAudioEventHandler - Interface in io.agora.spatialaudio
 
ICloudSpatialAudioEventHandler.ConnectionChangedReason - Class in io.agora.spatialaudio
 
ICloudSpatialAudioEventHandler.ConnectionState - Class in io.agora.spatialaudio
 
IDENTITY_MATRIX - Static variable in class io.agora.mediaplayer.gl.PlayerTextureHelper
 
IDirectCdnStreamingEventHandler - Interface in io.agora.rtc2
Created by chenjianming on 17/05/2021.
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
 
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.
IMetaInfo - Interface in io.agora.base
 
initialize(CloudSpatialAudioConfig) - Method in class io.agora.spatialaudio.ICloudSpatialAudioEngine
 
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
interval - Variable in class io.agora.rtc2.video.ContentInspectConfig.ContentInspectModule
The content inspect module's upload image frequency The frequency unit is second.
invoke(Callable<V>) - Method in class io.agora.base.TextureBufferHelper
Post |callable| to be executed on the |handler| thread and wait for the result.
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.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 Constants class with the same constants value
IRtcEngineEventHandler.DownlinkNetworkInfo - Class in io.agora.rtc2
The statistics of the downlink network info.
IRtcEngineEventHandler.ErrorCode - Class in io.agora.rtc2
The error codes.
IRtcEngineEventHandler.LastmileProbeResult - Class in io.agora.rtc2
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.Quality - Class in io.agora.rtc2
Deprecated.
Use the new Constants class 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 Constants class with the same constants value
IRtcEngineEventHandler.VideoProfile - Class in io.agora.rtc2
Deprecated.
Use the new Constants class with the same constants value
IRtcEngineEventHandler.WarnCode - Class in io.agora.rtc2
The warning code.
IRtcEngineEventHandler.WlAccStats - Class in io.agora.rtc2
Indicator optimization degree.
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.
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
 
isEncodedFrameOnly() - Method in class io.agora.rtc2.video.VideoSubscriptionOptions
 
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
 
isPublishCustomAudioTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishCustomAudioTrack() - Method in class io.agora.rtc2.DirectCdnStreamingMediaOptions
 
isPublishCustomAudioTrackAec() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishCustomAudioTrackEnableAec() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishCustomVideoTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishCustomVideoTrack() - Method in class io.agora.rtc2.DirectCdnStreamingMediaOptions
 
isPublishDirectCustomAudioTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishEncodedVideoTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishMediaPlayerAudioTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishMediaPlayerAudioTrack() - Method in class io.agora.rtc2.DirectCdnStreamingMediaOptions
 
isPublishMediaPlayerVideoTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishMicrophoneTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishMicrophoneTrack() - Method in class io.agora.rtc2.DirectCdnStreamingMediaOptions
 
isPublishScreenCaptureAudio() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishScreenCaptureVideo() - Method in class io.agora.rtc2.ChannelMediaOptions
 
isPublishSecondaryCameraTrack() - Method in class io.agora.rtc2.ChannelMediaOptions
 
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.
isTextureInUse() - Method in class io.agora.base.TextureBufferHelper
This can only be called from the |handler| thread.
isValidColor(String) - Static method in class io.agora.rtc2.video.VideoCompositingLayout
Deprecated.
 
IVideoEncodedFrameObserver - Interface in io.agora.rtc2.video
The IVideoEncodedFrameObserver interface.
IVideoFrameObserver - Interface in io.agora.rtc2.video
 

J

JavaI420Buffer - Class in io.agora.base
Implementation of VideoFrame.I420Buffer backed by Java direct byte buffers.
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.
joinChannel(String, String, String, int) - Method in class io.agora.rtc2.RtcEngine
Joins a channel.
joinChannel(String, String, int, ChannelMediaOptions) - Method in class io.agora.rtc2.RtcEngine
Joins a channel with media options.
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.

L

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
 
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.
LeaveChannelOptions - Class in io.agora.rtc2
The leave channel options.
LeaveChannelOptions() - Constructor for class io.agora.rtc2.LeaveChannelOptions
 
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 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 in io.agora.rtc2.live
Self-defined audio codec profile.
LiveTranscoding.AudioSampleRateType - Enum 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 in io.agora.rtc2.live
Self-defined video codec profile.
LiveTranscoding.VideoCodecType - Enum 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_ERROR_CAPTURE_FAILURE - Static variable in class io.agora.rtc2.Constants
4: The local audio capture failed.
LOCAL_AUDIO_STREAM_ERROR_DEVICE_BUSY - Static variable in class io.agora.rtc2.Constants
3: The microphone is in use.
LOCAL_AUDIO_STREAM_ERROR_DEVICE_NO_PERMISSION - Static variable in class io.agora.rtc2.Constants
2: No permission to use the local audio device.
LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE - Static variable in class io.agora.rtc2.Constants
5: The local audio encoding fails.
LOCAL_AUDIO_STREAM_ERROR_FAILURE - Static variable in class io.agora.rtc2.Constants
1: No specified reason for the local audio failure.
LOCAL_AUDIO_STREAM_ERROR_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_ERROR_CAPTURE_FAILURE - Static variable in class io.agora.rtc2.Constants
4: The local video capture fails.
LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY - Static variable in class io.agora.rtc2.Constants
3: The local video capturer is in use.
LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION - Static variable in class io.agora.rtc2.Constants
2: No permission to use the local video device.
LOCAL_VIDEO_STREAM_ERROR_DEVICE_NOT_FOUND - Static variable in class io.agora.rtc2.Constants
8: The local video device not found.
LOCAL_VIDEO_STREAM_ERROR_ENCODE_FAILURE - Static variable in class io.agora.rtc2.Constants
5: The local video encoding fails.
LOCAL_VIDEO_STREAM_ERROR_FAILURE - Static variable in class io.agora.rtc2.Constants
1: No specified reason for the local video failure.
LOCAL_VIDEO_STREAM_ERROR_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
 
LocalAudioStats() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.LocalAudioStats
 
LocalSpatialAudioConfig - Class in io.agora.spatialaudio
 
LocalSpatialAudioConfig() - Constructor for class io.agora.spatialaudio.LocalSpatialAudioConfig
 
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.
LogConfig() - Constructor for class io.agora.rtc2.RtcEngineConfig.LogConfig
 
lossRatePercent - Variable in class io.agora.rtc2.IRtcEngineEventHandler.WlAccStats
Loss Rate optimization percentage.
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.
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

makeQualityReportUrl(String, String, String, int) - Method in class io.agora.rtc2.RtcEngineInternal
 
mAppId - Variable in class io.agora.rtc2.RtcEngineConfig
The App ID issued to you by Agora.
mAppId - Variable in class io.agora.spatialaudio.CloudSpatialAudioConfig
 
mAreaCode - Variable in class io.agora.rtc2.RtcEngineConfig
The region for connection.
mAudioScenario - Variable in class io.agora.rtc2.RtcEngineConfig
The audio application scenario.
MAX_CONTENT_INSPECT_MODULE_COUNT - Static variable in class io.agora.rtc2.video.ContentInspectConfig
 
MAX_CROSS_DEST_CHANNEL_SIZE - Static variable in class io.agora.rtc2.Constants
media relay max dest channel size
maxDurationMs - Variable in class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
The maximum recording duration, in milliseconds.
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.
mDeployRegion - Variable in class io.agora.spatialaudio.CloudSpatialAudioConfig
 
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_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.
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
 
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
IRtcEngineEventHandler is an abstract class providing default implementation.
mEventHandler - Variable in class io.agora.spatialaudio.CloudSpatialAudioConfig
 
mExtensionList - Variable in class io.agora.rtc2.RtcEngineConfig
Determines whether to enable audio device -true: (Default) enable audio device -false, disable audio device.
mExtensionObserver - Variable in class io.agora.rtc2.RtcEngineConfig
 
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(int) - Method in class io.agora.base.JavaI420Buffer
 
mirror(int) - Method in class io.agora.base.NV12Buffer
 
mirror(int) - Method in class io.agora.base.NV21Buffer
 
mirror(int) - Method in class io.agora.base.TextureBuffer
 
mirror(int) - Method in interface io.agora.base.VideoFrame.Buffer
Apply mirror
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.
mLicense - Variable in class io.agora.rtc2.RtcEngineConfig
The license used for verification when connecting channel.
mLogConfig - Variable in class io.agora.rtc2.RtcEngineConfig
 
mNativeLibPath - Variable in class io.agora.rtc2.RtcEngineConfig
native c++ dynamic library path.
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 the AudioFrame without 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
model type ai or green
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.
mRtcEngine - Variable in class io.agora.spatialaudio.CloudSpatialAudioConfig
 
mRtcEngine - Variable in class io.agora.spatialaudio.LocalSpatialAudioConfig
 
mThreadPriority - Variable in class io.agora.rtc2.RtcEngineConfig
Thread priority type.
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.
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.

N

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.
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.
NV12Buffer - Class in io.agora.base
 
NV12Buffer(int, int, int, int, ByteBuffer, Runnable) - Constructor for class io.agora.base.NV12Buffer
 
NV21Buffer - Class in io.agora.base
 
NV21Buffer(byte[], int, int, Runnable) - Constructor for class io.agora.base.NV21Buffer
Constructs a new TextureBuffer backed by the given data.
NV21Buffer(int, int, int, int, ByteBuffer, Runnable) - Constructor for class io.agora.base.NV21Buffer
 

O

onActiveSpeaker(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when an active speaker is detected.
onAgoraCDNTokenWillExpire() - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
 
onApiCallExecuted(int, String, String) - Method in interface io.agora.rtc2.IAgoraEventHandler
API执行完毕后,该回调会被触发
onApiCallExecuted(int, String, String) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when an API method is executed.
onAudioEffectFinished(int) - Method in interface io.agora.rtc2.IAgoraEventHandler
 
onAudioEffectFinished(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
The local audio effect playback has finished.
onAudioMixingFinished() - Method in interface io.agora.rtc2.IAgoraEventHandler
 
onAudioMixingFinished() - Method in class io.agora.rtc2.IRtcEngineEventHandler
The audio mixing file playback is finished after calling startAudioMixing.
onAudioMixingPositionChanged(long) - Method in interface io.agora.rtc2.IAgoraEventHandler
 
onAudioMixingPositionChanged(long) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onAudioMixingStateChanged(int, int) - Method in interface io.agora.rtc2.IAgoraEventHandler
Occurs when the state of the local user's audio mixing file changes.
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 interface io.agora.rtc2.IAgoraEventHandler
Occurs when the audio publish state changed.
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 interface io.agora.rtc2.IAgoraEventHandler
 
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 interface io.agora.rtc2.IAgoraEventHandler
Occurs when the audio subscribe state changed.
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 interface io.agora.rtc2.IAgoraEventHandler
远端音频流音量强度回调
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 interface io.agora.rtc2.IAgoraEventHandler
The camera exposure area has changed.
onCameraExposureAreaChanged(Rect) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when the camera exposure area has changed.
onCameraFocusAreaChanged(Rect) - Method in interface io.agora.rtc2.IAgoraEventHandler
摄像头对焦区域或状态发生变化之后,该回调将会被触发
onCameraFocusAreaChanged(Rect) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when the camera focus area has changed.
onCameraReady() - Method in interface io.agora.rtc2.IAgoraEventHandler
摄像头设备就绪之后,该回调将被触发
onCameraReady() - Method in class io.agora.rtc2.IRtcEngineEventHandler
The camera is turned on and ready to capture video.
onCaptureVideoFrame(VideoFrame) - Method in interface io.agora.rtc2.video.IVideoFrameObserver
Occurs each time the SDK receives a video frame captured by the local camera.
onChannelMediaRelayEvent(int) - Method in interface io.agora.rtc2.IAgoraEventHandler
 
onChannelMediaRelayEvent(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Reports events during the media stream relay.
onChannelMediaRelayStateChanged(int, int) - Method in interface io.agora.rtc2.IAgoraEventHandler
 
onChannelMediaRelayStateChanged(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when the state of the media stream relay changes.
onClientRoleChanged(int, int) - Method in interface io.agora.rtc2.IAgoraEventHandler
 
onClientRoleChanged(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.
onClientRoleChangeFailed(int, int) - Method in interface io.agora.rtc2.IAgoraEventHandler
 
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 interface io.agora.rtc2.IAgoraEventHandler
连接被服务器禁止,该回调会被触发
onConnectionBanned() - Method in class io.agora.rtc2.IRtcEngineEventHandler
Your connection is banned by the Agora Server.
onConnectionInterrupted() - Method in interface io.agora.rtc2.IAgoraEventHandler
连接意外断开后,该回调会被触发
onConnectionInterrupted() - Method in class io.agora.rtc2.IRtcEngineEventHandler
The SDK has lost connection to the server.
onConnectionLost() - Method in interface io.agora.rtc2.IAgoraEventHandler
确认连接不可用后,该回调会被调用
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.
onConnectionStateChange(int, int) - Method in interface io.agora.spatialaudio.ICloudSpatialAudioEventHandler
 
onConnectionStateChanged(int, int) - Method in interface io.agora.rtc2.IAgoraEventHandler
连接状态改变后,该回调会被触发
onConnectionStateChanged(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when the network connection state changes.
onContentInspectResult(int) - Method in interface io.agora.rtc2.IAgoraEventHandler
 
onContentInspectResult(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onDirectCdnStreamingStateChanged(DirectCdnStreamingState, DirectCdnStreamingError, String) - Method in interface io.agora.rtc2.IDirectCdnStreamingEventHandler
Event callback of Direct Cdn Streaming
onDirectCdnStreamingStats(DirectCdnStreamingStats) - Method in interface io.agora.rtc2.IDirectCdnStreamingEventHandler
Current status data of rtmp streaming.
onDownlinkNetworkInfoUpdated(IRtcEngineEventHandler.DownlinkNetworkInfo) - Method in interface io.agora.rtc2.IAgoraEventHandler
 
onDownlinkNetworkInfoUpdated(IRtcEngineEventHandler.DownlinkNetworkInfo) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when downlink network info is updated.
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.
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 interface io.agora.rtc2.IAgoraEventHandler
 
onEncryptionError(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Reports the error type of encryption.
onError(int) - Method in interface io.agora.rtc2.IAgoraEventHandler
错误信息回调
onError(String, String, int, String) - Method in interface io.agora.rtc2.IMediaExtensionObserver
 
onError(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
An error occurred during SDK runtime.
onEvent(String, String, String, String) - Method in interface io.agora.rtc2.IMediaExtensionObserver
 
onFacePositionChanged(int, int, IRtcEngineEventHandler.AgoraFacePositionInfo[]) - Method in interface io.agora.rtc2.IAgoraEventHandler
Occurs when the camera exposure area has changed.
onFacePositionChanged(int, int, IRtcEngineEventHandler.AgoraFacePositionInfo[]) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when the camera exposure area has changed.
onFirstLocalAudioFramePublished(int) - Method in interface io.agora.rtc2.IAgoraEventHandler
当引擎发送本地首帧音频帧时,该回调会被调用
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 interface io.agora.rtc2.IAgoraEventHandler
当引擎获取到本地首帧视频信息之后,该回调会被调用
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 interface io.agora.rtc2.IAgoraEventHandler
Occurs when the first video frame is published.
onFirstLocalVideoFramePublished(Constants.VideoSourceType, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when the first video frame is published.
onFirstRemoteAudioDecoded(int, int) - Method in interface io.agora.rtc2.IAgoraEventHandler
 
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 interface io.agora.rtc2.IAgoraEventHandler
 
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 onRemoteVideoStateChanged callback 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 muteLocalVideoStream method.
    • The remote user calls the disableVideo method.
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 interface io.agora.rtc2.IAgoraEventHandler
 
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 interface io.agora.rtc2.IAgoraEventHandler
 
onLastmileProbeResult(IRtcEngineEventHandler.LastmileProbeResult) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Reports the last-mile network probe result.
onLastmileQuality(int) - Method in interface io.agora.rtc2.IAgoraEventHandler
Lastmile测试得到的网络质量回调
onLastmileQuality(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Reports the last-mile network quality of the local user.
onLeaveChannel(IRtcEngineEventHandler.RtcStats) - Method in interface io.agora.rtc2.IAgoraEventHandler
退出频道的回调
onLeaveChannel(IRtcEngineEventHandler.RtcStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when the local user successfully leaves the channel.
onLicenseValidationFailure(int) - Method in interface io.agora.rtc2.IAgoraEventHandler
Occurs when connection license verification fails You can know the reason according to error code
onLicenseValidationFailure(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when connection license verification fails You can know the reason according 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 interface io.agora.rtc2.IAgoraEventHandler
 
onLocalAudioStats(IRtcEngineEventHandler.LocalAudioStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Reports the statistics of the local audio stream.
onLocalPublishFallbackToAudioOnly(boolean) - Method in interface io.agora.rtc2.IAgoraEventHandler
 
onLocalPublishFallbackToAudioOnly(boolean) - Method in class io.agora.rtc2.IRtcEngineEventHandler
 
onLocalUserRegistered(int, String) - Method in interface io.agora.rtc2.IAgoraEventHandler
Occurs when the local user successfully registers a user account by calling the \ref agora::rtc::IRtcEngine::registerLocalUserAccount "registerLocalUserAccount" method or joins a channel by calling the \ref agora::rtc::IRtcEngine::joinChannelWithUserAccount "joinChannelWithUserAccount" method.
onLocalUserRegistered(int, String) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when the local user registers a user account.
onLocalVideoStat(int, int) - Method in interface io.agora.rtc2.IAgoraEventHandler
Deprecated.
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 interface io.agora.rtc2.IAgoraEventHandler
近端视频流质量回调
onLocalVideoStats(Constants.VideoSourceType, IRtcEngineEventHandler.LocalVideoStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Reports the statistics of the local video streams.
onMediaEngineLoadSuccess() - Method in interface io.agora.rtc2.IAgoraEventHandler
 
onMediaEngineLoadSuccess() - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when the media engine is loaded.
onMediaEngineStartCallSuccess() - Method in interface io.agora.rtc2.IAgoraEventHandler
 
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(byte[], int, long) - 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.
onNetworkQuality(int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Reports the network quality of each user.
onNetworkTypeChanged(int) - Method in interface io.agora.rtc2.IAgoraEventHandler
网络类型改变后,该回调会被触发
onNetworkTypeChanged(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when the network type is changed.
onPermissionError(int) - Method in interface io.agora.rtc2.IAgoraEventHandler
 
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) - 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
 
onPlayerEvent(Constants.MediaPlayerEvent, long, String) - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
 
onPlayerInfoUpdated(PlayerUpdatedInfo) - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
 
onPlayerSrcInfoChanged(SrcInfo, SrcInfo) - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
 
onPlayerStateChanged(Constants.MediaPlayerState, Constants.MediaPlayerError) - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
 
onPositionChanged(long) - Method in interface io.agora.mediaplayer.IMediaPlayerObserver
 
onPreEncodeScreenVideoFrame(VideoFrame) - Method in interface io.agora.rtc2.video.IVideoFrameObserver
 
onPreEncodeVideoFrame(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 setLocalAccessPoint or setCloudProxy.
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(RecorderInfo) - Method in interface io.agora.rtc2.IMediaRecorderCallback
Occurs when the recording information is updated.
onRecorderStateChanged(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 interface io.agora.rtc2.IAgoraEventHandler
远端音频流质量回调
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
 
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 interface io.agora.rtc2.IAgoraEventHandler
远端视频流质量回调
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
 
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.
onRequestToken() - Method in interface io.agora.rtc2.IAgoraEventHandler
 
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 interface io.agora.rtc2.IAgoraEventHandler
状态信息回调
onRtcStats(IRtcEngineEventHandler.RtcStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Reports the statistics of the current call.
onRtmpStreamingEvent(String, int) - Method in interface io.agora.rtc2.IAgoraEventHandler
 
onRtmpStreamingEvent(String, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Reports events during the RTMP or RTMPS streaming.
onRtmpStreamingStateChanged(String, int, int) - Method in interface io.agora.rtc2.IAgoraEventHandler
 
onRtmpStreamingStateChanged(String, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when the state of the RTMP streaming changes.
onScreenCaptureVideoFrame(VideoFrame) - Method in interface io.agora.rtc2.video.IVideoFrameObserver
Occurs each time the SDK receives a video frame captured by the screen.
onSeek(long, int) - Method in interface io.agora.mediaplayer.IMediaPlayerCustomDataProvider
 
onSnapshotTaken(int, String, int, int, int) - Method in interface io.agora.rtc2.IAgoraEventHandler
 
onSnapshotTaken(int, String, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when takeSnapshot API result is obtained
onStarted(String, String) - Method in interface io.agora.rtc2.IMediaExtensionObserver
 
onStopped(String, String) - Method in interface io.agora.rtc2.IMediaExtensionObserver
 
onStreamInjectedStatus(String, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
The status of the injected stream.
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.
onTeammateJoined(int) - Method in interface io.agora.spatialaudio.ICloudSpatialAudioEventHandler
 
onTeammateLeft(int) - Method in interface io.agora.spatialaudio.ICloudSpatialAudioEventHandler
 
onTokenPrivilegeWillExpire(String) - Method in interface io.agora.rtc2.IAgoraEventHandler
 
onTokenPrivilegeWillExpire(String) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when the token will expire in 30 seconds.
onTokenWillExpire() - Method in interface io.agora.spatialaudio.ICloudSpatialAudioEventHandler
 
onTranscodingUpdated() - Method in interface io.agora.rtc2.IAgoraEventHandler
 
onTranscodingUpdated() - Method in class io.agora.rtc2.IRtcEngineEventHandler
Transcoding was successfully updated.
onUplinkNetworkInfoUpdated(IRtcEngineEventHandler.UplinkNetworkInfo) - Method in interface io.agora.rtc2.IAgoraEventHandler
 
onUplinkNetworkInfoUpdated(IRtcEngineEventHandler.UplinkNetworkInfo) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when uplink network info is updated.
onUploadLogResult(String, boolean, int) - Method in interface io.agora.rtc2.IAgoraEventHandler
Reports the user log upload result
onUploadLogResult(String, boolean, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Reports the user log upload result
onUserEnableLocalVideo(int, boolean) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Deprecated.
This callback is deprecated and replaced by the onRemoteVideoStateChanged callback with the following parameters: - `REMOTE_VIDEO_STATE_STOPPED(0)` and `REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED(5)`. - `REMOTE_VIDEO_STATE_DECODING(2)` and `REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED(6)`. The SDK triggers this callback when the remote user resumes or stops capturing the video stream by calling the enableLocalVideo method. 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
Deprecated.
This callback is deprecated and replaced by the onRemoteVideoStateChanged callback with the following parameters: - `REMOTE_VIDEO_STATE_STOPPED(0)` and `REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED(5)`. - `REMOTE_VIDEO_STATE_DECODING(2)` and `REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED(6)`. Once the video module is disabled, the remote user can only use a voice call. The remote user cannot send or receive any video from other users. The SDK triggers this callback when the remote user enables or disables the video module by calling the enableVideo or disableVideo method.
onUserInfoUpdated(int, UserInfo) - Method in interface io.agora.rtc2.IAgoraEventHandler
Occurs when the SDK gets the user ID and user account of the remote user.
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
Deprecated.
This callback is deprecated. Use the onRemoteVideoStateChanged callback with the following parameters for the same function: - `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 stops or resumes sending the video stream by calling the muteLocalVideoStream method.
onUserOffline(int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when a remote user or broadcaster goes offline.
onUserStateChanged(int, int) - Method in interface io.agora.rtc2.IAgoraEventHandler
Occurs when the remote user state is updated.
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 interface io.agora.rtc2.IAgoraEventHandler
Occurs when the video publish state changed.
onVideoPublishStateChanged(Constants.VideoSourceType, String, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when the audio publish state changed.
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 interface io.agora.rtc2.IAgoraEventHandler
所有视频流都停止之后,该回调会被触发
onVideoStopped() - Method in class io.agora.rtc2.IRtcEngineEventHandler
The video has stopped playing.
onVideoSubscribeStateChanged(String, int, int, int, int) - Method in interface io.agora.rtc2.IAgoraEventHandler
Occurs when the video subscribe state changed.
onVideoSubscribeStateChanged(String, int, int, int, int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when the video subscribe state changed.
onWarning(int) - Method in interface io.agora.rtc2.IAgoraEventHandler
警告信息回调
onWarning(int) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Deprecated.

In most cases, the application can ignore the warnings reported by the SDK because the SDK can usually fix the issue and resume running. For instance, the SDK may report a WARN_LOOKUP_CHANNEL_TIMEOUT warning upon disconnection with the server and attempts to reconnect.

onWlAccMessage(int, int, String) - Method in interface io.agora.rtc2.IAgoraEventHandler
Occurs when the WIFI message need be sent to the user.
onWlAccMessage(int, int, String) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when the WIFI message need be sent to the user.
onWlAccStats(IRtcEngineEventHandler.WlAccStats, IRtcEngineEventHandler.WlAccStats) - Method in interface io.agora.rtc2.IAgoraEventHandler
Occurs when SDK statistics WIFI acceleration optimization effect.
onWlAccStats(IRtcEngineEventHandler.WlAccStats, IRtcEngineEventHandler.WlAccStats) - Method in class io.agora.rtc2.IRtcEngineEventHandler
Occurs when SDK statistics WIFI acceleration optimization effect.
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
Open the Agora CDN media source.
openWithCustomSource(long, IMediaPlayerCustomDataProvider) - Method in interface io.agora.mediaplayer.IMediaPlayer
Deprecated.
Opens a media with custom data provider
openWithMediaSource(MediaPlayerSource) - Method in interface io.agora.mediaplayer.IMediaPlayer
Opens a media file with a media file source.
ordered - Variable in class io.agora.rtc2.DataStreamConfig
 
orientationMode - Variable in class io.agora.rtc2.video.VideoEncoderConfiguration
The orientation mode.
owner(boolean) - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
Sets the RTMP stream owner.
owner - Variable in class io.agora.rtc2.PublisherParameters
Deprecated.
 

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.
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
pause the channels for media stream relay.
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.
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.
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, int) - 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 class io.agora.rtc2.RtcEngine
Plays a specified audio effect.
PLAYER_ERROR_NOT_INIT - Static variable in class io.agora.mediaplayer.Constants
 
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
 
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, CacheStatistics) - Constructor for class io.agora.mediaplayer.data.PlayerUpdatedInfo
 
playPreloadedSrc(String) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
playRecap() - Method in class io.agora.rtc2.RtcEngineInternal
 
POOR - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.Quality
Deprecated.
 
position(double, double) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
position - Variable in class io.agora.spatialaudio.RemoteVoicePositionInfo
 
position - Variable in class io.agora.spatialaudio.SpatialAudioZone
 
POSITION_BEFORE_MIXING - Static variable in class io.agora.rtc2.Constants
`0x01 << 3`: The position for observing the audio of a single remote user before mixing, which enables the SDK to trigger the onPlaybackFrameBeforeMixing or onPlaybackFrameBeforeMixingEx callback.
POSITION_EAR_MONITORING - Static variable in class io.agora.rtc2.Constants
`0x01 << 4`: The position for observing the ear monitoring audio of the local user, which enables the SDK to trigger the onEarMonitoringAudioFrame callback.
POSITION_MIXED - Static variable in class io.agora.rtc2.Constants
`0x01 << 2`: The position for observing the mixed audio of the local user and all remote users, which enables the SDK to trigger the onMixedFrame callback.
POSITION_PLAYBACK - Static variable in class io.agora.rtc2.Constants
`0x01`: The position for observing the playback audio of all remote users after mixing, which enables the SDK to trigger the onPlaybackFrame callback.
POSITION_POST_CAPTURER - Static variable in interface io.agora.rtc2.video.IVideoFrameObserver
The position after capturing the video data, which corresponds to the onCaptureVideoFrame callback.
POSITION_PRE_ENCODER - Static variable in interface io.agora.rtc2.video.IVideoFrameObserver
The position before encoding the video data, which corresponds to the onPreEncodeVideoFrame callback.
POSITION_PRE_RENDERER - Static variable in interface io.agora.rtc2.video.IVideoFrameObserver
The position before receiving the remote video data, which corresponds to the onRenderVideoFrame callback.
POSITION_RECORD - Static variable in class io.agora.rtc2.Constants
`0x01 << 1`: The position for observing the recorded audio of the local user, which enables the SDK to trigger the onRecordFrame callback.
positionInLandscapeMode - Variable in class io.agora.rtc2.video.WatermarkOptions
The watermark position in the landscape mode.
positionInPortraitMode - Variable in class io.agora.rtc2.video.WatermarkOptions
The watermark position in the portrait mode.
preloadEffect(int, String) - Method in interface io.agora.rtc2.IAudioEffectManager
Preloads a specified audio effect.
preloadEffect(int, String, int) - 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 class io.agora.rtc2.RtcEngine
Preloads a specified audio effect.
preloadSrc(String, long) - Method in interface io.agora.mediaplayer.IMediaPlayer
 
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.
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
Determines whether to publish the video of the camera track.
publishCustomAudioSourceId - Variable in class io.agora.rtc2.ChannelMediaOptions
The source id of the custom audio, default is 0.
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
Determines whether to publish the audio of the custom audio track.
publishCustomAudioTrackAec - Variable in class io.agora.rtc2.ChannelMediaOptions
Determines whether to publish AEC custom audio track.
publishCustomAudioTrackEnableAec - Variable in class io.agora.rtc2.ChannelMediaOptions
Determines whether to enable AEC when publish custom audio track.
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
Determines whether to publish the video of the custom video track.
publishDirectCustomAudioTrack - Variable in class io.agora.rtc2.ChannelMediaOptions
Determines whether to publish custom audio track of microphone source.
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 setLiveTranscoding method.

PublisherParameters - Class in io.agora.rtc2
Deprecated. 
PublisherParameters() - Constructor for class io.agora.rtc2.PublisherParameters
Deprecated.
 
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
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
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
Determines whether to publish the audio of the Microphonetrack.
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.
publishUrl(String) - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
Sets the publishing URL.
publishUrl - Variable in class io.agora.rtc2.PublisherParameters
Deprecated.
 
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.
pushCaptureAudioFrame(byte[]) - Method in class io.agora.rtc2.RtcEngine
 
pushCaptureAudioFrame(ByteBuffer, int) - Method in class io.agora.rtc2.RtcEngine
 
pushDirectAudioFrame(ByteBuffer, long, int, int) - Method in class io.agora.rtc2.RtcEngine
Pushes the direct send audio data to the SDK.
pushExternalAudioFrame(byte[], long) - 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
Pushes the external audio data to the app.
pushExternalEncodedVideoFrame(ByteBuffer, EncodedVideoFrameInfo) - Method in class io.agora.rtc2.RtcEngine
Pushes the encoded external video frame to Agora SDK.
pushExternalEncodedVideoFrameEx(ByteBuffer, EncodedVideoFrameInfo, int) - Method in class io.agora.rtc2.RtcEngineEx
Pushes the encoded external video frame to the app with specified connection.
pushExternalVideoFrame(AgoraVideoFrame) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
pushExternalVideoFrame(VideoFrame) - Method in class io.agora.rtc2.RtcEngine
Pushes the video frame using the `VideoFrame` class and passes the video frame to the Agora SDK.
pushExternalVideoFrameEx(VideoFrame, int) - Method in class io.agora.rtc2.RtcEngineEx
Pushes the external video frame to the app.
pushExternalVideoFrameEx(AgoraVideoFrame, int) - Method in class io.agora.rtc2.RtcEngineEx
Pushes the external video frame to the app with specified connection.
pushReverseAudioFrame(byte[]) - Method in class io.agora.rtc2.RtcEngine
 
pushReverseAudioFrame(ByteBuffer, int) - Method in class io.agora.rtc2.RtcEngine
 

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() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.Quality
Deprecated.
 
quality - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
The receiving audio quality: - `QUALITY_UNKNOWN(0)`: The quality is unknown.
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.
queryCodecCapability() - Method in class io.agora.rtc2.RtcEngine
QueryCodecCapability.

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(String) - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
Sets the raw stream URL.
rawStreamUrl - Variable in class io.agora.rtc2.PublisherParameters
Deprecated.
 
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_ERROR_CONFIG_CHANGED - Static variable in class io.agora.rtc2.AgoraMediaRecorder
4: The recording configuration changes.
RECORDER_ERROR_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_ERROR_NONE - Static variable in class io.agora.rtc2.AgoraMediaRecorder
0: No error occurs.
RECORDER_ERROR_OVER_MAX_DURATION - Static variable in class io.agora.rtc2.AgoraMediaRecorder
3: The recording duration exceeds the upper limit.
RECORDER_ERROR_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.
rect - Variable in class io.agora.rtc2.video.VideoCanvas
Rect info
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.
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.
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.base.JavaI420Buffer
 
release() - Method in class io.agora.base.NV12Buffer
 
release() - Method in class io.agora.base.NV21Buffer
 
release() - Method in class io.agora.base.TextureBuffer
 
release() - Method in interface io.agora.base.VideoFrame.Buffer
Decreases ref count by one.
release() - Method in class io.agora.base.VideoFrame
Decreases inner buffer's ref count by one.
release() - Method in class io.agora.rtc2.AgoraMediaRecorder
Releases the `AgoraMediaRecorder` object.
releaseRenderedTextureInfo(VideoFrame) - Method in class io.agora.mediaplayer.gl.PlayerTextureHelper
 
releaseRenderedTextureInfo(VideoFrame) - Method in interface io.agora.mediaplayer.IPlayerTextureHelper
 
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_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_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_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_PLAYING - Static variable in class io.agora.rtc2.Constants
2: Remote video is playing.
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_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
RemoteAudioStats() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
 
remoteUid - Variable in class io.agora.rtc2.ExtensionInfo
The id of the remote user on which the extension works.
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.
removeEventHandler(ICloudSpatialAudioEventHandler) - Method in class io.agora.spatialaudio.ICloudSpatialAudioEngine
 
removeHandler(IRtcEngineEventHandler) - Method in class io.agora.rtc2.RtcEngine
Removes the specified IRtcEngineEventHandler object.
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.
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)`: 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.
 
renewAgoraCDNSrcToken(String, long) - Method in interface io.agora.mediaplayer.IMediaPlayer
Update the CDN source token and timestamp.
renewToken(String) - Method in class io.agora.rtc2.RtcEngine
Renews the token.
renewToken(String) - Method in class io.agora.spatialaudio.ICloudSpatialAudioEngine
 
replaceBuffer(VideoFrame.Buffer, int, long) - Method in class io.agora.base.VideoFrame
replace VideoFrame content.
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.
retain() - Method in class io.agora.base.JavaI420Buffer
 
retain() - Method in class io.agora.base.NV12Buffer
 
retain() - Method in class io.agora.base.NV21Buffer
 
retain() - Method in class io.agora.base.TextureBuffer
 
retain() - Method in interface io.agora.base.VideoFrame.Buffer
Increases ref count by one.
retain() - Method in class io.agora.base.VideoFrame
Increases inner buffer's ref count by one.
RHYTHM_PLAYER_ERROR_CAN_NOT_OPEN - Static variable in class io.agora.rtc2.Constants
801: The rhythm player can not open the file.
RHYTHM_PLAYER_ERROR_CAN_NOT_PLAY - Static variable in class io.agora.rtc2.Constants
802: The rhythm player can not play the file.
RHYTHM_PLAYER_ERROR_FAILED - Static variable in class io.agora.rtc2.Constants
1: he rhythm player occurs a internal error.
RHYTHM_PLAYER_ERROR_FILE_OVER_DURATION_LIMIT - Static variable in class io.agora.rtc2.Constants
803: The file duration over the limit.
RHYTHM_PLAYER_ERROR_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_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.
rotate(int) - Method in class io.agora.base.JavaI420Buffer
 
rotate(int) - Method in class io.agora.base.NV12Buffer
 
rotate(int) - Method in class io.agora.base.NV21Buffer
 
rotate(int) - Method in class io.agora.base.TextureBuffer
 
rotate(int) - Method in interface io.agora.base.VideoFrame.Buffer
Apply rotate
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.
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 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 RtcEngine instance.
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_ERROR_CONNECTION_TIMEOUT - Static variable in class io.agora.rtc2.Constants
3.
RTMP_STREAM_PUBLISH_ERROR_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_ERROR_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_ERROR_INTERNAL_SERVER_ERROR - Static variable in class io.agora.rtc2.Constants
4.
RTMP_STREAM_PUBLISH_ERROR_INVALID_APPID - Static variable in class io.agora.rtc2.Constants
15: User AppId have not authorized to push stream.
RTMP_STREAM_PUBLISH_ERROR_INVALID_ARGUMENT - Static variable in class io.agora.rtc2.Constants
1.
RTMP_STREAM_PUBLISH_ERROR_INVALID_PRIVILEGE - Static variable in class io.agora.rtc2.Constants
16: invalid privilege.
RTMP_STREAM_PUBLISH_ERROR_NET_DOWN - Static variable in class io.agora.rtc2.Constants
14: Network error.
RTMP_STREAM_PUBLISH_ERROR_NOT_AUTHORIZED - Static variable in class io.agora.rtc2.Constants
8: The host manipulates other hosts' URLs.
RTMP_STREAM_PUBLISH_ERROR_NOT_BROADCASTER - Static variable in class io.agora.rtc2.Constants
11: Current role is not broadcaster.
RTMP_STREAM_PUBLISH_ERROR_OK - Static variable in class io.agora.rtc2.Constants
0: The RTMP or RTMPS streaming publishes successfully.
RTMP_STREAM_PUBLISH_ERROR_REACH_LIMIT - Static variable in class io.agora.rtc2.Constants
7: The host publishes more than 10 URLs.
RTMP_STREAM_PUBLISH_ERROR_RTMP_SERVER_ERROR - Static variable in class io.agora.rtc2.Constants
5: An error occurs in the CDN server.
RTMP_STREAM_PUBLISH_ERROR_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_ERROR_TOO_OFTEN - Static variable in class io.agora.rtc2.Constants
6: The RTMP or RTMPS streaming publishes too frequently.
RTMP_STREAM_PUBLISH_ERROR_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_ERROR_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).
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.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.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

SAE_CONNECTION_CHANGED_CONNECTING - Static variable in class io.agora.spatialaudio.ICloudSpatialAudioEventHandler.ConnectionChangedReason
 
SAE_CONNECTION_CHANGED_CREATE_ROOM_FAIL - Static variable in class io.agora.spatialaudio.ICloudSpatialAudioEventHandler.ConnectionChangedReason
 
SAE_CONNECTION_CHANGED_DEFAULT - Static variable in class io.agora.spatialaudio.ICloudSpatialAudioEventHandler.ConnectionChangedReason
 
SAE_CONNECTION_CHANGED_LOST_SYNC - Static variable in class io.agora.spatialaudio.ICloudSpatialAudioEventHandler.ConnectionChangedReason
 
SAE_CONNECTION_CHANGED_RTM_ABORTED - Static variable in class io.agora.spatialaudio.ICloudSpatialAudioEventHandler.ConnectionChangedReason
 
SAE_CONNECTION_CHANGED_RTM_DISCONNECT - Static variable in class io.agora.spatialaudio.ICloudSpatialAudioEventHandler.ConnectionChangedReason
 
SAE_CONNECTION_STATE_CONNECTED - Static variable in class io.agora.spatialaudio.ICloudSpatialAudioEventHandler.ConnectionState
 
SAE_CONNECTION_STATE_CONNECTING - Static variable in class io.agora.spatialaudio.ICloudSpatialAudioEventHandler.ConnectionState
 
SAE_CONNECTION_STATE_DISCONNECTED - Static variable in class io.agora.spatialaudio.ICloudSpatialAudioEventHandler.ConnectionState
 
SAE_CONNECTION_STATE_RECONNECTED - Static variable in class io.agora.spatialaudio.ICloudSpatialAudioEventHandler.ConnectionState
 
SAE_CONNECTION_STATE_RECONNECTING - Static variable in class io.agora.spatialaudio.ICloudSpatialAudioEventHandler.ConnectionState
 
SAE_DEPLOY_REGION_AS - Static variable in class io.agora.spatialaudio.CloudSpatialAudioConfig.SaeDeployRegion
Asia, excluding Mainland China
SAE_DEPLOY_REGION_CN - Static variable in class io.agora.spatialaudio.CloudSpatialAudioConfig.SaeDeployRegion
Mainland China
SAE_DEPLOY_REGION_EU - Static variable in class io.agora.spatialaudio.CloudSpatialAudioConfig.SaeDeployRegion
Europe
SAE_DEPLOY_REGION_NA - Static variable in class io.agora.spatialaudio.CloudSpatialAudioConfig.SaeDeployRegion
North America
SAE_DEPLOY_REGION_NONE - Static variable in class io.agora.spatialaudio.CloudSpatialAudioConfig.SaeDeployRegion
 
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
 
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.
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.
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
 
SEG_MODEL_GREEN - Static variable in class io.agora.rtc2.video.SegmentationProperty
 
SegmentationProperty - Class in io.agora.rtc2.video
Background substitude meta data.
SegmentationProperty(int, float) - Constructor for class io.agora.rtc2.video.SegmentationProperty
 
SegmentationProperty() - 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
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.
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
Bitrate (Kbps) sent in the reported interval, which does not include the bitrate of the retransmission video after packet loss.
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).
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.
setApiCallMode(int) - Method in class io.agora.rtc2.RtcEngineInternal
 
setAudioBytesPerSample(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setAudioChannels(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
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.
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).
setAudioOptionParams(String) - Method in class io.agora.rtc2.RtcEngine
 
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.
setAudioRangeMode(int) - Method in class io.agora.spatialaudio.ICloudSpatialAudioEngine
 
setAudioRecvRange(float) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
 
setAudioSampleRate(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setAudioScenario(int) - Method in class io.agora.rtc2.RtcEngine
 
setAudioSessionParams(String) - 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.
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
 
setCacheStatistics(CacheStatistics) - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
 
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.
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.
setCustomMetaInfo(IMetaInfo[]) - Method in class io.agora.base.VideoFrameMetaInfo
 
setDefaultAudioRoutetoSpeakerphone(boolean) - Method in class io.agora.rtc2.RtcEngine
Sets the default audio route.
setDefaultMuteAllRemoteAudioStreams(boolean) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
This method is deprecated. To set whether to receive remote audio streams by default, call muteAllRemoteAudioStreams before calling `joinChannel`. Use `setDefaultMuteAllRemoteAudioStreams` to set whether to receive audio streams of subsequent peer users. Agora recommends calling it before joining a channel. A successful call of `setDefaultMuteAllRemoteAudioStreams(true)` results in that the local user not receiving any audio stream after joining a channel.
setDefaultMuteAllRemoteVideoStreams(boolean) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
This method is deprecated. To set whether to receive remote video streams by default, call muteAllRemoteVideoStreams before calling `joinChannel`. Use `setDefaultMuteAllRemoteVideoStreams` to set whether to receive video streams of subsequent peer users. Agora recommends calling it before joining a channel. A successful call of `setDefaultMuteAllRemoteVideoStreams(true)` results in that the local user not receiving any video stream after joining a channel.
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
 
setDirectCdnStreamingAudioConfiguration(int) - Method in class io.agora.rtc2.RtcEngine
Set audio parameters for direct streaming to CDN Must call this api before "startDirectCdnStreaming"
setDirectCdnStreamingVideoConfiguration(VideoEncoderConfiguration) - Method in class io.agora.rtc2.RtcEngine
Set video parameters for direct streaming to CDN Each configuration profile corresponds to a set of video parameters, including the resolution, frame rate, and bitrate.
setDirectExternalAudioSource(boolean) - Method in class io.agora.rtc2.RtcEngine
Sets the direct external audio source.
setDirectExternalAudioSource(boolean, boolean) - Method in class io.agora.rtc2.RtcEngine
Sets the direct external audio source.
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 onEarMonitoringAudioFrame callback.
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
 
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
 
setEncryptionMode(String) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
This method is deprecated.

The Agora Native SDK supports built-in encryption. Call this API to set the encryption mode.

All users in the same channel must use the same encryption mode and password. Refer to information related to the encryption algorithm on the differences between encryption modes.

Call setEncryptionSecret to enable the built-in encryption function before calling this API.

Note: Do not use this function together with CDN.

setEncryptionSecret(String) - Method in class io.agora.rtc2.RtcEngine
Deprecated.
This method is deprecated.

All users in a channel must set the same encryption password. The encryption password is automatically cleared once a user has left the channel. If the encryption password is not specified or set to empty, the encryption function will be disabled.

Note: Do not use this function together with CDN.

setExtensionProperty(String, String, String, String) - Method in class io.agora.rtc2.RtcEngine
Set local video filter property
setExtensionProperty(String, String, String, String, Constants.MediaSourceType) - Method in class io.agora.rtc2.RtcEngine
 
setExtensionProperty(String, String, ExtensionInfo, String, String) - Method in class io.agora.rtc2.RtcEngine
Set extension specific property.
setExtensionProviderProperty(String, String, String) - Method in class io.agora.rtc2.RtcEngine
Set extension provider specific property.
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
Sets the external audio source.
setExternalAudioSource(boolean, int, int, int, boolean, boolean) - Method in class io.agora.rtc2.RtcEngine
Sets the external audio source.
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.
setFileSize(long) - Method in class io.agora.mediaplayer.data.CacheStatistics
 
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.
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.
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.
setLocalPublishFallbackOption(int) - Method in class io.agora.rtc2.RtcEngine
Sets the fallback option for the locally published video stream based on the network conditions.
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.
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.
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.
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(RtcConnection, IMediaRecorderCallback) - Method in class io.agora.rtc2.AgoraMediaRecorder
 
setMediaStreamType(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setMixedAudioFrameParameters(int, int, int) - Method in class io.agora.rtc2.RtcEngine
Sets the mixed audio format for the onMixedAudioFrame callback.
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.
setPlaybackAudioFrameBeforeMixingParameters(int, int) - Method in class io.agora.rtc2.RtcEngine
Sets the audio playback format before mixing for the onPlaybackAudioFrameBeforeMixing callback.
setPlaybackAudioFrameParameters(int, int, int, int) - Method in class io.agora.rtc2.RtcEngine
Sets the audio recording format for the onPlaybackAudioFrame callback.
setPlaybackSpeed(int) - Method in interface io.agora.mediaplayer.IMediaPlayer
Change playback speed
setPlayerAttenuation(int, double, boolean) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
 
setPlayerId(String) - Method in class io.agora.mediaplayer.data.PlayerUpdatedInfo
 
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 onRecordAudioFrame callback.
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
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.
setRemoteSubscribeFallbackOption(int) - 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
Sets the remote video stream type.
setRemoteVideoStreamTypeEx(int, int, 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
 
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
 
setSubscribeAudioBlacklist(int[]) - Method in class io.agora.rtc2.RtcEngine
Sets the blacklist of subscribe remote stream audio.
setSubscribeAudioBlacklistEx(int[], RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Sets the blacklist of subscribe remote stream audio.
setSubscribeAudioWhitelist(int[]) - Method in class io.agora.rtc2.RtcEngine
Sets the whitelist of subscribe remote stream audio.
setSubscribeAudioWhitelistEx(int[], RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Sets the whitelist of subscribe remote stream audio.
setSubscribeVideoBlacklist(int[]) - Method in class io.agora.rtc2.RtcEngine
Sets the blacklist of subscribe remote stream video.
setSubscribeVideoBlacklistEx(int[], RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Sets the blacklist of subscribe remote stream video.
setSubscribeVideoWhitelist(int[]) - Method in class io.agora.rtc2.RtcEngine
Sets the whitelist of subscribe remote stream video.
setSubscribeVideoWhitelistEx(int[], RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Sets the whitelist of subscribe remote stream video.
setTeamId(int) - Method in class io.agora.spatialaudio.ICloudSpatialAudioEngine
 
setTextureId(int, EGLContext, int, int, long) - Method in class io.agora.rtc2.RtcEngineInternal
Sets the texture ID to MediaCodec.
setTextureId(int, android.opengl.EGLContext, int, int, long) - Method in class io.agora.rtc2.RtcEngineInternal
 
setTextureSize(int, int) - Method in class io.agora.mediaplayer.gl.PlayerTextureHelper
 
setTextureSize(int, int) - Method in interface io.agora.mediaplayer.IPlayerTextureHelper
 
SetUid(int) - Method in class io.agora.rtc2.UserInfo
 
setupLocalVideo(VideoCanvas) - Method in class io.agora.rtc2.RtcEngine
Initializes the local video view.
setupMode - Variable in class io.agora.rtc2.video.VideoCanvas
setupMode
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(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setVideoDenoiserOptions(boolean, VideoDenoiserOptions) - Method in class io.agora.rtc2.RtcEngine
Sets video noise reduction.
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.
setVideoFrameRate(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setVideoHeight(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setVideoProfile(int, boolean) - Method in class io.agora.rtc2.RtcEngine
Sets the video encoding profile.
setVideoQualityParameters(boolean) - Method in class io.agora.rtc2.RtcEngine
Sets the video quality preferences.
setVideoRotation(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
setVideoWidth(int) - Method in class io.agora.mediaplayer.data.MediaStreamInfo
 
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
 
sharpnessLevel - Variable in class io.agora.rtc2.video.BeautyOptions
The smoothness level.
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(int, int) - Method in class io.agora.rtc2.PublisherConfiguration.Builder
Deprecated.
Sets the stream resolution.
size(double, double) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
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.
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
sourceId - Variable in class io.agora.rtc2.video.VideoCanvas
ID of the video source.
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.
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.
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(String, int) - Method in class io.agora.rtc2.RtcEngine
Starts an audio recording.
startAudioRecording(AudioRecordingConfiguration) - Method in class io.agora.rtc2.RtcEngine
Starts an audio recording.
startChannelMediaRelay(ChannelMediaRelayConfiguration) - Method in class io.agora.rtc2.RtcEngine
Starts to relay media streams across channels.
startChannelMediaRelayEx(ChannelMediaRelayConfiguration, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Starts to relay media streams across channels.
startDirectCdnStreaming(IDirectCdnStreamingEventHandler, String, DirectCdnStreamingMediaOptions) - Method in class io.agora.rtc2.RtcEngine
Start direct cdn streaming
startEchoTest() - Method in class io.agora.rtc2.RtcEngine
Deprecated.
Now use #startEchoTest(int)

Starts an audio call test to determine whether the audio devices (for example, headset and speaker) and the network connection are working properly.

In the test, the user first speaks, and the recording is played back in 10 seconds. If the user can hear the recording in 10 seconds, it indicates that the audio devices and network connection work properly.

Note: After calling the startEchoTest method, call stopEchoTest to end the test; otherwise the application cannot run the next echo test, nor can it call the joinChannel method to start a new call.

startEchoTest(int) - Method in class io.agora.rtc2.RtcEngine
Starts an audio call test.
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).
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(RtcConnection, AgoraMediaRecorder.MediaRecorderConfiguration) - Method in class io.agora.rtc2.AgoraMediaRecorder
Starts recording the local 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.
startSecondaryCameraCapture(CameraCapturerConfiguration) - Method in class io.agora.rtc2.RtcEngine
Start the secondary camera capture.
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.
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
Stop direct cdn streaming
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.
stopMicrophoneRecording - Variable in class io.agora.rtc2.LeaveChannelOptions
Determines whether to stop microphone recording when leave channel.
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(RtcConnection) - Method in class io.agora.rtc2.AgoraMediaRecorder
Stops recording the local 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.
stopSecondaryCameraCapture() - Method in class io.agora.rtc2.RtcEngine
Stop the secondary camera capture.
storagePath - Variable in class io.agora.rtc2.AgoraMediaRecorder.MediaRecorderConfiguration
The absolute path (including the filename extensions) for the recording file.
STREAM_FALLBACK_OPTION_DISABLED - Static variable in class io.agora.rtc2.Constants
 
STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW - Static variable in class io.agora.rtc2.Constants
 
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_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_VIDEO - Static variable in class io.agora.rtc2.AgoraMediaRecorder
2: Record video only.
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.
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.
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.
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.
superResolutionType - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RemoteVideoStats
The SuperResolution stats.
switchAgoraCDNLineByIndex(int) - Method in interface io.agora.mediaplayer.IMediaPlayer
Switch Agora CDN lines.
switchAgoraCDNSrc(String, boolean) - Method in interface io.agora.mediaplayer.IMediaPlayer
Switch the CDN source.
switchCamera() - Method in class io.agora.rtc2.RtcEngine
Switches between front and rear cameras.
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
 

T

takeScreenshot(String) - Method in interface io.agora.mediaplayer.IMediaPlayer
take screenshot while playing video
takeSnapshot(int, String) - Method in class io.agora.rtc2.RtcEngine
 
takeSnapshotEx(RtcConnection, int, String) - Method in class io.agora.rtc2.RtcEngineEx
 
targetBitrate - Variable in class io.agora.rtc2.EncodedVideoTrackOptions
Target bitrate (Kbps) for sending encoded video frame.
targetBitrate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The target bitrate (Kbps) of the current encoder.
targetFrameRate - Variable in class io.agora.rtc2.IRtcEngineEventHandler.LocalVideoStats
The target frame rate (fps) of the current encoder.
TCC_DISABLED - Static variable in class io.agora.rtc2.Constants
 
TCC_ENABLED - Static variable in class io.agora.rtc2.Constants
Transport CC enabled
TextureBuffer - Class in io.agora.base
Android texture buffer that glues together the necessary information together with a generic release callback.
TextureBuffer(javax.microedition.khronos.egl.EGLContext, int, int, VideoFrame.TextureBuffer.Type, int, Matrix, Handler, YuvConverter, Runnable) - Constructor for class io.agora.base.TextureBuffer
Constructs a new TextureBuffer backed by the given texture id.
TextureBuffer(android.opengl.EGLContext, int, int, VideoFrame.TextureBuffer.Type, int, Matrix, Handler, YuvConverter, Runnable) - Constructor for class io.agora.base.TextureBuffer
Constructs a new TextureBuffer backed by the given texture id.
TextureBuffer(EglBase.Context, int, int, VideoFrame.TextureBuffer.Type, int, Matrix, Handler, YuvConverter, Runnable) - Constructor for class io.agora.base.TextureBuffer
 
TextureBuffer(EglBase.Context, int, int, VideoFrame.TextureBuffer.Type, int, Matrix, Handler, YuvConverter, Runnable, int) - Constructor for class io.agora.base.TextureBuffer
Constructs a new TextureBuffer backed by the given texture id
TextureBufferHelper - Class in io.agora.base
 
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.
toI420() - Method in class io.agora.base.JavaI420Buffer
 
toI420() - Method in class io.agora.base.NV12Buffer
 
toI420() - Method in class io.agora.base.NV21Buffer
 
toI420() - Method in class io.agora.base.TextureBuffer
 
toI420() - Method in interface io.agora.base.VideoFrame.Buffer
Returns a memory-backed frame in I420 format.
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.
toString() - Method in class io.agora.base.AudioFrame
 
toString() - Method in class io.agora.base.FaceDetectionInfo
 
toString() - Method in class io.agora.base.VideoFrameMetaInfo
 
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.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.ChannelMediaOptions
 
toString() - Method in class io.agora.rtc2.DirectCdnStreamingMediaOptions
 
toString() - Method in class io.agora.rtc2.DirectCdnStreamingStats
 
toString() - Method in class io.agora.rtc2.LeaveChannelOptions
 
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.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.video.EncodedVideoFrameInfo
The track ID.
TranscodingUser() - Constructor for class io.agora.rtc2.live.LiveTranscoding.TranscodingUser
 
transform(int, int, int, int, int, int, int) - Method in class io.agora.base.JavaI420Buffer
 
transform(int, int, int, int, int, int, int) - Method in class io.agora.base.NV12Buffer
 
transform(int, int, int, int, int, int, int) - Method in class io.agora.base.NV21Buffer
 
transform(int, int, int, int, int, int, int) - Method in class io.agora.base.TextureBuffer
 
transform(int, int, int, int, int, int, int) - Method in interface io.agora.base.VideoFrame.Buffer
Apply crop/scale/mirror/rotate
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.
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.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

U

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.live.LiveTranscoding.TranscodingUser
ID of the user in the CDN live streaming.
uid - Variable in class io.agora.rtc2.UserInfo
The user ID.
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
ID of the user in the integer format.
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.
UNKNOWN - Static variable in class io.agora.rtc2.IRtcEngineEventHandler.Quality
Deprecated.
 
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.
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.
updateChannelMediaRelay(ChannelMediaRelayConfiguration) - Method in class io.agora.rtc2.RtcEngine
Updates the channels for media relay.
updateChannelMediaRelayEx(ChannelMediaRelayConfiguration, RtcConnection) - Method in class io.agora.rtc2.RtcEngineEx
Updates the channels for media stream relay
updateDirectCdnStreamingMediaOptions(DirectCdnStreamingMediaOptions) - Method in class io.agora.rtc2.RtcEngine
Change the media source during the pushing
updatePlayerPositionInfo(int, RemoteVoicePositionInfo) - Method in class io.agora.spatialaudio.IBaseSpatialAudioEngine
 
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(EGLContext) - Method in class io.agora.rtc2.RtcEngineInternal
Shared context of MediaCodec.
updateSharedContext(android.opengl.EGLContext) - Method in class io.agora.rtc2.RtcEngineInternal
 
upLength - Variable in class io.agora.spatialaudio.SpatialAudioZone
 
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.
useExternalAudioDevice() - Method in class io.agora.rtc2.RtcEngine
Use the external audio device.
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 getUserCount method.
userId - Variable in class io.agora.rtc2.live.LiveTranscoding.TranscodingUser
 
userId - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
userId(String) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
UserInfo - Class in io.agora.rtc2
 
UserInfo() - Constructor for class io.agora.rtc2.UserInfo
 
UserInfo(int, String) - Constructor for class io.agora.rtc2.UserInfo
 
UserOfflineReason() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.UserOfflineReason
Deprecated.
 
users - Variable in class io.agora.rtc2.IRtcEngineEventHandler.RtcStats
The number of users in the channel.

V

vad - Variable in class io.agora.rtc2.IRtcEngineEventHandler.AudioVolumeInfo
 
validate() - Method in class io.agora.rtc2.PublisherConfiguration
 
valueOf(String) - Static method in enum io.agora.base.VideoFrame.ColorSpace.Matrix
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.base.VideoFrame.ColorSpace.Primary
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.base.VideoFrame.ColorSpace.Range
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.base.VideoFrame.ColorSpace.Transfer
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.base.VideoFrame.SourceType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.base.VideoFrame.TextureBuffer.ContextType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.base.VideoFrame.TextureBuffer.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.mediaplayer.Constants.AudioDualMonoMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerError
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerEvent
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerMetadataType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerPreloadEvent
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.mediaplayer.Constants.MediaStreamType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.audio.AdvancedAudioOptions.AudioProcessingChannelsEnum
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.Constants.AUDIO_REVERB_TYPE
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.Constants.AudioMixingDualMonoMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.Constants.AudioProfile
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.Constants.AudioScenario
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.Constants.ExternalVideoSourceType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.Constants.LogLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.Constants.MediaSourceType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.Constants.MediaType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.Constants.SimulcastStreamMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.Constants.ThreadPriorityType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.Constants.VideoSourceType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.DirectCdnStreamingError
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.DirectCdnStreamingState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.live.LiveInjectStreamConfig.AudioSampleRateType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.live.LiveTranscoding.AudioCodecProfileType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.live.LiveTranscoding.AudioSampleRateType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.live.LiveTranscoding.VideoCodecProfileType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.live.LiveTranscoding.VideoCodecType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.RtcConnection.CONNECTION_STATE_TYPE
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_DIRECTION
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.video.VideoEncoderConfiguration.CODEC_CAP_MASK
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.video.VideoEncoderConfiguration.DEGRADATION_PREFERENCE
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.video.VideoEncoderConfiguration.FRAME_RATE
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.video.VideoEncoderConfiguration.MIRROR_MODE_TYPE
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.video.VideoEncoderConfiguration.ORIENTATION_MODE
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.agora.rtc2.video.VideoSubscriptionOptions.REMOTE_VIDEO_STREAM_TYPE
Returns the enum constant of this type with the specified name.
values() - Static method in enum io.agora.base.VideoFrame.ColorSpace.Matrix
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.base.VideoFrame.ColorSpace.Primary
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.base.VideoFrame.ColorSpace.Range
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.base.VideoFrame.ColorSpace.Transfer
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.base.VideoFrame.SourceType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.base.VideoFrame.TextureBuffer.ContextType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.base.VideoFrame.TextureBuffer.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.mediaplayer.Constants.AudioDualMonoMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerError
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerEvent
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerMetadataType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerPreloadEvent
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.mediaplayer.Constants.MediaPlayerState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.mediaplayer.Constants.MediaStreamType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.audio.AdvancedAudioOptions.AudioProcessingChannelsEnum
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.Constants.AUDIO_REVERB_TYPE
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.Constants.AudioMixingDualMonoMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.Constants.AudioProfile
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.Constants.AudioScenario
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.Constants.ExternalVideoSourceType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.Constants.LogLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.Constants.MediaSourceType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.Constants.MediaType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.Constants.SimulcastStreamMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.Constants.ThreadPriorityType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.Constants.VideoSourceType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.DirectCdnStreamingError
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.DirectCdnStreamingState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.live.LiveInjectStreamConfig.AudioSampleRateType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.live.LiveTranscoding.AudioCodecProfileType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.live.LiveTranscoding.AudioSampleRateType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.live.LiveTranscoding.VideoCodecProfileType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.live.LiveTranscoding.VideoCodecType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.RtcConnection.CONNECTION_STATE_TYPE
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.video.CameraCapturerConfiguration.CAMERA_DIRECTION
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.video.VideoEncoderConfiguration.CODEC_CAP_MASK
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.video.VideoEncoderConfiguration.DEGRADATION_PREFERENCE
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.video.VideoEncoderConfiguration.FRAME_RATE
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.video.VideoEncoderConfiguration.MIRROR_MODE_TYPE
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.video.VideoEncoderConfiguration.ORIENTATION_MODE
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.agora.rtc2.video.VideoSubscriptionOptions.REMOTE_VIDEO_STREAM_TYPE
Returns an array containing the constants of this enum type, 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_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_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 - Static variable in class io.agora.rtc2.Constants
 
VIDEO_CODEC_H264 - Static variable in class io.agora.rtc2.Constants
 
VIDEO_CODEC_H265 - Static variable in class io.agora.rtc2.Constants
 
VIDEO_CODEC_VP8 - Static variable in class io.agora.rtc2.Constants
Video codec types VIDEO_CODEC_TYPE
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_LEVEL_STRENGTH - Static variable in class io.agora.rtc2.video.VideoDenoiserOptions
`2`: Enhanced 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_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_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_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_SOURCE_CAMERA_PRIMARY - Static variable in class io.agora.rtc2.Constants
Video captured by the camera.
VIDEO_SOURCE_CAMERA_SECONDARY - Static variable in class io.agora.rtc2.Constants
Video captured by the secondary camera.
VIDEO_SOURCE_CUSTOM - Static variable in class io.agora.rtc2.Constants
Not define.
VIDEO_SOURCE_MEDIA_PLAYER - Static variable in class io.agora.rtc2.Constants
Video for media player sharing.
VIDEO_SOURCE_REMOTE - Static variable in class io.agora.rtc2.Constants
Remote video received from network.
VIDEO_SOURCE_RTC_IMAGE_GIF - Static variable in class io.agora.rtc2.Constants
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 - Static variable in class io.agora.rtc2.Constants
Video for png image.
VIDEO_SOURCE_SCREEN_PRIMARY - Static variable in class io.agora.rtc2.Constants
Video for screen sharing.
VIDEO_SOURCE_SCREEN_SECONDARY - Static variable in class io.agora.rtc2.Constants
Video for secondary screen sharing.
VIDEO_SOURCE_TRANSCODED - Static variable in class io.agora.rtc2.Constants
Video for transcoded.
VIDEO_SOURCE_UNKNOWN - Static variable in class io.agora.rtc2.Constants
 
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_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
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) - 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
 
VideoCanvas(View, int, int, int, int) - Constructor for class io.agora.rtc2.video.VideoCanvas
 
VideoCanvas(View, int, int, int, int, int) - Constructor for class io.agora.rtc2.video.VideoCanvas
 
VideoCanvas(View, int, int, int, int, int, Rect, 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(int, int) - Constructor for class io.agora.rtc2.video.VideoEncoderConfiguration.VideoDimensions
 
VideoDimensions() - 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(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(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.CODEC_CAP_MASK - Enum in io.agora.rtc2.video
Supported codec type bit mask.
VideoEncoderConfiguration.DEGRADATION_PREFERENCE - Enum in io.agora.rtc2.video
The video encoding degradation preference under limited bandwidth.
VideoEncoderConfiguration.FRAME_RATE - Enum in io.agora.rtc2.video
The frame rate of the video.
VideoEncoderConfiguration.MIRROR_MODE_TYPE - Enum in io.agora.rtc2.video
Video mirror mode types.
VideoEncoderConfiguration.ORIENTATION_MODE - Enum in io.agora.rtc2.video
The video orientation mode of the video.
VideoEncoderConfiguration.VideoDimensions - Class in io.agora.rtc2.video
The video dimensions.
VideoFrame - Class in io.agora.base
Java version of webrtc::VideoFrame and webrtc::VideoFrameBuffer.
VideoFrame(VideoFrame.Buffer, int, long) - Constructor for class io.agora.base.VideoFrame
Constructs a new VideoFrame backed by the given buffer.
VideoFrame(VideoFrame.Buffer, int, long, VideoFrame.ColorSpace, byte[], float, int) - Constructor for class io.agora.base.VideoFrame
 
VideoFrame.Buffer - Interface in io.agora.base
Implements image storage medium.
VideoFrame.ColorSpace - Interface in io.agora.base
 
VideoFrame.ColorSpace.Matrix - Enum in io.agora.base
 
VideoFrame.ColorSpace.Primary - Enum in io.agora.base
 
VideoFrame.ColorSpace.Range - Enum in io.agora.base
 
VideoFrame.ColorSpace.Transfer - Enum in io.agora.base
 
VideoFrame.I420Buffer - Interface in io.agora.base
Interface for I420 buffers.
VideoFrame.I422Buffer - Interface in io.agora.base
Interface for I420 buffers.
VideoFrame.RgbaBuffer - Interface in io.agora.base
 
VideoFrame.SourceType - Enum in io.agora.base
 
VideoFrame.TextureBuffer - Interface in io.agora.base
Interface for buffers that are stored as a single texture, either in OES or RGB format.
VideoFrame.TextureBuffer.ContextType - Enum in io.agora.base
 
VideoFrame.TextureBuffer.Type - Enum in io.agora.base
Texture type.
VideoFrameMetaInfo - Class in io.agora.base
 
VideoFrameMetaInfo() - Constructor for class io.agora.base.VideoFrameMetaInfo
 
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.rtc2.DirectCdnStreamingStats
Height of the video pushed by rtmp.
VideoProfile() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.VideoProfile
Deprecated.
 
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 in io.agora.rtc2.video
 
videoWidth - Variable in class io.agora.rtc2.DirectCdnStreamingStats
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(int, int, String, int) - Constructor for class io.agora.rtc2.video.VirtualBackgroundSource
 
VirtualBackgroundSource() - 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_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_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_NEUTRAL - Static variable in class io.agora.rtc2.Constants
A gender-neutral voice.
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_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).

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_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 - Variable in class io.agora.rtc2.live.LiveTranscoding
Deprecated.
Deprecated from v4.0.0. Use addWatermark instead.
WatermarkOptions - Class in io.agora.rtc2.video
Agora watermark options.
WatermarkOptions() - Constructor for class io.agora.rtc2.video.WatermarkOptions
 
WatermarkOptions.Rectangle - Class in io.agora.rtc2.video
The position and size of the watermark image.
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.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.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.WatermarkOptions.Rectangle
The width (pixels) of the watermark image.
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.
WIRELESS_SIGNAL_POOR - Static variable in class io.agora.rtc2.Constants
4: The local user's Wi-Fi or mobile network signal is weak.
withSequence(int) - Method in class io.agora.base.TextureBuffer
 
WLACC_MESSAGE_REASON_CHANNEL_CONGESTION - Static variable in class io.agora.rtc2.Constants
1: Channel congestion.
WLACC_MESSAGE_REASON_WEAK_SIGNAL - Static variable in class io.agora.rtc2.Constants
0: WIFI signal is weak.
WLACC_SUGGEST_ACTION_CHECK_5G - Static variable in class io.agora.rtc2.Constants
2: The user is advised to check whether the AP supports 5G band and enable 5G band (the aciton link is attached), or purchases an AP that supports 5G.
WLACC_SUGGEST_ACTION_CLOSE_TO_WIFI - Static variable in class io.agora.rtc2.Constants
0: Please get close to AP.
WLACC_SUGGEST_ACTION_CONNECT_SSID - Static variable in class io.agora.rtc2.Constants
1: The user is advised to connect to the prompted SSID.
WLACC_SUGGEST_ACTION_MODIFY_SSID - Static variable in class io.agora.rtc2.Constants
3: The user is advised to change the SSID of the 2.4G or 5G band (the aciton link is attached).
WlAccStats() - Constructor for class io.agora.rtc2.IRtcEngineEventHandler.WlAccStats
 
wrap(int, int, ByteBuffer, int, ByteBuffer, int, ByteBuffer, int, Runnable) - Static method in class io.agora.base.JavaI420Buffer
Wraps existing ByteBuffers into JavaI420Buffer object without copying the contents.
wrapTextureBuffer(int, int, VideoFrame.TextureBuffer.Type, int, Matrix) - Method in class io.agora.base.TextureBufferHelper
This can only be called from the |handler| thread.

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.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.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 offset from the top-left corner.

Y

y - Variable in class io.agora.rtc2.IRtcEngineEventHandler.AgoraFacePositionInfo
The y coordinate (px) of the human face in the local video.
y - Variable in class io.agora.rtc2.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.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 offset from the top-left corner.

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.video.AgoraImage
layer of image
zOrder - Variable in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
zOrder(int) - Method in class io.agora.rtc2.video.VideoCompositingLayout.Region
Deprecated.
 
A B C D E F G H I J L M N O P Q R S T U V W X Y Z 
Skip navigation links