Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ERROR_CODE_TYPE

Error code.

Index

Enumeration members

Enumeration members

ERR_ABORTED

ERR_ABORTED: = 20

20: The SDK gives up the request due to too many requests.

ERR_ADM_ANDROID_JNI_JAVA_RECORD_ERROR

ERR_ADM_ANDROID_JNI_JAVA_RECORD_ERROR: = 1115

1115: Audio device module: AudioRecord returns error. The SDK will automatically restart AudioRecord.

ERR_ADM_ANDROID_JNI_JAVA_RESOURCE

ERR_ADM_ANDROID_JNI_JAVA_RESOURCE: = 1101

1101: Audio device module: A fatal exception occurs.

ERR_ADM_ANDROID_JNI_JAVA_START_PLAYBACK

ERR_ADM_ANDROID_JNI_JAVA_START_PLAYBACK: = 1112

1112: Audio device module: AudioTrack fails to start up. A ROM system error occurs. We recommend the following options to debug:

  • Restart your App.
  • Restart your cellphone.
  • Check your playback permission.

ERR_ADM_ANDROID_JNI_JAVA_START_RECORD

ERR_ADM_ANDROID_JNI_JAVA_START_RECORD: = 1111

1111: Audio device module: AudioRecord fails to start up. A ROM system error occurs. We recommend the following options to debug:

  • Restart your App.
  • Restart your cellphone.
  • Check your recording permission.

ERR_ADM_ANDROID_JNI_NO_PLAYBACK_FREQUENCY

ERR_ADM_ANDROID_JNI_NO_PLAYBACK_FREQUENCY: = 1109

1109: The playback frequency is lower than 50. 0 indicates that the playback is not yet started. We recommend checking if you have created too many AudioTrack instances.

ERR_ADM_ANDROID_JNI_NO_RECORD_FREQUENCY

ERR_ADM_ANDROID_JNI_NO_RECORD_FREQUENCY: = 1108

1108: Audio device module: The recording frequency is lower than 50. 0 indicates that the recording is not yet started. We recommend checking your recording permission.

ERR_ADM_ANDROID_OPENSL_CREATE_AUDIO_PLAYER

ERR_ADM_ANDROID_OPENSL_CREATE_AUDIO_PLAYER: = 1157
deprecated

ERR_ADM_ANDROID_OPENSL_CREATE_AUDIO_RECORDER

ERR_ADM_ANDROID_OPENSL_CREATE_AUDIO_RECORDER: = 1153
deprecated

ERR_ADM_ANDROID_OPENSL_CREATE_ENGINE

ERR_ADM_ANDROID_OPENSL_CREATE_ENGINE: = 1151
deprecated

ERR_ADM_ANDROID_OPENSL_START_PLAYER_THREAD

ERR_ADM_ANDROID_OPENSL_START_PLAYER_THREAD: = 1160
deprecated

ERR_ADM_ANDROID_OPENSL_START_RECORDER_THREAD

ERR_ADM_ANDROID_OPENSL_START_RECORDER_THREAD: = 1156
deprecated

ERR_ADM_GENERAL_ERROR

ERR_ADM_GENERAL_ERROR: = 1005

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

ERR_ADM_INIT_LOOPBACK

ERR_ADM_INIT_LOOPBACK: = 1022

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

ERR_ADM_INIT_PLAYOUT

ERR_ADM_INIT_PLAYOUT: = 1008

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

ERR_ADM_INIT_RECORDING

ERR_ADM_INIT_RECORDING: = 1011

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

ERR_ADM_IOS_ACTIVATE_SESSION_FAIL

ERR_ADM_IOS_ACTIVATE_SESSION_FAIL: = 1206

1206: Audio device module: Cannot activate the Audio Session.

ERR_ADM_IOS_INPUT_NOT_AVAILABLE

ERR_ADM_IOS_INPUT_NOT_AVAILABLE: = 1201

1201: Audio device module: The current device does not support audio input, possibly because you have mistakenly configured the audio session category, or because some other app is occupying the input device. We recommend terminating all background apps and re-joining the channel.

ERR_ADM_IOS_SESSION_SAMPLERATR_ZERO

ERR_ADM_IOS_SESSION_SAMPLERATR_ZERO: = 1221
deprecated

ERR_ADM_IOS_VPIO_INIT_FAIL

ERR_ADM_IOS_VPIO_INIT_FAIL: = 1210

1210: Audio device module: Fails to initialize the audio device, normally because the audio device parameters are wrongly set.

ERR_ADM_IOS_VPIO_REINIT_FAIL

ERR_ADM_IOS_VPIO_REINIT_FAIL: = 1213

1213: Audio device module: Fails to re-initialize the audio device, normally because the audio device parameters are wrongly set.

ERR_ADM_IOS_VPIO_RESTART_FAIL

ERR_ADM_IOS_VPIO_RESTART_FAIL: = 1214

1214: Fails to re-start up the Audio Unit, possibly because the audio session category is not compatible with the settings of the Audio Unit.

ERR_ADM_JAVA_RESOURCE

ERR_ADM_JAVA_RESOURCE: = 1006

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

ERR_ADM_NO_PERMISSION

ERR_ADM_NO_PERMISSION: = 1027

1027: Audio Device Module: No recording permission exists. Check if the recording permission is granted.

ERR_ADM_NO_PLAYOUT_DEVICE

ERR_ADM_NO_PLAYOUT_DEVICE: = 1360

1360: Audio Device Module: No playback device exists.

ERR_ADM_NO_RECORDING_DEVICE

ERR_ADM_NO_RECORDING_DEVICE: = 1359

1359: Audio Device Module: No recording device exists.

ERR_ADM_RECORD_AUDIO_FAILED

ERR_ADM_RECORD_AUDIO_FAILED: = 1018

1018: Audio Device Module: Fails to record.

ERR_ADM_RECORD_AUDIO_IS_ACTIVE

ERR_ADM_RECORD_AUDIO_IS_ACTIVE: = 1033

1033: Audio device module: The device is occupied.

ERR_ADM_RUNTIME_PLAYOUT_ERROR

ERR_ADM_RUNTIME_PLAYOUT_ERROR: = 1015

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

ERR_ADM_RUNTIME_RECORDING_ERROR

ERR_ADM_RUNTIME_RECORDING_ERROR: = 1017

1017: Audio Device Module: A recording error occurs.

ERR_ADM_SAMPLE_RATE

ERR_ADM_SAMPLE_RATE: = 1007

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

ERR_ADM_START_LOOPBACK

ERR_ADM_START_LOOPBACK: = 1023

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

ERR_ADM_START_PLAYOUT

ERR_ADM_START_PLAYOUT: = 1009

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

ERR_ADM_START_RECORDING

ERR_ADM_START_RECORDING: = 1012

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

ERR_ADM_STOP_PLAYOUT

ERR_ADM_STOP_PLAYOUT: = 1010

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

ERR_ADM_STOP_RECORDING

ERR_ADM_STOP_RECORDING: = 1013

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

ERR_ADM_WIN_CORE_CAPTURE_NOT_STARTUP

ERR_ADM_WIN_CORE_CAPTURE_NOT_STARTUP: = 1314

1314: Audio device module: An audio driver abnormality occurs. Solutions:

  • Disable and then re-enable the audio device.
  • Reboot the system.
  • Upgrade your audio card driver.

ERR_ADM_WIN_CORE_CREATE_REC_THREAD

ERR_ADM_WIN_CORE_CREATE_REC_THREAD: = 1311

1311: Audio device module: Insufficient system memory or poor device performance. Solutions: Reboot the system or replace the device.

ERR_ADM_WIN_CORE_CREATE_RENDER_THREAD

ERR_ADM_WIN_CORE_CREATE_RENDER_THREAD: = 1319

1319: Audio device module: Insufficient system memory or poor device performance. Solutions: Reboot the system or replace the device.

ERR_ADM_WIN_CORE_INIT

ERR_ADM_WIN_CORE_INIT: = 1301

1301: Audio device module: An audio driver abnomality or a compatibility issue occurs. Solutions: Disable and restart the audio device, or reboot the system

ERR_ADM_WIN_CORE_INIT_PLAYOUT

ERR_ADM_WIN_CORE_INIT_PLAYOUT: = 1306

1306: Audio device module: A playout driver abnomality or a compatibility issue occurs. Solutions: Disable and restart the audio device, or reboot the system.

ERR_ADM_WIN_CORE_INIT_PLAYOUT_NULL

ERR_ADM_WIN_CORE_INIT_PLAYOUT_NULL: = 1307

1307: Audio device module: No audio device is available. Solutions: Plug in a proper audio device.

ERR_ADM_WIN_CORE_INIT_RECORDING

ERR_ADM_WIN_CORE_INIT_RECORDING: = 1303

1303: Audio device module: A recording driver abnomality or a compatibility issue occurs. Solutions: Disable and restart the audio device, or reboot the system.

ERR_ADM_WIN_CORE_NO_PLAYOUT_DEVICE

ERR_ADM_WIN_CORE_NO_PLAYOUT_DEVICE: = 1323

1323: Audio device module: No audio playout device is available. Solutions: Plug in a proper playback device.

ERR_ADM_WIN_CORE_NO_RECORDING_DEVICE

ERR_ADM_WIN_CORE_NO_RECORDING_DEVICE: = 1322

1322: Audio device module: No audio sampling device is available. Solutions: Plug in a proper recording device.

ERR_ADM_WIN_CORE_RENDER_NOT_STARTUP

ERR_ADM_WIN_CORE_RENDER_NOT_STARTUP: = 1320

1320: Audio device module: An audio driver abnormality occurs. Solutions:

  • Disable and then re-enable the audio device.
  • Reboot the system.
  • Replace the device.

ERR_ADM_WIN_CORE_START_RECORDING

ERR_ADM_WIN_CORE_START_RECORDING: = 1309

1309: Audio device module: An audio driver abnomality or a compatibility issue occurs. Solutions: Disable and restart the audio device, or reboot the system.

ERR_ADM_WIN_WAVE_INIT

ERR_ADM_WIN_WAVE_INIT: = 1351

1351: Audio device module: An audio driver abnormality or a compatibility issue occurs. Solutions:

  • Disable and then re-enable the audio device.
  • Reboot the system.
  • Upgrade your audio card driver.

ERR_ADM_WIN_WAVE_INIT_MICROPHONE

ERR_ADM_WIN_WAVE_INIT_MICROPHONE: = 1354

1354: Audio device module: An audio driver abnormality occurs. Solutions:

  • Disable and then re-enable the audio device.
  • Reboot the system.
  • Upgrade your audio card driver.

ERR_ADM_WIN_WAVE_INIT_PLAYOUT

ERR_ADM_WIN_WAVE_INIT_PLAYOUT: = 1355

1355: Audio device module: An audio driver abnormality occurs. Solutions:

  • Disable and then re-enable the audio device.
  • Reboot the system.
  • Upgrade your audio card driver.

ERR_ADM_WIN_WAVE_INIT_RECORDING

ERR_ADM_WIN_WAVE_INIT_RECORDING: = 1353

1353: Audio device module: An audio driver abnormality occurs. Solutions:

  • Disable and then re-enable the audio device.
  • Reboot the system.
  • Upgrade your audio card driver.

ERR_ADM_WIN_WAVE_INIT_SPEAKER

ERR_ADM_WIN_WAVE_INIT_SPEAKER: = 1356

1356: Audio device module: An audio driver abnormality occurs. Solutions:

  • Disable and then re-enable the audio device.
  • Reboot the system.
  • Upgrade your audio card driver.

ERR_ADM_WIN_WAVE_START_PLAYOUT

ERR_ADM_WIN_WAVE_START_PLAYOUT: = 1358

1358: Audio device module: An audio driver abnormality occurs. Solutions:

  • Disable and then re-enable the audio device.
  • Reboot the system.
  • Upgrade your audio card driver.

ERR_ADM_WIN_WAVE_START_RECORDING

ERR_ADM_WIN_WAVE_START_RECORDING: = 1357

1357: Audio device module: An audio driver abnormality occurs. Solutions:

  • Disable and then re-enable the audio device.
  • Reboot the system.
  • Upgrade your audio card driver.

ERR_ALREADY_IN_USE

ERR_ALREADY_IN_USE: = 19

19: Resources are occupied and cannot be reused.

ERR_BIND_SOCKET

ERR_BIND_SOCKET: = 13

13: The SDK fails to bind to the network socket. This is for internal SDK use only, and it does not return to the application through any method or callback.

ERR_BITRATE_LIMIT

ERR_BITRATE_LIMIT: = 115

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

ERR_BUFFER_TOO_SMALL

ERR_BUFFER_TOO_SMALL: = 6

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

ERR_CANCELED

ERR_CANCELED: = 11

11: The request is canceled. This is for internal SDK use only, and it does not return to the application through any method or callback.

ERR_CLIENT_IS_BANNED_BY_SERVER

ERR_CLIENT_IS_BANNED_BY_SERVER: = 123

123: The client is banned by the server.

ERR_CONNECTION_INTERRUPTED

ERR_CONNECTION_INTERRUPTED: = 111

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

ERR_CONNECTION_LOST

ERR_CONNECTION_LOST: = 112

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

ERR_DECRYPTION_FAILED

ERR_DECRYPTION_FAILED: = 120

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_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH

ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH: = 130

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

ERR_FAILED

ERR_FAILED: = 1

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

ERR_INIT_NET_ENGINE

ERR_INIT_NET_ENGINE: = 21

21: In Windows, specific firewall settings can cause the SDK to fail to initialize and crash.

ERR_INVALID_APP_ID

ERR_INVALID_APP_ID: = 101

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

ERR_INVALID_ARGUMENT

ERR_INVALID_ARGUMENT: = 2

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

ERR_INVALID_CHANNEL_NAME

ERR_INVALID_CHANNEL_NAME: = 102

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

ERR_INVALID_TOKEN

ERR_INVALID_TOKEN: = 110
deprecated

110: Use CONNECTION_CHANGED_INVALID_TOKEN(8) in the onConnectionStateChanged callback instead.

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. 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_INVALID_USER_ACCOUNT

ERR_INVALID_USER_ACCOUNT: = 134

134: The user account is invalid.

ERR_JOIN_CHANNEL_REJECTED

ERR_JOIN_CHANNEL_REJECTED: = 17

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 method to join the channel, for example, joinChannel .
  • This error usually occurs when the user tries to join a channel during a call test (startEchoTest). Once you call startEchoTest , you need to call stopEchoTest before joining a channel.

ERR_LEAVE_CHANNEL_REJECTED

ERR_LEAVE_CHANNEL_REJECTED: = 18

18: The request to leave the channel is rejected.

This error usually occurs:

  • When the user has left the channel and still calls leaveChannel to leave the channel. In this case, stop calling leaveChannel.
  • When the user has not joined the channel and still calls leaveChannel to leave the channel. In this case, no extra operation is needed.

ERR_LOAD_MEDIA_ENGINE

ERR_LOAD_MEDIA_ENGINE: = 1001

1001: Fails to load the media engine.

ERR_NET_DOWN

ERR_NET_DOWN: = 14

14: The network is unavailable. This is for internal SDK use only, and it does not return to the application through any method or callback.

ERR_NET_NOBUFS

ERR_NET_NOBUFS: = 15

15: No network buffers are available. This is for internal SDK internal use only, and it does not return to the application through any method or callback.

ERR_NOT_INITIALIZED

ERR_NOT_INITIALIZED: = 7

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

ERR_NOT_IN_CHANNEL

ERR_NOT_IN_CHANNEL: = 113

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

ERR_NOT_READY

ERR_NOT_READY: = 3

3: The SDK module is not ready. Possible solutions:

  • Check the audio device.
  • Check the completeness of the application.
  • Re-initialize the Agora engine.

ERR_NOT_SUPPORTED

ERR_NOT_SUPPORTED: = 4

4: The SDK does not support this function.

ERR_NO_PERMISSION

ERR_NO_PERMISSION: = 9

9: No permission exists. Check if the user has granted access to the audio or video device.

ERR_NO_SERVER_RESOURCES

ERR_NO_SERVER_RESOURCES: = 103

103: Fails to get server resources in the specified region. Please try to specify another region when calling init .

ERR_OK

ERR_OK: = 0

0: No error occurs.

ERR_PUBLISH_STREAM_CDN_ERROR

ERR_PUBLISH_STREAM_CDN_ERROR: = 151

151: CDN related errors. Remove the original URL address and add a new one by calling the removePublishStreamUrl and addPublishStreamUrl methods.

ERR_PUBLISH_STREAM_FORMAT_NOT_SUPPORTED

ERR_PUBLISH_STREAM_FORMAT_NOT_SUPPORTED: = 156

156: The format of the RTMP stream URL is not supported. Check whether the URL format is correct.

ERR_PUBLISH_STREAM_INTERNAL_SERVER_ERROR

ERR_PUBLISH_STREAM_INTERNAL_SERVER_ERROR: = 154

154: An error occurs in Agora's streaming server. Call the addPublishStreamUrl method to publish the streaming again.

ERR_PUBLISH_STREAM_NOT_AUTHORIZED

ERR_PUBLISH_STREAM_NOT_AUTHORIZED: = 153

153: The host manipulates other hosts' URLs. Check your app logic.

ERR_PUBLISH_STREAM_NOT_FOUND

ERR_PUBLISH_STREAM_NOT_FOUND: = 155

155: The server fails to find the stream.

ERR_PUBLISH_STREAM_NUM_REACH_LIMIT

ERR_PUBLISH_STREAM_NUM_REACH_LIMIT: = 152

152: The host publishes more than 10 URLs. Delete the unnecessary URLs before adding new ones.

ERR_REFUSED

ERR_REFUSED: = 5

5: The request is rejected.

ERR_RESOURCE_LIMITED

ERR_RESOURCE_LIMITED: = 22

22: The application uses too much of the system resources and the SDK fails to allocate the resources.

ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED

ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED: = 119

119: Switching roles fail. Please try to rejoin the channel.

ERR_SIZE_TOO_LARGE

ERR_SIZE_TOO_LARGE: = 114

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

ERR_START_CALL

ERR_START_CALL: = 1002

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

ERR_START_CAMERA

ERR_START_CAMERA: = 1003
deprecated

1003: Fails to start the camera. Use LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE(4) in the onConnectionStateChanged callback instead.

ERR_START_VIDEO_RENDER

ERR_START_VIDEO_RENDER: = 1004

1004: Fails to start the video rendering module.

ERR_STREAM_MESSAGE_TIMEOUT

ERR_STREAM_MESSAGE_TIMEOUT: = 117

117: The data stream transmission timed out.

ERR_TIMEDOUT

ERR_TIMEDOUT: = 10

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

ERR_TOKEN_EXPIRED

ERR_TOKEN_EXPIRED: = 109
deprecated

109: Use CONNECTION_CHANGED_TOKEN_EXPIRED(9) in the onConnectionStateChanged callback instead.

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 24 hours after the Token is generated. If the user does not access the Agora service after 24 hours, this Token is no longer 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 token will expire, but that the user will be banned from the channel.

ERR_TOO_MANY_DATA_STREAMS

ERR_TOO_MANY_DATA_STREAMS: = 116

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

ERR_TOO_OFTEN

ERR_TOO_OFTEN: = 12

12: The method is called too often. This is for internal SDK use only, and it does not return to the application through any method or callback.

ERR_VCM_ENCODER_ENCODE_ERROR

ERR_VCM_ENCODER_ENCODE_ERROR: = 1602

1602: Video Device Module: An error occurs in encoding.

ERR_VCM_ENCODER_INIT_ERROR

ERR_VCM_ENCODER_INIT_ERROR: = 1601

1601: Video Device Module: An error occurs in initializing the video encoder.

ERR_VCM_ENCODER_SET_ERROR

ERR_VCM_ENCODER_SET_ERROR: = 1603

1603: Video Device Module: An error occurs in setting the video encoder.

ERR_VCM_UNKNOWN_ERROR

ERR_VCM_UNKNOWN_ERROR: = 1600

1600: Video Device Module: An unknown error occurs.

ERR_VDM_CAMERA_NOT_AUTHORIZED

ERR_VDM_CAMERA_NOT_AUTHORIZED: = 1501

1501: Video Device Module: The camera is unauthorized.

ERR_VDM_WIN_DEVICE_IN_USE

ERR_VDM_WIN_DEVICE_IN_USE: = 1502
deprecated

1502: Video Device Module: The camera in use.

Use LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY(3) in the onConnectionStateChanged callback instead.

ERR_WATERMARKR_INFO

ERR_WATERMARKR_INFO: = 127

127: Incorrect watermark file information.

ERR_WATERMARK_ARGB

ERR_WATERMARK_ARGB: = 128

128: Incorrect watermark file data format.

ERR_WATERMARK_PARAM

ERR_WATERMARK_PARAM: = 124

124: Incorrect watermark file parameter.

ERR_WATERMARK_PATH

ERR_WATERMARK_PATH: = 125

125: Incorrect watermark file path.

ERR_WATERMARK_PNG

ERR_WATERMARK_PNG: = 126

126: Incorrect watermark file format.

ERR_WATERMARK_READ

ERR_WATERMARK_READ: = 129

129: An error occurs in reading the watermark file.

Generated using TypeDoc