Skip navigation links
A C D E F G I J K L M N O P R S U V W 

A

AES_128_ECB - Static variable in class io.agora.rtc.AgoraRtcService.CryptoMode
2: 128-bit AES encryption, ECB mode.
AES_128_GCM - Static variable in class io.agora.rtc.AgoraRtcService.CryptoMode
5: 128-bit AES encryption, GCM mode.
AES_128_GCM2 - Static variable in class io.agora.rtc.AgoraRtcService.CryptoMode
7: 128-bit AES encryption, GCM mode, v2.
AES_128_XTS - Static variable in class io.agora.rtc.AgoraRtcService.CryptoMode
1: 128-bit AES encryption, XTS mode.
AES_256_GCM - Static variable in class io.agora.rtc.AgoraRtcService.CryptoMode
6: 256-bit AES encryption, GCM mode.
AES_256_GCM2 - Static variable in class io.agora.rtc.AgoraRtcService.CryptoMode
8: 256-bit AES encryption, GCM mode, v2.
AES_256_XTS - Static variable in class io.agora.rtc.AgoraRtcService.CryptoMode
3: 256-bit AES encryption, XTS mode.
AgoraRtcEvents - Interface in io.agora.rtc
The SDK uses the AgoraRtcEvents interface class to send callbacks to the application, and the application inherits the methods of this interface class to retrieve these callbacks.
AgoraRtcService - Class in io.agora.rtc
The AgoraRtcService Class is the main interface class of the Agora SDK.
AgoraRtcService() - Constructor for class io.agora.rtc.AgoraRtcService
 
AgoraRtcService.AreaCode - Class in io.agora.rtc
 
AgoraRtcService.AudioCodecOption - Class in io.agora.rtc
Configure sdk built-in audio codec If AUDIO_CODEC_TYPE_OPUS is selected, your PCM data is encoded as OPUS and then streamed to Agora channel If AUDIO_CODEC_TYPE_G722 is selected, your PCM data is encoded as G722 and then streamed to Agora channel If you provide encoded audio data, such as AAC, instead of raw PCM, please disable audio codec by selecting AUDIO_CODEC_DISABLED
AgoraRtcService.AudioCodecType - Class in io.agora.rtc
Audio codec type list.
AgoraRtcService.AudioDataType - Class in io.agora.rtc
Audio data type list.
AgoraRtcService.AudioFrameInfo - Class in io.agora.rtc
 
AgoraRtcService.ChannelOptions - Class in io.agora.rtc
 
AgoraRtcService.CloudProxyType - Class in io.agora.rtc
 
AgoraRtcService.ConnectionIdSpecial - Class in io.agora.rtc
special connection id
AgoraRtcService.ConnectionInfo - Class in io.agora.rtc
connection info
AgoraRtcService.CryptoMode - Class in io.agora.rtc
Encryption mode.
AgoraRtcService.CryptoOption - Class in io.agora.rtc
Encryption option
AgoraRtcService.ErrorCode - Class in io.agora.rtc
 
AgoraRtcService.LicenseValidationErrorReason - Class in io.agora.rtc
 
AgoraRtcService.LogConfig - Class in io.agora.rtc
 
AgoraRtcService.LogLevel - Class in io.agora.rtc
 
AgoraRtcService.NetworkEventType - Class in io.agora.rtc
 
AgoraRtcService.RdtState - Class in io.agora.rtc
 
AgoraRtcService.RdtStatusInfo - Class in io.agora.rtc
 
AgoraRtcService.RdtStreamType - Class in io.agora.rtc
 
AgoraRtcService.RtcAudioProcessOption - Class in io.agora.rtc
The definition of the rtc_audio_process_options_t struct.
AgoraRtcService.RtcServiceOptions - Class in io.agora.rtc
 
AgoraRtcService.RtmErrCode - Class in io.agora.rtc
 
AgoraRtcService.UserOfflineReason - Class in io.agora.rtc
 
AgoraRtcService.VideoDataType - Class in io.agora.rtc
Video data type list.
AgoraRtcService.VideoFrameInfo - Class in io.agora.rtc
 
AgoraRtcService.VideoFrameType - Class in io.agora.rtc
 
AgoraRtcService.VideoStreamType - Class in io.agora.rtc
 
AgoraRtmEvents - Interface in io.agora.rtc
The SDK uses the AgoraRtmEvents interface class to send callbacks to the application, and the application inherits the methods of this interface class to retrieve these callbacks.
AgoraRtmEvents.RtmEventType - Class in io.agora.rtc
RTM event type list
AgoraRtmEvents.RtmMsgState - Class in io.agora.rtc
 
AREA_CODE_AF - Static variable in class io.agora.rtc.AgoraRtcService.AreaCode
Africa
AREA_CODE_AS - Static variable in class io.agora.rtc.AgoraRtcService.AreaCode
Asia, excluding Mainland China.
AREA_CODE_CN - Static variable in class io.agora.rtc.AgoraRtcService.AreaCode
Mainland China.
AREA_CODE_EU - Static variable in class io.agora.rtc.AgoraRtcService.AreaCode
Europe.
AREA_CODE_GLOB - Static variable in class io.agora.rtc.AgoraRtcService.AreaCode
(Default) Global.
AREA_CODE_HKMC - Static variable in class io.agora.rtc.AgoraRtcService.AreaCode
 
AREA_CODE_IN - Static variable in class io.agora.rtc.AgoraRtcService.AreaCode
India.
AREA_CODE_JP - Static variable in class io.agora.rtc.AgoraRtcService.AreaCode
Japan.
AREA_CODE_KR - Static variable in class io.agora.rtc.AgoraRtcService.AreaCode
South Korea
AREA_CODE_NA - Static variable in class io.agora.rtc.AgoraRtcService.AreaCode
North America.
AREA_CODE_OC - Static variable in class io.agora.rtc.AgoraRtcService.AreaCode
Oceania
AREA_CODE_OVS - Static variable in class io.agora.rtc.AgoraRtcService.AreaCode
The global area (except China)
AREA_CODE_RU - Static variable in class io.agora.rtc.AgoraRtcService.AreaCode
 
AREA_CODE_SA - Static variable in class io.agora.rtc.AgoraRtcService.AreaCode
South-American
AREA_CODE_US - Static variable in class io.agora.rtc.AgoraRtcService.AreaCode
 
AreaCode() - Constructor for class io.agora.rtc.AgoraRtcService.AreaCode
 
areaCode - Variable in class io.agora.rtc.AgoraRtcService.RtcServiceOptions
area code for regional restriction, Supported areas refer to class AreaCode and bit operations for multiple regions are supported
AUDIO_CODEC_DISABLED - Static variable in class io.agora.rtc.AgoraRtcService.AudioCodecType
0: OPUS
AUDIO_CODEC_TYPE_G711A - Static variable in class io.agora.rtc.AgoraRtcService.AudioCodecType
3: G711A
AUDIO_CODEC_TYPE_G711U - Static variable in class io.agora.rtc.AgoraRtcService.AudioCodecType
3: G711
AUDIO_CODEC_TYPE_G722 - Static variable in class io.agora.rtc.AgoraRtcService.AudioCodecType
2: G722
AUDIO_CODEC_TYPE_OPUS - Static variable in class io.agora.rtc.AgoraRtcService.AudioCodecType
1: OPUS
AUDIO_DATA_TYPE_AACLC - Static variable in class io.agora.rtc.AgoraRtcService.AudioDataType
8: AACLC
AUDIO_DATA_TYPE_AACLC_16K - Static variable in class io.agora.rtc.AgoraRtcService.AudioDataType
 
AUDIO_DATA_TYPE_AACLC_8K - Static variable in class io.agora.rtc.AgoraRtcService.AudioDataType
 
AUDIO_DATA_TYPE_G722 - Static variable in class io.agora.rtc.AgoraRtcService.AudioDataType
5: G722
AUDIO_DATA_TYPE_GENERIC - Static variable in class io.agora.rtc.AgoraRtcService.AudioDataType
253: GENERIC
AUDIO_DATA_TYPE_HEAAC - Static variable in class io.agora.rtc.AgoraRtcService.AudioDataType
9: HEAAC
AUDIO_DATA_TYPE_OPUS - Static variable in class io.agora.rtc.AgoraRtcService.AudioDataType
1: OPUS
AUDIO_DATA_TYPE_OPUSFB - Static variable in class io.agora.rtc.AgoraRtcService.AudioDataType
2: OPUSFB
AUDIO_DATA_TYPE_PCM - Static variable in class io.agora.rtc.AgoraRtcService.AudioDataType
100: PCM (audio codec should be enabled)
AUDIO_DATA_TYPE_PCMA - Static variable in class io.agora.rtc.AgoraRtcService.AudioDataType
3: PCMA
AUDIO_DATA_TYPE_PCMU - Static variable in class io.agora.rtc.AgoraRtcService.AudioDataType
4: PCMU
audioCodecOpt - Variable in class io.agora.rtc.AgoraRtcService.ChannelOptions
 
AudioCodecOption() - Constructor for class io.agora.rtc.AgoraRtcService.AudioCodecOption
 
audioCodecType - Variable in class io.agora.rtc.AgoraRtcService.AudioCodecOption
The audio codec type # AudioCodecType
AudioCodecType() - Constructor for class io.agora.rtc.AgoraRtcService.AudioCodecType
 
AudioDataType() - Constructor for class io.agora.rtc.AgoraRtcService.AudioDataType
 
AudioFrameInfo() - Constructor for class io.agora.rtc.AgoraRtcService.AudioFrameInfo
 
audioProcessOpt - Variable in class io.agora.rtc.AgoraRtcService.ChannelOptions
 
autoConnectRdt - Variable in class io.agora.rtc.AgoraRtcService.ChannelOptions
 
autoSubscribeAudio - Variable in class io.agora.rtc.AgoraRtcService.ChannelOptions
 
autoSubscribeVideo - Variable in class io.agora.rtc.AgoraRtcService.ChannelOptions
 

C

channelName - Variable in class io.agora.rtc.AgoraRtcService.ConnectionInfo
 
ChannelOptions() - Constructor for class io.agora.rtc.AgoraRtcService.ChannelOptions
 
CLOUD_PROXY_AUTO - Static variable in class io.agora.rtc.AgoraRtcService.CloudProxyType
 
CLOUD_PROXY_NONE - Static variable in class io.agora.rtc.AgoraRtcService.CloudProxyType
 
CLOUD_PROXY_TCP - Static variable in class io.agora.rtc.AgoraRtcService.CloudProxyType
 
CLOUD_PROXY_UDP - Static variable in class io.agora.rtc.AgoraRtcService.CloudProxyType
 
CloudProxyType() - Constructor for class io.agora.rtc.AgoraRtcService.CloudProxyType
 
configLog(int, int) - Method in class io.agora.rtc.AgoraRtcService
Set the log file configuration.
CONNECTION_ID_ALL - Static variable in class io.agora.rtc.AgoraRtcService.ConnectionIdSpecial
 
CONNECTION_ID_INVALID - Static variable in class io.agora.rtc.AgoraRtcService.ConnectionIdSpecial
 
ConnectionIdSpecial() - Constructor for class io.agora.rtc.AgoraRtcService.ConnectionIdSpecial
 
ConnectionInfo() - Constructor for class io.agora.rtc.AgoraRtcService.ConnectionInfo
 
connId - Variable in class io.agora.rtc.AgoraRtcService.ConnectionInfo
 
connId - Variable in class io.agora.rtc.AgoraRtcService.RdtStatusInfo
 
createConnection() - Method in class io.agora.rtc.AgoraRtcService
 
CryptoMode() - Constructor for class io.agora.rtc.AgoraRtcService.CryptoMode
 
cryptoOpt - Variable in class io.agora.rtc.AgoraRtcService.ChannelOptions
 
CryptoOption() - Constructor for class io.agora.rtc.AgoraRtcService.CryptoOption
 

D

dataType - Variable in class io.agora.rtc.AgoraRtcService.AudioFrameInfo
Audio codec type, reference #AudioDataType.
dataType - Variable in class io.agora.rtc.AgoraRtcService.VideoFrameInfo
The video codec: #VideoDataType.
destroyConnection(int) - Method in class io.agora.rtc.AgoraRtcService
 
domainLimit - Variable in class io.agora.rtc.AgoraRtcService.RtcServiceOptions
Determines whether to enable domain limit.

E

enable - Variable in class io.agora.rtc.AgoraRtcService.CryptoOption
 
enableAec - Variable in class io.agora.rtc.AgoraRtcService.RtcAudioProcessOption
whether to enable uplink aec
enableAudioJitterBuffer - Variable in class io.agora.rtc.AgoraRtcService.ChannelOptions
 
enableAudioMixer - Variable in class io.agora.rtc.AgoraRtcService.ChannelOptions
 
enableAudioProcess - Variable in class io.agora.rtc.AgoraRtcService.RtcAudioProcessOption
whether to enable audio process
enableDownlinkAec - Variable in class io.agora.rtc.AgoraRtcService.RtcAudioProcessOption
whether to enable downlink aec
enableDumpData - Variable in class io.agora.rtc.AgoraRtcService.RtcAudioProcessOption
whether to dump audio data from audio process
enableNs - Variable in class io.agora.rtc.AgoraRtcService.RtcAudioProcessOption
whether to enable ns
ERR_AUDIO_DECODER_NOT_MATCH_AUDIO_FRAME - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
Audio decoder does not match incoming audio data type.
ERR_CLIENT_IS_BANNED_BY_SERVER - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
Client is banned by the server
ERR_DECRYPTION_FAILED - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
Decryption fails.
ERR_FAILED - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
General error
ERR_INVALID_APP_ID - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
App ID is invalid.
ERR_INVALID_CHANNEL_NAME - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
Channel is invalid.
ERR_INVALID_TOKEN - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
Token is invalid due to reasons belows: - If application certificate is enabled on the Dashboard, valid token SHOULD be set when invoke.
ERR_JOIN_CHANNEL_REJECTED - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
Request to join channel is rejected.
ERR_LICENSE_DIFF_DEVICES - Static variable in class io.agora.rtc.AgoraRtcService.LicenseValidationErrorReason
5: Same license used in different devices at the same time
ERR_LICENSE_EXPIRE - Static variable in class io.agora.rtc.AgoraRtcService.LicenseValidationErrorReason
2: License expired
ERR_LICENSE_INTERNAL - Static variable in class io.agora.rtc.AgoraRtcService.LicenseValidationErrorReason
99: SDK internal error
ERR_LICENSE_INVALID - Static variable in class io.agora.rtc.AgoraRtcService.LicenseValidationErrorReason
1: Invalid license
ERR_LICENSE_LIMITED_PERIOD - Static variable in class io.agora.rtc.AgoraRtcService.LicenseValidationErrorReason
4: License use in limited period
ERR_LICENSE_MINUTES_EXCEED - Static variable in class io.agora.rtc.AgoraRtcService.LicenseValidationErrorReason
3: Exceed license minutes limit
ERR_LOOKUP_CHANNEL_REJECTED - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
Server rejected request to look up channel.
ERR_NET_DOWN - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
Network is unavailable
ERR_NO_AUDIO_DECODER_TO_HANDLE_AUDIO_FRAME - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
Audio decoder does not match incoming audio data type.
ERR_NO_SERVER_RESOURCES - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
Fails to get server resources in the specified region.
ERR_OKAY - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
No error.
ERR_OPEN_CHANNEL_INVALID_TICKET - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
Ticket to open channel is invalid
ERR_OPEN_CHANNEL_REJECTED - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
Server rejected request to open channel.
ERR_OPEN_CHANNEL_TRY_NEXT_VOS - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
Try another server.
ERR_RTM_FAILED - Static variable in class io.agora.rtc.AgoraRtcService.RtmErrCode
general error
ERR_RTM_INVALID_APP_ID - Static variable in class io.agora.rtc.AgoraRtcService.RtmErrCode
invalid appid
ERR_RTM_INVALID_RTM_UID - Static variable in class io.agora.rtc.AgoraRtcService.RtmErrCode
invalid rtm uid
ERR_RTM_INVALID_TOKEN - Static variable in class io.agora.rtc.AgoraRtcService.RtmErrCode
invalid token
ERR_RTM_LOGIN_INVALID_TOKEN - Static variable in class io.agora.rtc.AgoraRtcService.RtmErrCode
The token is invalid.
ERR_RTM_LOGIN_NOT_AUTHORIZED - Static variable in class io.agora.rtc.AgoraRtcService.RtmErrCode
Unauthorized login.
ERR_RTM_LOGIN_REJECTED - Static variable in class io.agora.rtc.AgoraRtcService.RtmErrCode
Login is rejected by the server.
ERR_RTM_OK - Static variable in class io.agora.rtc.AgoraRtcService.RtmErrCode
no error
ERR_RTM_TOKEN_EXPIRED - Static variable in class io.agora.rtc.AgoraRtcService.RtmErrCode
Authorized Timestamp expired
ERR_SEND_VIDEO_OVER_BANDWIDTH_LIMIT - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
Sending video data too fast and over the bandwidth limit.
ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
Switching roles failed.
ERR_TOKEN_EXPIRED - Static variable in class io.agora.rtc.AgoraRtcService.ErrorCode
Token expired due to reasons belows: - Authorized Timestamp expired: The timestamp is represented by the number of seconds elapsed since 1/1/1970.
ErrorCode() - Constructor for class io.agora.rtc.AgoraRtcService.ErrorCode
 
errToStr(int) - Method in class io.agora.rtc.AgoraRtcService
Converts an error code to a static string.

F

fini() - Method in class io.agora.rtc.AgoraRtcService
Release all resource allocated by Agora RTC SDK init method.
frameRate - Variable in class io.agora.rtc.AgoraRtcService.VideoFrameInfo
The number of video frames per second, can be set 0-60.
frameType - Variable in class io.agora.rtc.AgoraRtcService.VideoFrameInfo
The frame type of the encoded video frame: #VideoFrameType.

G

getConnectionInfo(int, AgoraRtcService.ConnectionInfo) - Method in class io.agora.rtc.AgoraRtcService
 
getRdtStatusInfo(int, int, AgoraRtcService.RdtStatusInfo) - Method in class io.agora.rtc.AgoraRtcService
Get rdt tunnel status info
getVersion() - Method in class io.agora.rtc.AgoraRtcService
Gets version of the SDK.

I

init(String, AgoraRtcEvents, AgoraRtcService.RtcServiceOptions) - Method in class io.agora.rtc.AgoraRtcService
Initializes the Agora RTSA service.
io.agora.rtc - package io.agora.rtc
 

J

joinChannel(int, String, int, String, AgoraRtcService.ChannelOptions) - Method in class io.agora.rtc.AgoraRtcService
 

K

key - Variable in class io.agora.rtc.AgoraRtcService.CryptoOption
 

L

leaveChannel(int) - Method in class io.agora.rtc.AgoraRtcService
 
licenseGenCredential() - Method in class io.agora.rtc.AgoraRtcService
Generate a credential which is a unique device identifier.
LicenseValidationErrorReason() - Constructor for class io.agora.rtc.AgoraRtcService.LicenseValidationErrorReason
 
licenseValue - Variable in class io.agora.rtc.AgoraRtcService.RtcServiceOptions
license value return when license actived, the max license_value length is 32 Supported character scopes are: - The 26 lowercase English letters: a to z - The 26 uppercase English letters: A to Z - The 10 numbers: 0 to 9
licenseVerify(String, String) - Method in class io.agora.rtc.AgoraRtcService
Authenticate the SDK licence.
logCfg - Variable in class io.agora.rtc.AgoraRtcService.RtcServiceOptions
sdk log config
LogConfig() - Constructor for class io.agora.rtc.AgoraRtcService.LogConfig
 
logDisable - Variable in class io.agora.rtc.AgoraRtcService.LogConfig
 
logDisableDesensitize - Variable in class io.agora.rtc.AgoraRtcService.LogConfig
 
loginRtm(String, String, AgoraRtmEvents) - Method in class io.agora.rtc.AgoraRtcService
Login agora RTM service
logLevel - Variable in class io.agora.rtc.AgoraRtcService.LogConfig
 
LogLevel() - Constructor for class io.agora.rtc.AgoraRtcService.LogLevel
 
logoutRtm() - Method in class io.agora.rtc.AgoraRtcService
Logout agora RTM service
logPath - Variable in class io.agora.rtc.AgoraRtcService.LogConfig
 

M

mode - Variable in class io.agora.rtc.AgoraRtcService.CryptoOption
 
muteLocalAudio(int, boolean) - Method in class io.agora.rtc.AgoraRtcService
 
muteLocalVideo(int, boolean) - Method in class io.agora.rtc.AgoraRtcService
 
muteRemoteAudio(int, int, boolean) - Method in class io.agora.rtc.AgoraRtcService
 
muteRemoteVideo(int, int, boolean) - Method in class io.agora.rtc.AgoraRtcService
 

N

NETWORK_EVENT_CHANGE - Static variable in class io.agora.rtc.AgoraRtcService.NetworkEventType
 
NETWORK_EVENT_DOWN - Static variable in class io.agora.rtc.AgoraRtcService.NetworkEventType
 
NETWORK_EVENT_UP - Static variable in class io.agora.rtc.AgoraRtcService.NetworkEventType
 
NetworkEventType() - Constructor for class io.agora.rtc.AgoraRtcService.NetworkEventType
 
notifyNetworkEvent(int) - Method in class io.agora.rtc.AgoraRtcService
Set network state

O

onAudioData(int, int, int, byte[], AgoraRtcService.AudioFrameInfo) - Method in interface io.agora.rtc.AgoraRtcEvents
Occurs when receiving the audio frame of a remote user in the channel.
onConnectionLost(int) - Method in interface io.agora.rtc.AgoraRtcEvents
Occurs when connection of channel is disconnected from the server more than 10s
onError(int, int, String) - Method in interface io.agora.rtc.AgoraRtcEvents
Report error message during runtime.
onJoinChannelSuccess(int, int, int) - Method in interface io.agora.rtc.AgoraRtcEvents
Occurs when local user joins channel successfully.
onKeyFrameGenReq(int, int, int) - Method in interface io.agora.rtc.AgoraRtcEvents
Occurs when a remote user requests a keyframe.
onLicenseValidationFailure(int, int) - Method in interface io.agora.rtc.AgoraRtcEvents
Occurs when connection license verification fails You can know the reason accordding to error code
onMediaCtrlMsg(int, int, byte[]) - Method in interface io.agora.rtc.AgoraRtcEvents
Occur when receive a media ctrl message.
onMixedAudioData(int, byte[], AgoraRtcService.AudioFrameInfo) - Method in interface io.agora.rtc.AgoraRtcEvents
Occurs every 20ms.
onRdtMsg(int, int, int, byte[]) - Method in interface io.agora.rtc.AgoraRtcEvents
Occur when receive rdt message from uid
onRdtState(int, int, int) - Method in interface io.agora.rtc.AgoraRtcEvents
Occur when user rdt state changed
onReconnecting(int) - Method in interface io.agora.rtc.AgoraRtcEvents
Occurs when the connection of channel is interrupt or keepalive timeout(4s).
onRejoinChannelSuccess(int, int, int) - Method in interface io.agora.rtc.AgoraRtcEvents
Occurs when local user rejoins channel successfully after disconnect When channel loses connection with server due to network problems, SDK will retry to connect automatically.
onRtmData(String, byte[]) - Method in interface io.agora.rtc.AgoraRtmEvents
Occur when data comes from RTM
onRtmEvent(String, int, int) - Method in interface io.agora.rtc.AgoraRtmEvents
Occur when RTM event occurs
onSendRtmDataResult(String, int, int) - Method in interface io.agora.rtc.AgoraRtmEvents
Report the result of the "onSendRtmDataResult" method call
onTargetBitrateChanged(int, int) - Method in interface io.agora.rtc.AgoraRtcEvents
Occurs when network bandwidth change is detected.
onTokenPrivilegeWillExpire(int, String) - Method in interface io.agora.rtc.AgoraRtcEvents
Occurs when token will expired.
onUserJoined(int, int, int) - Method in interface io.agora.rtc.AgoraRtcEvents
Occurs when a remote user joins channel successfully.
onUserMuteAudio(int, int, boolean) - Method in interface io.agora.rtc.AgoraRtcEvents
Occurs when a remote user sends notification before enable/disable sending audio.
onUserMuteVideo(int, int, boolean) - Method in interface io.agora.rtc.AgoraRtcEvents
Occurs when a remote user sends notification before enable/disable sending video.
onUserOffline(int, int, int) - Method in interface io.agora.rtc.AgoraRtcEvents
Occur when remote user leaves the channel.
onVideoData(int, int, int, byte[], AgoraRtcService.VideoFrameInfo) - Method in interface io.agora.rtc.AgoraRtcEvents
Occurs when receiving the video frame of a remote user in the channel.

P

pcmChannelNum - Variable in class io.agora.rtc.AgoraRtcService.AudioCodecOption
The number of channels.
pcmDuration - Variable in class io.agora.rtc.AgoraRtcService.AudioCodecOption
Pcm duration.
pcmSampleRate - Variable in class io.agora.rtc.AgoraRtcService.AudioCodecOption
The sample rate of pcm data.
peerUid - Variable in class io.agora.rtc.AgoraRtcService.RdtStatusInfo
 
productId - Variable in class io.agora.rtc.AgoraRtcService.RtcServiceOptions
the product_id (device name) the max product_id_length is 63

R

RDT_STATE_BLOCKED - Static variable in class io.agora.rtc.AgoraRtcService.RdtState
 
RDT_STATE_BROKEN - Static variable in class io.agora.rtc.AgoraRtcService.RdtState
 
RDT_STATE_CLOSED - Static variable in class io.agora.rtc.AgoraRtcService.RdtState
 
RDT_STATE_OPENED - Static variable in class io.agora.rtc.AgoraRtcService.RdtState
 
RDT_STATE_PENDING - Static variable in class io.agora.rtc.AgoraRtcService.RdtState
 
RDT_STREAM_CMD - Static variable in class io.agora.rtc.AgoraRtcService.RdtStreamType
 
RDT_STREAM_COUNT - Static variable in class io.agora.rtc.AgoraRtcService.RdtStreamType
 
RDT_STREAM_DATA - Static variable in class io.agora.rtc.AgoraRtcService.RdtStreamType
 
RdtState() - Constructor for class io.agora.rtc.AgoraRtcService.RdtState
 
RdtStatusInfo() - Constructor for class io.agora.rtc.AgoraRtcService.RdtStatusInfo
 
RdtStreamType() - Constructor for class io.agora.rtc.AgoraRtcService.RdtStreamType
 
recvQueueSize - Variable in class io.agora.rtc.AgoraRtcService.RdtStatusInfo
 
refDataFromSdk - Variable in class io.agora.rtc.AgoraRtcService.RtcAudioProcessOption
reference data from sdk
renewToken(int, String) - Method in class io.agora.rtc.AgoraRtcService
 
requestVideoKeyFrame(int, int, int) - Method in class io.agora.rtc.AgoraRtcService
 
rotation - Variable in class io.agora.rtc.AgoraRtcService.VideoFrameInfo
The rotation information of the encoded video frame: #VIDEO_ORIENTATIO
RTC_LOG_ALERT - Static variable in class io.agora.rtc.AgoraRtcService.LogLevel
Alert log level
RTC_LOG_CRIT - Static variable in class io.agora.rtc.AgoraRtcService.LogLevel
Crit log level
RTC_LOG_DEBUG - Static variable in class io.agora.rtc.AgoraRtcService.LogLevel
Debug log level
RTC_LOG_DEFAULT - Static variable in class io.agora.rtc.AgoraRtcService.LogLevel
Default log level
RTC_LOG_EMERG - Static variable in class io.agora.rtc.AgoraRtcService.LogLevel
Emerg log level
RTC_LOG_ERROR - Static variable in class io.agora.rtc.AgoraRtcService.LogLevel
Error log level
RTC_LOG_INFO - Static variable in class io.agora.rtc.AgoraRtcService.LogLevel
Info log level
RTC_LOG_NOTICE - Static variable in class io.agora.rtc.AgoraRtcService.LogLevel
Notice log level, default log level is notice
RTC_LOG_WARNING - Static variable in class io.agora.rtc.AgoraRtcService.LogLevel
Warning log level
RtcAudioProcessOption() - Constructor for class io.agora.rtc.AgoraRtcService.RtcAudioProcessOption
 
RtcServiceOptions() - Constructor for class io.agora.rtc.AgoraRtcService.RtcServiceOptions
 
RTM_EVENT_TYPE_EXIT - Static variable in class io.agora.rtc.AgoraRtmEvents.RtmEventType
2: EXIT
RTM_EVENT_TYPE_KICKOFF - Static variable in class io.agora.rtc.AgoraRtmEvents.RtmEventType
1: KICKOFF
RTM_EVENT_TYPE_LOGIN - Static variable in class io.agora.rtc.AgoraRtmEvents.RtmEventType
0: LOGIN
RTM_MSG_STATE_INIT - Static variable in class io.agora.rtc.AgoraRtmEvents.RtmMsgState
 
RTM_MSG_STATE_RECEIVED - Static variable in class io.agora.rtc.AgoraRtmEvents.RtmMsgState
 
RTM_MSG_STATE_TIMEOUT - Static variable in class io.agora.rtc.AgoraRtmEvents.RtmMsgState
 
RTM_MSG_STATE_UNREACHABLE - Static variable in class io.agora.rtc.AgoraRtmEvents.RtmMsgState
 
RtmErrCode() - Constructor for class io.agora.rtc.AgoraRtcService.RtmErrCode
 
RtmEventType() - Constructor for class io.agora.rtc.AgoraRtmEvents.RtmEventType
 
RtmMsgState() - Constructor for class io.agora.rtc.AgoraRtmEvents.RtmMsgState
 

S

salt - Variable in class io.agora.rtc.AgoraRtcService.CryptoOption
 
sendAudioData(int, byte[], AgoraRtcService.AudioFrameInfo) - Method in class io.agora.rtc.AgoraRtcService
 
sendMediaCtrlMsg(int, int, byte[]) - Method in class io.agora.rtc.AgoraRtcService
Send an message to all channels OR specific channel.
sendQueueSize - Variable in class io.agora.rtc.AgoraRtcService.RdtStatusInfo
 
sendRdtMsg(int, int, int, byte[]) - Method in class io.agora.rtc.AgoraRtcService
Send Reliable message to remote uid in channel
sendRtm(String, byte[], int) - Method in class io.agora.rtc.AgoraRtcService
Send data through reliable data channel (RTM)
sendVideoData(int, byte[], AgoraRtcService.VideoFrameInfo) - Method in class io.agora.rtc.AgoraRtcService
 
setBweParam(int, int, int, int) - Method in class io.agora.rtc.AgoraRtcService
 
setCloudProxy(int) - Method in class io.agora.rtc.AgoraRtcService
Set cloud proxy type
setFecConfig(int, boolean, int) - Method in class io.agora.rtc.AgoraRtcService
 
setLogLevel(int) - Method in class io.agora.rtc.AgoraRtcService
Set the log level.
setParams(String) - Method in class io.agora.rtc.AgoraRtcService
Set config params
SM4_128_ECB - Static variable in class io.agora.rtc.AgoraRtcService.CryptoMode
4: 128-bit SM4 encryption, ECB mode.
state - Variable in class io.agora.rtc.AgoraRtcService.RdtStatusInfo
 
streamType - Variable in class io.agora.rtc.AgoraRtcService.VideoFrameInfo
The video stream type: #VideoStreamType

U

uid - Variable in class io.agora.rtc.AgoraRtcService.ConnectionInfo
 
USER_OFFLINE_BECOME_AUDIENCE - Static variable in class io.agora.rtc.AgoraRtcService.UserOfflineReason
2: The user switches the client role from the host to the audience.
USER_OFFLINE_DROPPED - Static variable in class io.agora.rtc.AgoraRtcService.UserOfflineReason
1: Remote user is dropped due to timeout
USER_OFFLINE_QUIT - Static variable in class io.agora.rtc.AgoraRtcService.UserOfflineReason
0: Remote user leaves channel actively
UserOfflineReason() - Constructor for class io.agora.rtc.AgoraRtcService.UserOfflineReason
 

V

VIDEO_DATA_TYPE_GENERIC - Static variable in class io.agora.rtc.AgoraRtcService.VideoDataType
6: generic
VIDEO_DATA_TYPE_GENERIC_JPEG - Static variable in class io.agora.rtc.AgoraRtcService.VideoDataType
20: generic JPEG
VIDEO_DATA_TYPE_H264 - Static variable in class io.agora.rtc.AgoraRtcService.VideoDataType
2: H264
VIDEO_DATA_TYPE_H265 - Static variable in class io.agora.rtc.AgoraRtcService.VideoDataType
 
VIDEO_DATA_TYPE_YUV420 - Static variable in class io.agora.rtc.AgoraRtcService.VideoDataType
0: YUV420
VIDEO_FRAME_AUTO_DETECT - Static variable in class io.agora.rtc.AgoraRtcService.VideoFrameType
0: unknow frame type If you set it ,the SDK will judge the frame type
VIDEO_FRAME_DELTA - Static variable in class io.agora.rtc.AgoraRtcService.VideoFrameType
4: delta frame, e.g: P-Frame
VIDEO_FRAME_KEY - Static variable in class io.agora.rtc.AgoraRtcService.VideoFrameType
1: key frame
VIDEO_STREAM_HIGH - Static variable in class io.agora.rtc.AgoraRtcService.VideoStreamType
0: The high-quality video stream, which has a higher resolution and bitrate.
VIDEO_STREAM_LOW - Static variable in class io.agora.rtc.AgoraRtcService.VideoStreamType
1: The low-quality video stream, which has a lower resolution and bitrate.
VideoDataType() - Constructor for class io.agora.rtc.AgoraRtcService.VideoDataType
 
VideoFrameInfo() - Constructor for class io.agora.rtc.AgoraRtcService.VideoFrameInfo
 
VideoFrameType() - Constructor for class io.agora.rtc.AgoraRtcService.VideoFrameType
 
VideoStreamType() - Constructor for class io.agora.rtc.AgoraRtcService.VideoStreamType
 

W

WARN_RTM_LOOKUP_CHANNEL_REJECTED - Static variable in class io.agora.rtc.AgoraRtcService.RtmErrCode
The server rejected the request to look up the channel
A C D E F G I J K L M N O P R S U V W 
Skip navigation links