Classes

enum  AudioProfile
 
enum  AudioScenario
 
enum  MediaType
 

Static Public Attributes

static final int QUALITY_UNKNOWN = 0
 
static final int QUALITY_EXCELLENT = 1
 
static final int QUALITY_GOOD = 2
 
static final int QUALITY_POOR = 3
 
static final int QUALITY_BAD = 4
 
static final int QUALITY_VBAD = 5
 
static final int QUALITY_DOWN = 6
 
static final int WARN_INVALID_VIEW = 8
 
static final int WARN_INIT_VIDEO = 16
 
static final int WARN_PENDING = 20
 
static final int WARN_NO_AVAILABLE_CHANNEL = 103
 
static final int WARN_LOOKUP_CHANNEL_TIMEOUT = 104
 
static final int WARN_LOOKUP_CHANNEL_REJECTED = 105
 
static final int WARN_OPEN_CHANNEL_TIMEOUT = 106
 
static final int WARN_OPEN_CHANNEL_REJECTED = 107
 
static final int WARN_SWITCH_LIVE_VIDEO_TIMEOUT = 111
 
static final int WARN_SET_CLIENT_ROLE_TIMEOUT = 118
 
static final int WARN_SET_CLIENT_ROLE_NOT_AUTHORIZED = 119
 
static final int WARN_OPEN_CHANNEL_INVALID_TICKET = 121
 
static final int WARN_OPEN_CHANNEL_TRY_NEXT_VOS = 122
 
static final int WARN_AUDIO_MIXING_OPEN_ERROR = 701
 
static final int WARN_ADM_RUNTIME_PLAYOUT_WARNING = 1014
 
static final int WARN_ADM_RUNTIME_RECORDING_WARNING = 1016
 
static final int WARN_ADM_RECORD_AUDIO_SILENCE = 1019
 
static final int WARN_ADM_RECORD_AUDIO_LOWLEVEL = 1031
 
static final int WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL = 1032
 
static final int WARN_ADM_RECORD_IS_OCCUPIED = 1033
 
static final int WARN_APM_HOWLING = 1051
 
static final int WARN_ADM_GLITCH_STATE = 1052
 
static final int WARN_ADM_IMPROPER_SETTINGS = 1053
 
static final int ERR_OK = 0
 
static final int ERR_FAILED = 1
 
static final int ERR_INVALID_ARGUMENT = 2
 
static final int ERR_NOT_READY = 3
 
static final int ERR_NOT_SUPPORTED = 4
 
static final int ERR_REFUSED = 5
 
static final int ERR_BUFFER_TOO_SMALL = 6
 
static final int ERR_NOT_INITIALIZED = 7
 
static final int ERR_NO_PERMISSION = 9
 
static final int ERR_TIMEDOUT = 10
 
static final int ERR_CANCELED = 11
 
static final int ERR_TOO_OFTEN = 12
 
static final int ERR_BIND_SOCKET = 13
 
static final int ERR_NET_DOWN = 14
 
static final int ERR_NET_NOBUFS = 15
 
static final int ERR_JOIN_CHANNEL_REJECTED = 17
 
static final int ERR_LEAVE_CHANNEL_REJECTED = 18
 
static final int ERR_ALREADY_IN_USE = 19
 
static final int ERR_INVALID_APP_ID = 101
 
static final int ERR_INVALID_CHANNEL_NAME = 102
 
static final int ERR_TOKEN_EXPIRED = 109
 
static final int ERR_INVALID_TOKEN = 110
 
static final int ERR_CONNECTION_INTERRUPTED = 111
 
static final int ERR_CONNECTION_LOST = 112
 
static final int ERR_NOT_IN_CHANNEL = 113
 
static final int ERR_SIZE_TOO_LARGE = 114
 
static final int ERR_BITRATE_LIMIT = 115
 
static final int ERR_TOO_MANY_DATA_STREAMS = 116
 
static final int ERR_DECRYPTION_FAILED = 120
 
static final int ERR_CLIENT_IS_BANNED_BY_SERVER = 123
 
static final int ERR_WATERMARK_PARAM = 124
 
static final int ERR_WATERMARK_PATH = 125
 
static final int ERR_WATERMARK_PNG = 126
 
static final int ERR_WATERMARKR_INFO = 127
 
static final int ERR_WATERMARK_ARGB = 128
 
static final int ERR_WATERMARK_READ = 129
 
static final int ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISHED = 130
 
static final int ERR_LOAD_MEDIA_ENGINE = 1001
 
static final int ERR_START_CALL = 1002
 
static final int ERR_START_CAMERA = 1003
 
static final int ERR_START_VIDEO_RENDER = 1004
 
static final int ERR_ADM_GENERAL_ERROR = 1005
 
static final int ERR_ADM_JAVA_RESOURCE = 1006
 
static final int ERR_ADM_SAMPLE_RATE = 1007
 
static final int ERR_ADM_INIT_PLAYOUT = 1008
 
static final int ERR_ADM_START_PLAYOUT = 1009
 
static final int ERR_ADM_STOP_PLAYOUT = 1010
 
static final int ERR_ADM_INIT_RECORDING = 1011
 
static final int ERR_ADM_START_RECORDING = 1012
 
static final int ERR_ADM_STOP_RECORDING = 1013
 
static final int ERR_ADM_RUNTIME_PLAYOUT_ERROR = 1015
 
static final int ERR_ADM_RUNTIME_RECORDING_ERROR = 1017
 
static final int ERR_ADM_RECORD_AUDIO_FAILED = 1018
 
static final int ERR_ADM_INIT_LOOPBACK = 1022
 
static final int ERR_ADM_START_LOOPBACK = 1023
 
static final int ERR_AUDIO_BT_SCO_FAILED = 1030
 
static final int ERR_ADM_NO_RECORDING_DEVICE = 1359
 
static final int ERR_ADM_NO_PLAYOUT_DEVICE = 1360
 
static final int ERR_VDM_CAMERA_NOT_AUTHORIZED = 1501
 
static final int ERR_VCM_UNKNOWN_ERROR = 1600
 
static final int ERR_VCM_ENCODER_INIT_ERROR = 1601
 
static final int ERR_VCM_ENCODER_ENCODE_ERROR = 1602
 
static final int ERR_VCM_ENCODER_SET_ERROR = 1603
 
static final int VIDEO_PROFILE_120P = 0
 
static final int VIDEO_PROFILE_120P_3 = 2
 
static final int VIDEO_PROFILE_180P = 10
 
static final int VIDEO_PROFILE_180P_3 = 12
 
static final int VIDEO_PROFILE_180P_4 = 13
 
static final int VIDEO_PROFILE_240P = 20
 
static final int VIDEO_PROFILE_240P_3 = 22
 
static final int VIDEO_PROFILE_240P_4 = 23
 
static final int VIDEO_PROFILE_360P = 30
 
static final int VIDEO_PROFILE_360P_3 = 32
 
static final int VIDEO_PROFILE_360P_4 = 33
 
static final int VIDEO_PROFILE_360P_6 = 35
 
static final int VIDEO_PROFILE_360P_7 = 36
 
static final int VIDEO_PROFILE_360P_8 = 37
 
static final int VIDEO_PROFILE_360P_9 = 38
 
static final int VIDEO_PROFILE_360P_10 = 39
 
static final int VIDEO_PROFILE_360P_11 = 100
 
static final int VIDEO_PROFILE_480P = 40
 
static final int VIDEO_PROFILE_480P_3 = 42
 
static final int VIDEO_PROFILE_480P_4 = 43
 
static final int VIDEO_PROFILE_480P_6 = 45
 
static final int VIDEO_PROFILE_480P_8 = 47
 
static final int VIDEO_PROFILE_480P_9 = 48
 
static final int VIDEO_PROFILE_480P_10 = 49
 
static final int VIDEO_PROFILE_720P = 50
 
static final int VIDEO_PROFILE_720P_3 = 52
 
static final int VIDEO_PROFILE_720P_5 = 54
 
static final int VIDEO_PROFILE_720P_6 = 55
 
static final int VIDEO_PROFILE_1080P = 60
 
static final int VIDEO_PROFILE_1080P_3 = 62
 
static final int VIDEO_PROFILE_1080P_5 = 64
 
static final int VIDEO_PROFILE_1440P = 66
 
static final int VIDEO_PROFILE_1440P_2 = 67
 
static final int VIDEO_PROFILE_4K = 70
 
static final int VIDEO_PROFILE_4K_3 = 72
 
static final int VIDEO_PROFILE_DEFAULT = VIDEO_PROFILE_360P
 
static final int AUDIO_PROFILE_DEFAULT = 0
 
static final int AUDIO_PROFILE_SPEECH_STANDARD = 1
 
static final int AUDIO_PROFILE_MUSIC_STANDARD = 2
 
static final int AUDIO_PROFILE_MUSIC_STANDARD_STEREO = 3
 
static final int AUDIO_PROFILE_MUSIC_HIGH_QUALITY = 4
 
static final int AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO = 5
 
static final int AUDIO_SCENARIO_DEFAULT = 0
 
static final int AUDIO_SCENARIO_CHATROOM_ENTERTAINMENT = 1
 
static final int AUDIO_SCENARIO_EDUCATION = 2
 
static final int AUDIO_SCENARIO_GAME_STREAMING = 3
 
static final int AUDIO_SCENARIO_SHOWROOM = 4
 
static final int AUDIO_SCENARIO_CHATROOM_GAMING = 5
 
static final int AUDIO_SCENARIO_NUM = 6
 
static final int AUDIO_EQUALIZATION_BAND_31 = 0
 
static final int AUDIO_EQUALIZATION_BAND_62 = 1
 
static final int AUDIO_EQUALIZATION_BAND_125 = 2
 
static final int AUDIO_EQUALIZATION_BAND_250 = 3
 
static final int AUDIO_EQUALIZATION_BAND_500 = 4
 
static final int AUDIO_EQUALIZATION_BAND_1K = 5
 
static final int AUDIO_EQUALIZATION_BAND_2K = 6
 
static final int AUDIO_EQUALIZATION_BAND_4K = 7
 
static final int AUDIO_EQUALIZATION_BAND_8K = 8
 
static final int AUDIO_EQUALIZATION_BAND_16K = 9
 
static final int AUDIO_REVERB_DRY_LEVEL = 0
 
static final int AUDIO_REVERB_WET_LEVEL = 1
 
static final int AUDIO_REVERB_ROOM_SIZE = 2
 
static final int AUDIO_REVERB_WET_DELAY = 3
 
static final int AUDIO_REVERB_STRENGTH = 4
 
static final int CHANNEL_PROFILE_COMMUNICATION = 0
 
static final int CHANNEL_PROFILE_LIVE_BROADCASTING = 1
 
static final int CHANNEL_PROFILE_GAME = 2
 
static final int CLIENT_ROLE_BROADCASTER = 1
 
static final int CLIENT_ROLE_AUDIENCE = 2
 
static final int USER_OFFLINE_QUIT = 0
 
static final int USER_OFFLINE_DROPPED = 1
 
static final int USER_OFFLINE_BECOME_AUDIENCE = 2
 
static final int INJECT_STREAM_STATUS_START_SUCCESS = 0
 
static final int INJECT_STREAM_STATUS_START_ALREADY_EXISTS = 1
 
static final int INJECT_STREAM_STATUS_START_UNAUTHORIZED = 2
 
static final int INJECT_STREAM_STATUS_START_TIMEDOUT = 3
 
static final int INJECT_STREAM_STATUS_START_FAILED = 4
 
static final int INJECT_STREAM_STATUS_STOP_SUCCESS = 5
 
static final int INJECT_STREAM_STATUS_STOP_NOT_FOUND = 6
 
static final int INJECT_STREAM_STATUS_STOP_UNAUTHORIZED = 7
 
static final int INJECT_STREAM_STATUS_STOP_TIMEDOUT = 8
 
static final int INJECT_STREAM_STATUS_STOP_FAILED = 9
 
static final int INJECT_STREAM_STATUS_BROKEN = 10
 
static final int QUALITY_REPORT_FORMAT_JSON = 0
 
static final int QUALITY_REPORT_FORMAT_HTML = 1
 
static final int RENDER_MODE_HIDDEN = 1
 
static final int RENDER_MODE_FIT = 2
 
static final int RENDER_MODE_ADAPTIVE = 3
 
static final int VIDEO_MIRROR_MODE_AUTO = 0
 
static final int VIDEO_MIRROR_MODE_ENABLED = 1
 
static final int VIDEO_MIRROR_MODE_DISABLED = 2
 
static final int LOG_FILTER_OFF = 0
 
static final int LOG_FILTER_DEBUG = 0x80f
 
static final int LOG_FILTER_INFO = 0x0f
 
static final int LOG_FILTER_WARNING = 0x0e
 
static final int LOG_FILTER_ERROR = 0x0c
 
static final int LOG_FILTER_CRITICAL = 0x08
 
static final int AUDIO_ROUTE_DEFAULT = -1
 
static final int AUDIO_ROUTE_HEADSET = 0
 
static final int AUDIO_ROUTE_EARPIECE = 1
 
static final int AUDIO_ROUTE_HEADSETNOMIC = 2
 
static final int AUDIO_ROUTE_SPEAKERPHONE = 3
 
static final int AUDIO_ROUTE_LOUDSPEAKER = 4
 
static final int AUDIO_ROUTE_HEADSETBLUETOOTH = 5
 
static final int VIDEO_STREAM_HIGH = 0
 
static final int VIDEO_STREAM_LOW = 1
 
static final int HARDWARE_ENCODER = 0
 
static final int SOFTWARE_ENCODER = 1
 
static final int RAW_AUDIO_FRAME_OP_MODE_READ_ONLY = 0
 
static final int RAW_AUDIO_FRAME_OP_MODE_WRITE_ONLY = 1
 
static final int RAW_AUDIO_FRAME_OP_MODE_READ_WRITE = 2
 
static final int MEDIA_ENGINE_RECORDING_ERROR = 0
 
static final int MEDIA_ENGINE_PLAYOUT_ERROR = 1
 
static final int MEDIA_ENGINE_RECORDING_WARNING = 2
 
static final int MEDIA_ENGINE_PLAYOUT_WARNING = 3
 
static final int MEDIA_ENGINE_AUDIO_FILE_MIX_FINISH = 10
 
static final int MEDIA_ENGINE_LOCAL_AUDIO_RECORD_ENABLED = 14
 
static final int MEDIA_ENGINE_LOCAL_AUDIO_RECORD_DISABLED = 15
 
static final int MEDIA_ENGINE_ROLE_BROADCASTER_SOLO = 20
 
static final int MEDIA_ENGINE_ROLE_BROADCASTER_INTERACTIVE = 21
 
static final int MEDIA_ENGINE_ROLE_AUDIENCE = 22
 
static final int MEDIA_ENGINE_ROLE_COMM_PEER = 23
 
static final int CONNECTION_STATE_DISCONNECTED = 1
 
static final int CONNECTION_STATE_CONNECTING = 2
 
static final int CONNECTION_STATE_CONNECTED = 3
 
static final int CONNECTION_STATE_RECONNECTING = 4
 
static final int CONNECTION_STATE_FAILED = 5
 
static final int CONNECTION_CHANGED_CONNECTING = 0
 
static final int CONNECTION_CHANGED_JOIN_SUCCESS = 1
 
static final int CONNECTION_CHANGED_INTERRUPTED = 2
 
static final int CONNECTION_CHANGED_BANNED_BY_SERVER = 3
 
static final int CONNECTION_CHANGED_JOIN_FAILED = 4
 
static final int CONNECTION_CHANGED_LEAVE_CHANNEL = 5
 
static final int STREAM_LIFE_CYCLE_BIND2CHANNEL = 1
 
static final int STREAM_LIFE_CYCLE_BIND2OWNER = 2
 
static final int AUDIO_RECORDING_QUALITY_LOW = 0
 
static final int AUDIO_RECORDING_QUALITY_MEDIUM = 1
 
static final int AUDIO_RECORDING_QUALITY_HIGH = 2
 
static final int MEDIA_TYPE_NONE = 0
 
static final int MEDIA_TYPE_AUDIO_ONLY = 1
 
static final int MEDIA_TYPE_VIDEO_ONLY = 2
 
static final int MEDIA_TYPE_AUDIO_AND_VIDEO = 3
 
static final int STREAM_FALLBACK_OPTION_DISABLED = 0
 
static final int STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW = 1
 
static final int STREAM_FALLBACK_OPTION_AUDIO_ONLY = 2
 

Detailed Description

The Constants Class.

Member Data Documentation

◆ QUALITY_UNKNOWN

final int io.agora.rtc.Constants.QUALITY_UNKNOWN = 0
static

0: The quality is unknown.

◆ QUALITY_EXCELLENT

final int io.agora.rtc.Constants.QUALITY_EXCELLENT = 1
static

1: The quality is excellent.

◆ QUALITY_GOOD

final int io.agora.rtc.Constants.QUALITY_GOOD = 2
static

2: The quality is quite good, but the bitrate may be slightly lower than excellent.

◆ QUALITY_POOR

final int io.agora.rtc.Constants.QUALITY_POOR = 3
static

3: Users can feel the communication slightly impaired.

◆ QUALITY_BAD

final int io.agora.rtc.Constants.QUALITY_BAD = 4
static

4: Users can communicate not very smoothly.

◆ QUALITY_VBAD

final int io.agora.rtc.Constants.QUALITY_VBAD = 5
static

5: The quality is so bad that users can barely communicate.

◆ QUALITY_DOWN

final int io.agora.rtc.Constants.QUALITY_DOWN = 6
static

6: The network is disconnected and users cannot communicate at all.

◆ WARN_INVALID_VIEW

final int io.agora.rtc.Constants.WARN_INVALID_VIEW = 8
static

8: The specified view is invalid. Specify a view when using the video call function.

◆ WARN_INIT_VIDEO

final int io.agora.rtc.Constants.WARN_INIT_VIDEO = 16
static

16: Fails to initialize the video function, possibly caused by a lack of resources. The users cannot see the video while the voice communication is not affected.

◆ WARN_PENDING

final int io.agora.rtc.Constants.WARN_PENDING = 20
static

20: The request is pending, usually due to some module not being ready, and the SDK postponed processing the request.

◆ WARN_NO_AVAILABLE_CHANNEL

final int io.agora.rtc.Constants.WARN_NO_AVAILABLE_CHANNEL = 103
static

103: No channel resources are available. Maybe because the server cannot allocate any channel resource.

◆ WARN_LOOKUP_CHANNEL_TIMEOUT

final int io.agora.rtc.Constants.WARN_LOOKUP_CHANNEL_TIMEOUT = 104
static

104: A timeout occurs when looking up the channel. When joining a channel, the SDK looks up the specified channel. This warning usually occurs when the network condition is too poor for the SDK to connect to the server.

◆ WARN_LOOKUP_CHANNEL_REJECTED

final int io.agora.rtc.Constants.WARN_LOOKUP_CHANNEL_REJECTED = 105
static

105: The server rejects the request to look up the channel. The server cannot process this request or the request is illegal.

◆ WARN_OPEN_CHANNEL_TIMEOUT

final int io.agora.rtc.Constants.WARN_OPEN_CHANNEL_TIMEOUT = 106
static

106: A timeout occurs when opening the channel. Once the specific channel is found, the SDK opens the channel. This warning usually occurs when the network condition is too poor for the SDK to connect to the server.

◆ WARN_OPEN_CHANNEL_REJECTED

final int io.agora.rtc.Constants.WARN_OPEN_CHANNEL_REJECTED = 107
static

107: The server rejects the request to open the channel. The server cannot process this request or the request is illegal.

◆ WARN_SWITCH_LIVE_VIDEO_TIMEOUT

final int io.agora.rtc.Constants.WARN_SWITCH_LIVE_VIDEO_TIMEOUT = 111
static

111: A timeout occurs when switching to the live video.

◆ WARN_SET_CLIENT_ROLE_TIMEOUT

final int io.agora.rtc.Constants.WARN_SET_CLIENT_ROLE_TIMEOUT = 118
static

118: A timeout occurs when setting the user role in the Live-broadcast profile.

◆ WARN_SET_CLIENT_ROLE_NOT_AUTHORIZED

final int io.agora.rtc.Constants.WARN_SET_CLIENT_ROLE_NOT_AUTHORIZED = 119
static

119: The user role is unauthorized.

◆ WARN_OPEN_CHANNEL_INVALID_TICKET

final int io.agora.rtc.Constants.WARN_OPEN_CHANNEL_INVALID_TICKET = 121
static

121: The ticket to open the channel is invalid.

◆ WARN_OPEN_CHANNEL_TRY_NEXT_VOS

final int io.agora.rtc.Constants.WARN_OPEN_CHANNEL_TRY_NEXT_VOS = 122
static

122: Try connecting to another server.

◆ WARN_AUDIO_MIXING_OPEN_ERROR

final int io.agora.rtc.Constants.WARN_AUDIO_MIXING_OPEN_ERROR = 701
static

701: An error occurs in opening the audio mixing file.

◆ WARN_ADM_RUNTIME_PLAYOUT_WARNING

final int io.agora.rtc.Constants.WARN_ADM_RUNTIME_PLAYOUT_WARNING = 1014
static

1014: Audio Device Module: A warning occurs in the playback device.

◆ WARN_ADM_RUNTIME_RECORDING_WARNING

final int io.agora.rtc.Constants.WARN_ADM_RUNTIME_RECORDING_WARNING = 1016
static

1016: Audio Device Module: A warning occurs in the recording device.

◆ WARN_ADM_RECORD_AUDIO_SILENCE

final int io.agora.rtc.Constants.WARN_ADM_RECORD_AUDIO_SILENCE = 1019
static

1019: Audio Device Module: No valid audio data is collected. This warning does not affect communications.

◆ WARN_ADM_RECORD_AUDIO_LOWLEVEL

final int io.agora.rtc.Constants.WARN_ADM_RECORD_AUDIO_LOWLEVEL = 1031
static

1031: Audio Device Module: The recorded audio volume is too low.

◆ WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL

final int io.agora.rtc.Constants.WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL = 1032
static

1032: Audio Device Module: The playback audio volume is too low.

◆ WARN_ADM_RECORD_IS_OCCUPIED

final int io.agora.rtc.Constants.WARN_ADM_RECORD_IS_OCCUPIED = 1033
static

1033: Audio Device Module: The recording device is busy.

◆ WARN_APM_HOWLING

final int io.agora.rtc.Constants.WARN_APM_HOWLING = 1051
static

1051: Audio Device Module: Howling is detected.

◆ WARN_ADM_GLITCH_STATE

final int io.agora.rtc.Constants.WARN_ADM_GLITCH_STATE = 1052
static

1052: Audio Device Module: The device is in the glitch state.

◆ WARN_ADM_IMPROPER_SETTINGS

final int io.agora.rtc.Constants.WARN_ADM_IMPROPER_SETTINGS = 1053
static

1053: Audio Device Module: The underlying audio settings have changed.

◆ ERR_OK

final int io.agora.rtc.Constants.ERR_OK = 0
static

0: No error occurs.

◆ ERR_FAILED

final int io.agora.rtc.Constants.ERR_FAILED = 1
static

1: A general error occurs (no specified reason).

◆ ERR_INVALID_ARGUMENT

final int io.agora.rtc.Constants.ERR_INVALID_ARGUMENT = 2
static

2: An invalid parameter is used. For example, the specific channel name includes illegal characters.

◆ ERR_NOT_READY

final int io.agora.rtc.Constants.ERR_NOT_READY = 3
static

3: The SDK module is not ready. Agora recommends the following methods to solve this error:

  • Check the audio device.
  • Check the completeness of the app.
  • Re-initialize the SDK.

◆ ERR_NOT_SUPPORTED

final int io.agora.rtc.Constants.ERR_NOT_SUPPORTED = 4
static

4: The SDK does not support this function.

◆ ERR_REFUSED

final int io.agora.rtc.Constants.ERR_REFUSED = 5
static

5: The request is rejected. This is for internal SDK use only, and is not returned to the app through any API method or callback.

◆ ERR_BUFFER_TOO_SMALL

final int io.agora.rtc.Constants.ERR_BUFFER_TOO_SMALL = 6
static

6: The buffer size is not big enough to store the returned data.

◆ ERR_NOT_INITIALIZED

final int io.agora.rtc.Constants.ERR_NOT_INITIALIZED = 7
static

7: The SDK is not initialized before calling this method.

◆ ERR_NO_PERMISSION

final int io.agora.rtc.Constants.ERR_NO_PERMISSION = 9
static

9: No permission exists. This is for internal SDK use only, and is not returned to the app through any API method or callback.

◆ ERR_TIMEDOUT

final int io.agora.rtc.Constants.ERR_TIMEDOUT = 10
static

10: An API timeout occurs. Some API methods require the SDK to return the execution result, and this error occurs if the request takes too long for the SDK to process.

◆ ERR_CANCELED

final int io.agora.rtc.Constants.ERR_CANCELED = 11
static

11: The request is canceled. This is for internal SDK use only, and is not returned to the app through any API method or callback.

◆ ERR_TOO_OFTEN

final int io.agora.rtc.Constants.ERR_TOO_OFTEN = 12
static

12: This method is called too often. This is for internal SDK use only, and is not returned to the app through any API method or callback.

◆ ERR_BIND_SOCKET

final int io.agora.rtc.Constants.ERR_BIND_SOCKET = 13
static

13: The SDK fails to bind to the network socket. This is for internal SDK use only, and is not returned to the app through any API method or callback.

◆ ERR_NET_DOWN

final int io.agora.rtc.Constants.ERR_NET_DOWN = 14
static

14: The network is unavailable. This is for internal SDK use only, and is not returned to the app through any API method or callback.

◆ ERR_NET_NOBUFS

final int io.agora.rtc.Constants.ERR_NET_NOBUFS = 15
static

15: No network buffers are available. This is for internal SDK use only, and is not returned to the app through any API method or callback.

◆ ERR_JOIN_CHANNEL_REJECTED

final int io.agora.rtc.Constants.ERR_JOIN_CHANNEL_REJECTED = 17
static

17: The request to join the channel is rejected. This error usually occurs when the user is already in the channel and still calls the joinChannel method to join the channel.

◆ ERR_LEAVE_CHANNEL_REJECTED

final int io.agora.rtc.Constants.ERR_LEAVE_CHANNEL_REJECTED = 18
static

18: The request to leave the channel is rejected. This error usually occurs:

  • When the user has left the channel and still calls the leaveChannel method to leave the channel. This error stops once the user stops calling this method.
  • When the user calls the leaveChannel method before joining a channel. No extra operation is needed.

◆ ERR_ALREADY_IN_USE

final int io.agora.rtc.Constants.ERR_ALREADY_IN_USE = 19
static

19: The resources are occupied and cannot be reused.

◆ ERR_INVALID_APP_ID

final int io.agora.rtc.Constants.ERR_INVALID_APP_ID = 101
static

101: The specified App ID is invalid. Please try to rejoin the channel with a valid App ID.

◆ ERR_INVALID_CHANNEL_NAME

final int io.agora.rtc.Constants.ERR_INVALID_CHANNEL_NAME = 102
static

102: The specified channel name is invalid. Please try to rejoin the channel with a valid channel name.

◆ ERR_TOKEN_EXPIRED

final int io.agora.rtc.Constants.ERR_TOKEN_EXPIRED = 109
static

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. The user can use the token to access the Agora service within five minutes after the token is generated. If the user does not access the Agora service after five minutes, this token will no longer be valid.
  • Call Expiration Timestamp expired: The timestamp is the exact time when a user can no longer use the Agora service (for example, when a user is forced to leave an ongoing call). When a value is set for the Call Expiration Timestamp, it does not mean that the Dynamic Key will expire, but that the user will be banned from the channel.</il>

◆ ERR_INVALID_TOKEN

final int io.agora.rtc.Constants.ERR_INVALID_TOKEN = 110
static

110: The token is invalid due to one of the following reasons:

  • The App Certificate for the project is enabled in Dashboard, but the user is still using the App ID. Once the App Certificate is enabled, the user must use a token.
  • The uid is mandatory, and users must set the same uid as the one set in the joinChannel method.

◆ ERR_CONNECTION_INTERRUPTED

final int io.agora.rtc.Constants.ERR_CONNECTION_INTERRUPTED = 111
static

111: The Internet connection is interrupted. This applies to the Agora Web SDK only.

◆ ERR_CONNECTION_LOST

final int io.agora.rtc.Constants.ERR_CONNECTION_LOST = 112
static

112: The Internet connection is lost. This applies to the Agora Web SDK only.

◆ ERR_NOT_IN_CHANNEL

final int io.agora.rtc.Constants.ERR_NOT_IN_CHANNEL = 113
static

113: The user is not in the channel when calling the sendStreamMessage method.

◆ ERR_SIZE_TOO_LARGE

final int io.agora.rtc.Constants.ERR_SIZE_TOO_LARGE = 114
static

114: The size of the sent data is over 1024 bytes when the user calls the sendStreamMessage method.

◆ ERR_BITRATE_LIMIT

final int io.agora.rtc.Constants.ERR_BITRATE_LIMIT = 115
static

115: The bitrate of the sent data exceeds the limit of 6 Kbps when the user calls the sendStreamMessage method.

◆ ERR_TOO_MANY_DATA_STREAMS

final int io.agora.rtc.Constants.ERR_TOO_MANY_DATA_STREAMS = 116
static

116: Too many data streams (over five streams) are created when the user calls the createDataStream method.

◆ ERR_DECRYPTION_FAILED

final int io.agora.rtc.Constants.ERR_DECRYPTION_FAILED = 120
static

120: Decryption fails. The user may have used a different encryption password to join the channel. Check your settings or try rejoining the channel.

◆ ERR_CLIENT_IS_BANNED_BY_SERVER

final int io.agora.rtc.Constants.ERR_CLIENT_IS_BANNED_BY_SERVER = 123
static

123: The client is banned by the server.

◆ ERR_WATERMARK_PARAM

final int io.agora.rtc.Constants.ERR_WATERMARK_PARAM = 124
static

124: Incorrect watermark file parameter.

◆ ERR_WATERMARK_PATH

final int io.agora.rtc.Constants.ERR_WATERMARK_PATH = 125
static

125: Incorrect watermark file path.

◆ ERR_WATERMARK_PNG

final int io.agora.rtc.Constants.ERR_WATERMARK_PNG = 126
static

126: Incorrect watermark file format.

◆ ERR_WATERMARKR_INFO

final int io.agora.rtc.Constants.ERR_WATERMARKR_INFO = 127
static

127: Incorrect watermark file information.

◆ ERR_WATERMARK_ARGB

final int io.agora.rtc.Constants.ERR_WATERMARK_ARGB = 128
static

128: Incorrect watermark file data format.

◆ ERR_WATERMARK_READ

final int io.agora.rtc.Constants.ERR_WATERMARK_READ = 129
static

129: An error occurs in reading the watermark file.

◆ ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISHED

final int io.agora.rtc.Constants.ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISHED = 130
static

130: Encryption is enabled when the user calls the addPublishStreamUrl method (CDN live streaming does not support encrypted streams).

◆ ERR_LOAD_MEDIA_ENGINE

final int io.agora.rtc.Constants.ERR_LOAD_MEDIA_ENGINE = 1001
static

1001: Fails to load the media engine.

◆ ERR_START_CALL

final int io.agora.rtc.Constants.ERR_START_CALL = 1002
static

1002: Fails to start the call after enabling the media engine.

◆ ERR_START_CAMERA

final int io.agora.rtc.Constants.ERR_START_CAMERA = 1003
static

1003: Fails to start the camera.

◆ ERR_START_VIDEO_RENDER

final int io.agora.rtc.Constants.ERR_START_VIDEO_RENDER = 1004
static

1004: Fails to start the video rendering module.

◆ ERR_ADM_GENERAL_ERROR

final int io.agora.rtc.Constants.ERR_ADM_GENERAL_ERROR = 1005
static

1005: Audio Device Module: A general error occurs in the Audio Device Module (no classified reason). Check if the audio device is used by another application, or try rejoining the channel.

◆ ERR_ADM_JAVA_RESOURCE

final int io.agora.rtc.Constants.ERR_ADM_JAVA_RESOURCE = 1006
static

1006: Audio Device Module: An error occurs in using the Java resources.

◆ ERR_ADM_SAMPLE_RATE

final int io.agora.rtc.Constants.ERR_ADM_SAMPLE_RATE = 1007
static

1007: Audio Device Module: An error occurs in setting the sampling frequency.

◆ ERR_ADM_INIT_PLAYOUT

final int io.agora.rtc.Constants.ERR_ADM_INIT_PLAYOUT = 1008
static

1008: Audio Device Module: An error occurs in initializing the playback device.

◆ ERR_ADM_START_PLAYOUT

final int io.agora.rtc.Constants.ERR_ADM_START_PLAYOUT = 1009
static

1009: Audio Device Module: An error occurs in starting the playback device.

◆ ERR_ADM_STOP_PLAYOUT

final int io.agora.rtc.Constants.ERR_ADM_STOP_PLAYOUT = 1010
static

1010: Audio Device Module: An error occurs in stopping the playback device.

◆ ERR_ADM_INIT_RECORDING

final int io.agora.rtc.Constants.ERR_ADM_INIT_RECORDING = 1011
static

1011: Audio Device Module: An error occurs in initializing the recording device.

◆ ERR_ADM_START_RECORDING

final int io.agora.rtc.Constants.ERR_ADM_START_RECORDING = 1012
static

1012: Audio Device Module: An error occurs in starting the recording device.

◆ ERR_ADM_STOP_RECORDING

final int io.agora.rtc.Constants.ERR_ADM_STOP_RECORDING = 1013
static

1013: Audio Device Module: An error occurs in stopping the recording device.

◆ ERR_ADM_RUNTIME_PLAYOUT_ERROR

final int io.agora.rtc.Constants.ERR_ADM_RUNTIME_PLAYOUT_ERROR = 1015
static

1015: Audio Device Module: A playback error occurs. Check your playback device or try rejoining the channel.

◆ ERR_ADM_RUNTIME_RECORDING_ERROR

final int io.agora.rtc.Constants.ERR_ADM_RUNTIME_RECORDING_ERROR = 1017
static

1017: Audio Device Module: A recording error occurs.

◆ ERR_ADM_RECORD_AUDIO_FAILED

final int io.agora.rtc.Constants.ERR_ADM_RECORD_AUDIO_FAILED = 1018
static

1018: Audio Device Module: Fails to record.

◆ ERR_ADM_INIT_LOOPBACK

final int io.agora.rtc.Constants.ERR_ADM_INIT_LOOPBACK = 1022
static

1022: Audio Device Module: An error occurs in initializing the loopback device.

◆ ERR_ADM_START_LOOPBACK

final int io.agora.rtc.Constants.ERR_ADM_START_LOOPBACK = 1023
static

1023: Audio Device Module: An error occurs in starting the loopback device.

◆ ERR_AUDIO_BT_SCO_FAILED

final int io.agora.rtc.Constants.ERR_AUDIO_BT_SCO_FAILED = 1030
static

1030: Audio Routing: Fails to route the audio to the connected Bluetooth device. The default route is used.

◆ ERR_ADM_NO_RECORDING_DEVICE

final int io.agora.rtc.Constants.ERR_ADM_NO_RECORDING_DEVICE = 1359
static

1359: Audio Device Module: No recording device exists.

◆ ERR_ADM_NO_PLAYOUT_DEVICE

final int io.agora.rtc.Constants.ERR_ADM_NO_PLAYOUT_DEVICE = 1360
static

1360: Audio Device Module: No playback device exists.

◆ ERR_VDM_CAMERA_NOT_AUTHORIZED

final int io.agora.rtc.Constants.ERR_VDM_CAMERA_NOT_AUTHORIZED = 1501
static

1501: Video Device Module: The camera is unauthorized.

◆ ERR_VCM_UNKNOWN_ERROR

final int io.agora.rtc.Constants.ERR_VCM_UNKNOWN_ERROR = 1600
static

1600: Video Device Module: Unknown error.

◆ ERR_VCM_ENCODER_INIT_ERROR

final int io.agora.rtc.Constants.ERR_VCM_ENCODER_INIT_ERROR = 1601
static

1601: Video Device Module: Error in initializing the video encoder. This is a serious error and you can try to rejoin the channel.

◆ ERR_VCM_ENCODER_ENCODE_ERROR

final int io.agora.rtc.Constants.ERR_VCM_ENCODER_ENCODE_ERROR = 1602
static

1602: Video Device Module: Error in the video encoder. This is a serious error and you can try to rejoin the channel.

◆ ERR_VCM_ENCODER_SET_ERROR

final int io.agora.rtc.Constants.ERR_VCM_ENCODER_SET_ERROR = 1603
static
Deprecated:
This error code is deprecated. 1603: Video Device Module: Error in setting the video encoder.

◆ VIDEO_PROFILE_120P

final int io.agora.rtc.Constants.VIDEO_PROFILE_120P = 0
static
Deprecated:
0: Resolution: 160 × 120; Frame rate: 15 fps; Bitrate: 65 Kbps

◆ VIDEO_PROFILE_120P_3

final int io.agora.rtc.Constants.VIDEO_PROFILE_120P_3 = 2
static
Deprecated:
2: Resolution: 120 × 120; Frame rate: 15 fps; Bitrate 50 Kbps

◆ VIDEO_PROFILE_180P

final int io.agora.rtc.Constants.VIDEO_PROFILE_180P = 10
static
Deprecated:
10: Resolution: 320 × 180; Frame rate: 15 fps; Bitrate: 140 Kbps

◆ VIDEO_PROFILE_180P_3

final int io.agora.rtc.Constants.VIDEO_PROFILE_180P_3 = 12
static
Deprecated:
12: Resolution: 180 × 180; Frame rate: 15 fps; Bitrate: 100 Kbps

◆ VIDEO_PROFILE_180P_4

final int io.agora.rtc.Constants.VIDEO_PROFILE_180P_4 = 13
static
Deprecated:
13: Resolution: 240 × 180; Frame rate: 15 fps; Bitrate: 120 Kbps

◆ VIDEO_PROFILE_240P

final int io.agora.rtc.Constants.VIDEO_PROFILE_240P = 20
static
Deprecated:
20: Resolution: 320 × 240; Frame rate: 15 fps; Bitrate: 200 Kbps

◆ VIDEO_PROFILE_240P_3

final int io.agora.rtc.Constants.VIDEO_PROFILE_240P_3 = 22
static
Deprecated:
22: Resolution: 240 × 240; Frame rate: 15 fps; Bitrate: 140 Kbps

◆ VIDEO_PROFILE_240P_4

final int io.agora.rtc.Constants.VIDEO_PROFILE_240P_4 = 23
static
Deprecated:
23: Resolution: 424 × 240; Frame rate: 15 fps; Bitrate: 220 Kbps

◆ VIDEO_PROFILE_360P

final int io.agora.rtc.Constants.VIDEO_PROFILE_360P = 30
static
Deprecated:
30: Resolution: 640 × 360; Frame rate: 15 fps; Bitrate: 400 Kbps

◆ VIDEO_PROFILE_360P_3

final int io.agora.rtc.Constants.VIDEO_PROFILE_360P_3 = 32
static
Deprecated:
32: Resolution: 360 × 360; Frame rate: 15 fps; Bitrate: 260 Kbps

◆ VIDEO_PROFILE_360P_4

final int io.agora.rtc.Constants.VIDEO_PROFILE_360P_4 = 33
static
Deprecated:
33: Resolution: 640 × 360; Frame rate: 30 fps; Bitrate: 600 Kbps

◆ VIDEO_PROFILE_360P_6

final int io.agora.rtc.Constants.VIDEO_PROFILE_360P_6 = 35
static
Deprecated:
35: Resolution: 360 × 360; Frame rate: 30 fps; Bitrate: 400 Kbps

◆ VIDEO_PROFILE_360P_7

final int io.agora.rtc.Constants.VIDEO_PROFILE_360P_7 = 36
static
Deprecated:
36: Resolution: 480 × 360; Frame rate: 15 fps; Bitrate: 320 Kbps

◆ VIDEO_PROFILE_360P_8

final int io.agora.rtc.Constants.VIDEO_PROFILE_360P_8 = 37
static
Deprecated:
37: Resolution: 480 × 360; Frame rate: 30 fps; Bitrate: 490 Kbps

◆ VIDEO_PROFILE_360P_9

final int io.agora.rtc.Constants.VIDEO_PROFILE_360P_9 = 38
static
Deprecated:
38: Resolution: 640 × 360; Frame rate: 15 fps; Bitrate: 800 Kbps
Note
This profile applies to the Live-broadcast channel profile only.

◆ VIDEO_PROFILE_360P_10

final int io.agora.rtc.Constants.VIDEO_PROFILE_360P_10 = 39
static
Deprecated:
39: Resolution: 640 × 360; Frame rate: 24 fps; Bitrate: 800 Kbps
Note
This profile applies to the Live-broadcast channel profile only.

◆ VIDEO_PROFILE_360P_11

final int io.agora.rtc.Constants.VIDEO_PROFILE_360P_11 = 100
static
Deprecated:
100: Resolution: 640 × 360; Frame rate: 24 fps; Bitrate: 1000 Kbps
Note
This profile applies to the Live-broadcast channel profile only.

◆ VIDEO_PROFILE_480P

final int io.agora.rtc.Constants.VIDEO_PROFILE_480P = 40
static
Deprecated:
40: Resolution: 640 × 480; Frame rate: 15 fps; Bitrate: 500 Kbps

◆ VIDEO_PROFILE_480P_3

final int io.agora.rtc.Constants.VIDEO_PROFILE_480P_3 = 42
static
Deprecated:
42: Resolution: 480 × 480; Frame rate: 15 fps; Bitrate: 400 Kbps

◆ VIDEO_PROFILE_480P_4

final int io.agora.rtc.Constants.VIDEO_PROFILE_480P_4 = 43
static
Deprecated:
43: Resolution: 640 × 480; Frame rate: 30 fps; Bitrate: 750 Kbps

◆ VIDEO_PROFILE_480P_6

final int io.agora.rtc.Constants.VIDEO_PROFILE_480P_6 = 45
static
Deprecated:
45: Resolution: 480 × 480; Frame rate: 30 fps; Bitrate: 600 Kbps

◆ VIDEO_PROFILE_480P_8

final int io.agora.rtc.Constants.VIDEO_PROFILE_480P_8 = 47
static
Deprecated:
47: Resolution: 848 × 480; Frame rate: 15 fps; Bitrate: 610 Kbps

◆ VIDEO_PROFILE_480P_9

final int io.agora.rtc.Constants.VIDEO_PROFILE_480P_9 = 48
static
Deprecated:
48: Resolution: 848 × 480; Frame rate: 30 fps; Bitrate: 930 Kbps

◆ VIDEO_PROFILE_480P_10

final int io.agora.rtc.Constants.VIDEO_PROFILE_480P_10 = 49
static
Deprecated:
49: Resolution: 640 × 480; Frame rate: 10 fps; Bitrate: 400 Kbps

◆ VIDEO_PROFILE_720P

final int io.agora.rtc.Constants.VIDEO_PROFILE_720P = 50
static
Deprecated:
50: Resolution: 1280 × 720; Frame rate: 15 fps; Bitrate: 1130 Kbps

◆ VIDEO_PROFILE_720P_3

final int io.agora.rtc.Constants.VIDEO_PROFILE_720P_3 = 52
static
Deprecated:
52: Resolution: 1280 × 720; Frame rate: 30 fps; Bitrate: 1710 Kbps

◆ VIDEO_PROFILE_720P_5

final int io.agora.rtc.Constants.VIDEO_PROFILE_720P_5 = 54
static
Deprecated:
54: Resolution: 960 × 720; Frame rate: 15 fps; Bitrate: 910 Kbps

◆ VIDEO_PROFILE_720P_6

final int io.agora.rtc.Constants.VIDEO_PROFILE_720P_6 = 55
static
Deprecated:
55: Resolution: 960 × 720; Frame rate: 30 fps; Bitrate: 1380 Kbps

◆ VIDEO_PROFILE_1080P

final int io.agora.rtc.Constants.VIDEO_PROFILE_1080P = 60
static
Deprecated:
60: Resolution: 1920 × 1080; Frame rate: 15 fps; Bitrate: 2080 Kbps

◆ VIDEO_PROFILE_1080P_3

final int io.agora.rtc.Constants.VIDEO_PROFILE_1080P_3 = 62
static
Deprecated:
62: Resolution: 1920 × 1080; Frame rate: 30 fps; Bitrate: 3150 Kbps

◆ VIDEO_PROFILE_1080P_5

final int io.agora.rtc.Constants.VIDEO_PROFILE_1080P_5 = 64
static
Deprecated:
64: Resolution: 1920 × 1080; Frame rate: 60 fps; Bitrate: 4780 Kbps

◆ VIDEO_PROFILE_1440P

final int io.agora.rtc.Constants.VIDEO_PROFILE_1440P = 66
static
Deprecated:
66: Resolution: 2560 × 1440; Frame rate: 30 fps; Bitrate: 4850 Kbps

◆ VIDEO_PROFILE_1440P_2

final int io.agora.rtc.Constants.VIDEO_PROFILE_1440P_2 = 67
static
Deprecated:
67: Resolution: 2560 × 1440; Frame rate: 60 fps; Bitrate: 7350 Kbps

◆ VIDEO_PROFILE_4K

final int io.agora.rtc.Constants.VIDEO_PROFILE_4K = 70
static
Deprecated:
70: Resolution: 3840 × 2160; Frame rate: 30 fps; Bitrate: 8910 Kbps

◆ VIDEO_PROFILE_4K_3

final int io.agora.rtc.Constants.VIDEO_PROFILE_4K_3 = 72
static
Deprecated:
72: Resolution: 3840 × 2160; Frame rate: 60 fps; Bitrate: 13500 Kbps

◆ VIDEO_PROFILE_DEFAULT

final int io.agora.rtc.Constants.VIDEO_PROFILE_DEFAULT = VIDEO_PROFILE_360P
static
Deprecated:
Default video profile: Resolution: 640 × 360; Frame rate: 15 fps; Bitrate: 400 Kbps

◆ AUDIO_PROFILE_DEFAULT

final int io.agora.rtc.Constants.AUDIO_PROFILE_DEFAULT = 0
static

0: Default audio profile.

In the Communication profile, the default audio profile is SPEECH STANDARD =1. In the Live-broadcast profile, the default audio profile is MUSIC STANDARD = 2.

◆ AUDIO_PROFILE_SPEECH_STANDARD

final int io.agora.rtc.Constants.AUDIO_PROFILE_SPEECH_STANDARD = 1
static

1: Sampling rate of 32 kHz, audio encoding, mono, and a bitrate of up to 18 Kbps.

◆ AUDIO_PROFILE_MUSIC_STANDARD

final int io.agora.rtc.Constants.AUDIO_PROFILE_MUSIC_STANDARD = 2
static

2: Sampling rate of 48 kHz, music encoding, mono, and a bitrate of up to 48 Kbps.

◆ AUDIO_PROFILE_MUSIC_STANDARD_STEREO

final int io.agora.rtc.Constants.AUDIO_PROFILE_MUSIC_STANDARD_STEREO = 3
static

3: Sampling rate of 48 kHz, music encoding, stereo, and a bitrate of up to 56 Kbps.

◆ AUDIO_PROFILE_MUSIC_HIGH_QUALITY

final int io.agora.rtc.Constants.AUDIO_PROFILE_MUSIC_HIGH_QUALITY = 4
static

4: Sampling rate of 48 kHz, music encoding, mono, and a bitrate of up to 128 Kbps.

◆ AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO

final int io.agora.rtc.Constants.AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO = 5
static

5: Sampling rate of 48 kHz, music encoding, stereo, and a bitrate of up to 192 Kbps.

◆ AUDIO_SCENARIO_DEFAULT

final int io.agora.rtc.Constants.AUDIO_SCENARIO_DEFAULT = 0
static

0: Default audio application scenario.

◆ AUDIO_SCENARIO_CHATROOM_ENTERTAINMENT

final int io.agora.rtc.Constants.AUDIO_SCENARIO_CHATROOM_ENTERTAINMENT = 1
static

1: Entertainment scenario supporting voice during gameplay.

◆ AUDIO_SCENARIO_EDUCATION

final int io.agora.rtc.Constants.AUDIO_SCENARIO_EDUCATION = 2
static

2: Education scenario prioritizing fluency and stability.

◆ AUDIO_SCENARIO_GAME_STREAMING

final int io.agora.rtc.Constants.AUDIO_SCENARIO_GAME_STREAMING = 3
static

3: Live gaming scenario enabling the gaming audio effects in the speaker mode in a live broadcast scenario.

◆ AUDIO_SCENARIO_SHOWROOM

final int io.agora.rtc.Constants.AUDIO_SCENARIO_SHOWROOM = 4
static

4: Showroom scenario optimizing the audio quality with professional external equipment.

◆ AUDIO_SCENARIO_CHATROOM_GAMING

final int io.agora.rtc.Constants.AUDIO_SCENARIO_CHATROOM_GAMING = 5
static

5: Gaming scenario.

◆ AUDIO_EQUALIZATION_BAND_31

final int io.agora.rtc.Constants.AUDIO_EQUALIZATION_BAND_31 = 0
static

0: 31 Hz

◆ AUDIO_EQUALIZATION_BAND_62

final int io.agora.rtc.Constants.AUDIO_EQUALIZATION_BAND_62 = 1
static

1: 62 Hz

◆ AUDIO_EQUALIZATION_BAND_125

final int io.agora.rtc.Constants.AUDIO_EQUALIZATION_BAND_125 = 2
static

2: 125 Hz

◆ AUDIO_EQUALIZATION_BAND_250

final int io.agora.rtc.Constants.AUDIO_EQUALIZATION_BAND_250 = 3
static

3: 250 Hz

◆ AUDIO_EQUALIZATION_BAND_500

final int io.agora.rtc.Constants.AUDIO_EQUALIZATION_BAND_500 = 4
static

4: 500 Hz

◆ AUDIO_EQUALIZATION_BAND_1K

final int io.agora.rtc.Constants.AUDIO_EQUALIZATION_BAND_1K = 5
static

5: 1 kHz

◆ AUDIO_EQUALIZATION_BAND_2K

final int io.agora.rtc.Constants.AUDIO_EQUALIZATION_BAND_2K = 6
static

6: 2 kHz

◆ AUDIO_EQUALIZATION_BAND_4K

final int io.agora.rtc.Constants.AUDIO_EQUALIZATION_BAND_4K = 7
static

7: 4 kHz

◆ AUDIO_EQUALIZATION_BAND_8K

final int io.agora.rtc.Constants.AUDIO_EQUALIZATION_BAND_8K = 8
static

8: 8 kHz

◆ AUDIO_EQUALIZATION_BAND_16K

final int io.agora.rtc.Constants.AUDIO_EQUALIZATION_BAND_16K = 9
static

9: 16 kHz

◆ AUDIO_REVERB_DRY_LEVEL

final int io.agora.rtc.Constants.AUDIO_REVERB_DRY_LEVEL = 0
static

0: Level of the dry signal (-20 to 10 dB).

◆ AUDIO_REVERB_WET_LEVEL

final int io.agora.rtc.Constants.AUDIO_REVERB_WET_LEVEL = 1
static

1: Level of the early reflection signal (wet signal) (-20 to 10 dB).

◆ AUDIO_REVERB_ROOM_SIZE

final int io.agora.rtc.Constants.AUDIO_REVERB_ROOM_SIZE = 2
static

2: Room size of the reflection (0 to 100 dB).

◆ AUDIO_REVERB_WET_DELAY

final int io.agora.rtc.Constants.AUDIO_REVERB_WET_DELAY = 3
static

3: Length of the initial delay of the wet signal (0 to 200 ms).

◆ AUDIO_REVERB_STRENGTH

final int io.agora.rtc.Constants.AUDIO_REVERB_STRENGTH = 4
static

4: Strength of the late reverberation (0 to 100).

◆ CHANNEL_PROFILE_COMMUNICATION

final int io.agora.rtc.Constants.CHANNEL_PROFILE_COMMUNICATION = 0
static

0: The channel profile is Communication.

This is used in one-on-one calls or group calls, where all users in the channel can talk freely.

◆ CHANNEL_PROFILE_LIVE_BROADCASTING

final int io.agora.rtc.Constants.CHANNEL_PROFILE_LIVE_BROADCASTING = 1
static

1: The channel profile is Live Broadcast.

Host and audience roles that can be set by calling the setClientRole method. The host sends and receives voice/video, while the audience only receives voice/video.

◆ CHANNEL_PROFILE_GAME

final int io.agora.rtc.Constants.CHANNEL_PROFILE_GAME = 2
static

2: The channel profile is Gaming.

Any user in the channel can talk freely. This mode uses the codec with low-power consumption and low bitrate by default.

Note
This profile applies to the Agora Gaming SDK only.

◆ CLIENT_ROLE_BROADCASTER

final int io.agora.rtc.Constants.CLIENT_ROLE_BROADCASTER = 1
static

1: The host in a live broadcast.

◆ CLIENT_ROLE_AUDIENCE

final int io.agora.rtc.Constants.CLIENT_ROLE_AUDIENCE = 2
static

2: The audience in a live broadcast.

◆ USER_OFFLINE_QUIT

final int io.agora.rtc.Constants.USER_OFFLINE_QUIT = 0
static

0: The user quits the call.

◆ USER_OFFLINE_DROPPED

final int io.agora.rtc.Constants.USER_OFFLINE_DROPPED = 1
static

1: The SDK timed out and the user dropped offline because it has not received any data packet for a period of time. If a user quits the call and the message is not passed to the SDK (due to an unreliable channel), the SDK assumes the user has dropped offline.

◆ USER_OFFLINE_BECOME_AUDIENCE

final int io.agora.rtc.Constants.USER_OFFLINE_BECOME_AUDIENCE = 2
static

2: The client role switches from a host to an audience.

◆ INJECT_STREAM_STATUS_START_SUCCESS

final int io.agora.rtc.Constants.INJECT_STREAM_STATUS_START_SUCCESS = 0
static

0: The external video stream imports successfully.

◆ INJECT_STREAM_STATUS_START_ALREADY_EXISTS

final int io.agora.rtc.Constants.INJECT_STREAM_STATUS_START_ALREADY_EXISTS = 1
static

1: The external video stream already exists.

◆ INJECT_STREAM_STATUS_START_UNAUTHORIZED

final int io.agora.rtc.Constants.INJECT_STREAM_STATUS_START_UNAUTHORIZED = 2
static

2: The external video stream import is unauthorized.

◆ INJECT_STREAM_STATUS_START_TIMEDOUT

final int io.agora.rtc.Constants.INJECT_STREAM_STATUS_START_TIMEDOUT = 3
static

3: An import external video stream timeout.

◆ INJECT_STREAM_STATUS_START_FAILED

final int io.agora.rtc.Constants.INJECT_STREAM_STATUS_START_FAILED = 4
static

4: The external video stream fails to import.

◆ INJECT_STREAM_STATUS_STOP_SUCCESS

final int io.agora.rtc.Constants.INJECT_STREAM_STATUS_STOP_SUCCESS = 5
static

5: The external video stream stops importing successfully.

◆ INJECT_STREAM_STATUS_STOP_NOT_FOUND

final int io.agora.rtc.Constants.INJECT_STREAM_STATUS_STOP_NOT_FOUND = 6
static

6: No external video stream is found.

◆ INJECT_STREAM_STATUS_STOP_UNAUTHORIZED

final int io.agora.rtc.Constants.INJECT_STREAM_STATUS_STOP_UNAUTHORIZED = 7
static

7: The external video stream to be stopped importing is unauthorized.

◆ INJECT_STREAM_STATUS_STOP_TIMEDOUT

final int io.agora.rtc.Constants.INJECT_STREAM_STATUS_STOP_TIMEDOUT = 8
static

8: Stop importing external video stream timeout.

◆ INJECT_STREAM_STATUS_STOP_FAILED

final int io.agora.rtc.Constants.INJECT_STREAM_STATUS_STOP_FAILED = 9
static

9: Stop importing external video stream failed.

◆ INJECT_STREAM_STATUS_BROKEN

final int io.agora.rtc.Constants.INJECT_STREAM_STATUS_BROKEN = 10
static

10: The external video stream is corrupted.

◆ QUALITY_REPORT_FORMAT_JSON

final int io.agora.rtc.Constants.QUALITY_REPORT_FORMAT_JSON = 0
static

0: The quality report is in JSON format.

◆ QUALITY_REPORT_FORMAT_HTML

final int io.agora.rtc.Constants.QUALITY_REPORT_FORMAT_HTML = 1
static

1: The quality report is in HTML format.

◆ RENDER_MODE_HIDDEN

final int io.agora.rtc.Constants.RENDER_MODE_HIDDEN = 1
static

1: Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.

◆ RENDER_MODE_FIT

final int io.agora.rtc.Constants.RENDER_MODE_FIT = 2
static

2: Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio are filled with black.

◆ RENDER_MODE_ADAPTIVE

final int io.agora.rtc.Constants.RENDER_MODE_ADAPTIVE = 3
static
Deprecated:
3: Adaptive mode: If both callers use the same screen orientation, such as both use vertical screens or both use horizontal screens, the RENDER_MODE_HIDDEN mode applies; if they use different screen orientations, such as one vertical and one horizontal, the RENDER_MODE_FIT mode applies.

◆ VIDEO_MIRROR_MODE_AUTO

final int io.agora.rtc.Constants.VIDEO_MIRROR_MODE_AUTO = 0
static

0: The default mirror mode (the mode set by the SDK).

◆ VIDEO_MIRROR_MODE_ENABLED

final int io.agora.rtc.Constants.VIDEO_MIRROR_MODE_ENABLED = 1
static

1: Enable the mirror mode.

◆ VIDEO_MIRROR_MODE_DISABLED

final int io.agora.rtc.Constants.VIDEO_MIRROR_MODE_DISABLED = 2
static

2: Disable the mirror mode

◆ LOG_FILTER_OFF

final int io.agora.rtc.Constants.LOG_FILTER_OFF = 0
static

0: Do not output any log.

◆ LOG_FILTER_DEBUG

final int io.agora.rtc.Constants.LOG_FILTER_DEBUG = 0x80f
static

0x80f: Output all API logs.

◆ LOG_FILTER_INFO

final int io.agora.rtc.Constants.LOG_FILTER_INFO = 0x0f
static

0x0f: Output logs of the CRITICAL, ERROR, WARNING, and INFO level.

◆ LOG_FILTER_WARNING

final int io.agora.rtc.Constants.LOG_FILTER_WARNING = 0x0e
static

0x0e: Output logs of the CRITICAL, ERROR, and WARNING level.

◆ LOG_FILTER_ERROR

final int io.agora.rtc.Constants.LOG_FILTER_ERROR = 0x0c
static

0x0c: Output logs of the CRITICAL and ERROR level.

◆ LOG_FILTER_CRITICAL

final int io.agora.rtc.Constants.LOG_FILTER_CRITICAL = 0x08
static

0x08: Output logs of the CRITICAL level.

◆ AUDIO_ROUTE_DEFAULT

final int io.agora.rtc.Constants.AUDIO_ROUTE_DEFAULT = -1
static

-1: Default audio route.

◆ AUDIO_ROUTE_HEADSET

final int io.agora.rtc.Constants.AUDIO_ROUTE_HEADSET = 0
static

0: Headset.

◆ AUDIO_ROUTE_EARPIECE

final int io.agora.rtc.Constants.AUDIO_ROUTE_EARPIECE = 1
static

1: Earpiece.

◆ AUDIO_ROUTE_HEADSETNOMIC

final int io.agora.rtc.Constants.AUDIO_ROUTE_HEADSETNOMIC = 2
static

2: Headset with no microphone.

◆ AUDIO_ROUTE_SPEAKERPHONE

final int io.agora.rtc.Constants.AUDIO_ROUTE_SPEAKERPHONE = 3
static

3: Speakerphone.

◆ AUDIO_ROUTE_LOUDSPEAKER

final int io.agora.rtc.Constants.AUDIO_ROUTE_LOUDSPEAKER = 4
static

4: Loudspeaker.

◆ AUDIO_ROUTE_HEADSETBLUETOOTH

final int io.agora.rtc.Constants.AUDIO_ROUTE_HEADSETBLUETOOTH = 5
static

5: Bluetooth headset.

◆ VIDEO_STREAM_HIGH

final int io.agora.rtc.Constants.VIDEO_STREAM_HIGH = 0
static

0: High-stream (high-resolution, high-bitrate) video.

◆ VIDEO_STREAM_LOW

final int io.agora.rtc.Constants.VIDEO_STREAM_LOW = 1
static

1: Low-stream (low-resolution, low-bitrate) video.

◆ HARDWARE_ENCODER

final int io.agora.rtc.Constants.HARDWARE_ENCODER = 0
static

0: Hardware encoder.

◆ SOFTWARE_ENCODER

final int io.agora.rtc.Constants.SOFTWARE_ENCODER = 1
static

1: Software encoder.

◆ RAW_AUDIO_FRAME_OP_MODE_READ_ONLY

final int io.agora.rtc.Constants.RAW_AUDIO_FRAME_OP_MODE_READ_ONLY = 0
static

0: Read-only mode. Users only read the Agora Audio Frame data without modifying anything. For example, when users acquire data with the Agora SDK and push RTMP streams by themselves.

◆ RAW_AUDIO_FRAME_OP_MODE_WRITE_ONLY

final int io.agora.rtc.Constants.RAW_AUDIO_FRAME_OP_MODE_WRITE_ONLY = 1
static

1: Write-only mode. Users replace the Agora Audio Frame data with their own data and pass it to the SDK for encoding. For example, when users acquire data by themselves.

◆ RAW_AUDIO_FRAME_OP_MODE_READ_WRITE

final int io.agora.rtc.Constants.RAW_AUDIO_FRAME_OP_MODE_READ_WRITE = 2
static

2: Read and write mode. Users read the data from the Agora Audio Frame, modify it and then play it. For example, when users have their own sound-effect processing module and want to do voice pre-processing, such as a voice change.

◆ CONNECTION_STATE_DISCONNECTED

final int io.agora.rtc.Constants.CONNECTION_STATE_DISCONNECTED = 1
static

1: The SDK is disconnected from Agora's edge server.

  • This is the initial state before calling the joinChannel method.
  • The SDK also enters this state when the app calls the leaveChannel method.

◆ CONNECTION_STATE_CONNECTING

final int io.agora.rtc.Constants.CONNECTION_STATE_CONNECTING = 2
static

2: The SDK is connecting to Agora's edge server.

◆ CONNECTION_STATE_CONNECTED

final int io.agora.rtc.Constants.CONNECTION_STATE_CONNECTED = 3
static

3: The SDK is connected to Agora's edge server and has joined a channel. You can now publish or subscribe to a media stream in the channel. If the connection to the channel is lost because, for example, the network is down or switched, the SDK triggers:

◆ CONNECTION_STATE_RECONNECTING

final int io.agora.rtc.Constants.CONNECTION_STATE_RECONNECTING = 4
static

4: The SDK keeps rejoining the channel after being disconnected from a joined channel because of network issues.

  • If the SDK cannot join the channel within 10 seconds after being disconnected from Agora's edge server, the SDK triggers the onConnectionLost (deprecated) callback, stays in the CONNECTION_STATE_RECONNECTING state, and keeps rejoining the channel.
  • If the SDK fails to rejoin the channel 20 minutes after being disconnected from Agora's edge server, the SDK triggers the onConnectionStateChanged callback, switches to the CONNECTION_STATE_FAILED state, and keeps rejoining the channel.

◆ CONNECTION_STATE_FAILED

final int io.agora.rtc.Constants.CONNECTION_STATE_FAILED = 5
static

5: The SDK fails to connect to Agora's edge server or join the channel. You must call the leaveChannel method to leave this state and call the joinChannel method again to rejoin the channel. If the SDK is banned from joining the channel by the Agora server (through the RESTful API), the SDK triggers the onConnectionBanned and onConnectionStateChanged callbacks.

◆ CONNECTION_CHANGED_CONNECTING

final int io.agora.rtc.Constants.CONNECTION_CHANGED_CONNECTING = 0
static

0: The SDK is connecting to Agora's edge server.

◆ CONNECTION_CHANGED_JOIN_SUCCESS

final int io.agora.rtc.Constants.CONNECTION_CHANGED_JOIN_SUCCESS = 1
static

1: The SDK has joined the channel successfully.

◆ CONNECTION_CHANGED_INTERRUPTED

final int io.agora.rtc.Constants.CONNECTION_CHANGED_INTERRUPTED = 2
static

2: The connection between the SDK and Agora's edge server is interrupted.

◆ CONNECTION_CHANGED_BANNED_BY_SERVER

final int io.agora.rtc.Constants.CONNECTION_CHANGED_BANNED_BY_SERVER = 3
static

3: The connection between the SDK and Agora's edge server is banned by Agora's edge server.

◆ CONNECTION_CHANGED_JOIN_FAILED

final int io.agora.rtc.Constants.CONNECTION_CHANGED_JOIN_FAILED = 4
static

4: The SDK fails to join the channel for more than 20 minutes and stops reconnecting to the channel.

◆ CONNECTION_CHANGED_LEAVE_CHANNEL

final int io.agora.rtc.Constants.CONNECTION_CHANGED_LEAVE_CHANNEL = 5
static

5: The SDK has left the channel.

◆ STREAM_LIFE_CYCLE_BIND2CHANNEL

final int io.agora.rtc.Constants.STREAM_LIFE_CYCLE_BIND2CHANNEL = 1
static
Deprecated:
1: Binds the RTMP stream lifecycle to the channel lifecycle. If all hosts leave the channel, CDN live streaming stops after 30 seconds.

◆ STREAM_LIFE_CYCLE_BIND2OWNER

final int io.agora.rtc.Constants.STREAM_LIFE_CYCLE_BIND2OWNER = 2
static
Deprecated:
2: Binds the RTMP stream lifecycle to the owner of the RTMP stream. If the owner leaves the channel, CDN live streaming stops immediately.

◆ AUDIO_RECORDING_QUALITY_LOW

final int io.agora.rtc.Constants.AUDIO_RECORDING_QUALITY_LOW = 0
static

0: Low quality. The file size is around 1.2 MB after 10 minutes of recording.

◆ AUDIO_RECORDING_QUALITY_MEDIUM

final int io.agora.rtc.Constants.AUDIO_RECORDING_QUALITY_MEDIUM = 1
static

1: Medium quality. The file size is around 2 MB after 10 minutes of recording.

◆ AUDIO_RECORDING_QUALITY_HIGH

final int io.agora.rtc.Constants.AUDIO_RECORDING_QUALITY_HIGH = 2
static

2: High quality. The file size is around 3.75 MB after 10 minutes of recording.

◆ MEDIA_TYPE_NONE

final int io.agora.rtc.Constants.MEDIA_TYPE_NONE = 0
static

0: None.

◆ MEDIA_TYPE_AUDIO_ONLY

final int io.agora.rtc.Constants.MEDIA_TYPE_AUDIO_ONLY = 1
static

1: Audio only.

◆ MEDIA_TYPE_VIDEO_ONLY

final int io.agora.rtc.Constants.MEDIA_TYPE_VIDEO_ONLY = 2
static

2: Video only.

◆ MEDIA_TYPE_AUDIO_AND_VIDEO

final int io.agora.rtc.Constants.MEDIA_TYPE_AUDIO_AND_VIDEO = 3
static

3: Audio and video.

◆ STREAM_FALLBACK_OPTION_DISABLED

final int io.agora.rtc.Constants.STREAM_FALLBACK_OPTION_DISABLED = 0
static

0: No fallback behavior for the local/remote streams when the uplink/downlink network condition is poor. The quality of the stream is not guaranteed.

◆ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW

final int io.agora.rtc.Constants.STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW = 1
static

1: Under poor downlink network conditions, the remotely subscribed stream falls back to the low-stream (low-resolution and low-bitrate) video. You can only set this option in the setRemoteSubscribeFallbackOption method. Nothing happens when you set this in the setLocalPublishFallbackOption method.

◆ STREAM_FALLBACK_OPTION_AUDIO_ONLY

final int io.agora.rtc.Constants.STREAM_FALLBACK_OPTION_AUDIO_ONLY = 2
static

2:

  • Under poor uplink network conditions, the locally published stream falls back audio only.
  • Under poor downlink network conditions, the remotely subscribed stream first falls back to the low-stream (low-resolution and low-bitrate) video; and then to an audio-only stream if the network condition deteriorates.