Agora Java API Reference for Android
Static Public Attributes | List of all members
io.agora.rte.base.AgoraRteErrorCodeType Class Reference

Static Public Attributes

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_INVALID_STATE = 8
 
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_ABORTED = 20
 
static final int ERR_INIT_NET_ENGINE = 21
 
static final int ERR_RESOURCE_LIMITED = 22
 
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_STREAM_MESSAGE_TIMEOUT = 117
 
static final int ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED = 119
 
static final int ERR_DECRYPTION_FAILED = 120
 
static final int ERR_INVALID_USER_ID = 121
 
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_PUBLISH = 130
 
static final int ERR_LICENSE_CREDENTIAL_INVALID = 131
 
static final int ERR_CERT_RAW = 157
 
static final int ERR_CERT_JSON_PART = 158
 
static final int ERR_CERT_JSON_INVAL = 159
 
static final int ERR_CERT_JSON_NOMEM = 160
 
static final int ERR_CERT_CUSTOM = 161
 
static final int ERR_CERT_CREDENTIAL = 162
 
static final int ERR_CERT_SIGN = 163
 
static final int ERR_CERT_FAIL = 164
 
static final int ERR_CERT_BUF = 165
 
static final int ERR_CERT_NULL = 166
 
static final int ERR_CERT_DUEDATE = 167
 
static final int ERR_CERT_REQUEST = 168
 
static final int ERR_PCMSEND_FORMAT = 200
 
static final int ERR_PCMSEND_BUFFEROVERFLOW
 

Member Data Documentation

◆ ERR_OK

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_OK = 0
static

0: No error occurs.

◆ ERR_FAILED

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_FAILED = 1
static

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

◆ ERR_INVALID_ARGUMENT

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_INVALID_ARGUMENT = 2
static

2: The argument is invalid. For example, the specific channel name includes illegal characters.

◆ ERR_NOT_READY

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_NOT_READY = 3
static

3: The SDK module is not ready. Choose one of the following solutions:

  • Check the audio device.
  • Check the completeness of the app.
  • Reinitialize the RTC engine.

◆ ERR_NOT_SUPPORTED

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_NOT_SUPPORTED = 4
static

4: The SDK does not support this function.

◆ ERR_REFUSED

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_REFUSED = 5
static

5: The request is rejected.

◆ ERR_BUFFER_TOO_SMALL

final int io.agora.rte.base.AgoraRteErrorCodeType.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.rte.base.AgoraRteErrorCodeType.ERR_NOT_INITIALIZED = 7
static

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

◆ ERR_INVALID_STATE

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_INVALID_STATE = 8
static

8: The state is invalid.

◆ ERR_NO_PERMISSION

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_NO_PERMISSION = 9
static

9: No permission. This is for internal use only, and does not return to the app through any method or callback.

◆ ERR_TIMEDOUT

final int io.agora.rte.base.AgoraRteErrorCodeType.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 (more than 10 seconds) for the SDK to process.

◆ ERR_CANCELED

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_CANCELED = 11
static

11: The request is cancelled. This is for internal use only, and does not return to the app through any method or callback.

◆ ERR_TOO_OFTEN

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_TOO_OFTEN = 12
static

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

◆ ERR_BIND_SOCKET

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_BIND_SOCKET = 13
static

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

◆ ERR_NET_DOWN

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_NET_DOWN = 14
static

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

◆ ERR_NET_NOBUFS

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_NET_NOBUFS = 15
static

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

◆ ERR_JOIN_CHANNEL_REJECTED

final int io.agora.rte.base.AgoraRteErrorCodeType.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 method to join the channel, for example, joinChannel().

◆ ERR_LEAVE_CHANNEL_REJECTED

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_LEAVE_CHANNEL_REJECTED = 18
static

18: The request to leave the channel is rejected. This error usually occurs when the user has already left the channel, and still calls the method to leave the channel, for example, leaveChannel.

◆ ERR_ALREADY_IN_USE

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_ALREADY_IN_USE = 19
static

19: The resources have been occupied and cannot be reused.

◆ ERR_ABORTED

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_ABORTED = 20
static

20: The SDK gives up the request due to too many requests. This is for internal use only, and does not return to the app through any method or callback.

◆ ERR_INIT_NET_ENGINE

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_INIT_NET_ENGINE = 21
static

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

◆ ERR_RESOURCE_LIMITED

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_RESOURCE_LIMITED = 22
static

22: The app uses too much of the system resource and the SDK fails to allocate any resource.

◆ ERR_INVALID_APP_ID

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_INVALID_APP_ID = 101
static

101: The App ID is invalid, usually because the data format of the App ID is incorrect.

Solution: Check the data format of your App ID. Ensure that you use the correct App ID to initialize the Agora service.

◆ ERR_INVALID_CHANNEL_NAME

final int io.agora.rte.base.AgoraRteErrorCodeType.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.rte.base.AgoraRteErrorCodeType.ERR_TOKEN_EXPIRED = 109
static

109: The token has expired, usually for the following reasons:

  • Timeout for token authorization: Once a token is generated, you must use it to access the Agora service within 24 hours. Otherwise, the token times out and you can no longer use it.
  • The token privilege expires: To generate a token, you need to set a timestamp for the token privilege to expire. For example, If you set it as seven days, the token expires seven days after its usage. In that case, you can no longer access the Agora service. The users cannot make calls, or are kicked out of the channel.

Solution: Regardless of whether token authorization times out or the token privilege expires, you need to generate a new token on your server, and try to join the channel.

◆ ERR_INVALID_TOKEN

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_INVALID_TOKEN = 110
static

110: The token is invalid, usually for one of the following reasons:

  • Did not provide a token when joining a channel in a situation where the project has enabled the App Certificate.
  • Tried to join a channel with a token in a situation where the project has not enabled the App Certificate.
  • The App ID, user ID and channel name that you use to generate the token on the server do not match those that you use when joining a channel.

Solution:

  • Before joining a channel, check whether your project has enabled the App certificate. If yes, you must provide a token when joining a channel; if no, join a channel without a token.
  • When using a token to join a channel, ensure that the App ID, user ID, and channel name that you use to generate the token is the same as the App ID that you use to initialize the Agora service, and the user ID and channel name that you use to join the channel.

◆ ERR_CONNECTION_INTERRUPTED

final int io.agora.rte.base.AgoraRteErrorCodeType.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.rte.base.AgoraRteErrorCodeType.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.rte.base.AgoraRteErrorCodeType.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.rte.base.AgoraRteErrorCodeType.ERR_SIZE_TOO_LARGE = 114
static

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

◆ ERR_BITRATE_LIMIT

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_BITRATE_LIMIT = 115
static

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

◆ ERR_TOO_MANY_DATA_STREAMS

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_TOO_MANY_DATA_STREAMS = 116
static

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

◆ ERR_STREAM_MESSAGE_TIMEOUT

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_STREAM_MESSAGE_TIMEOUT = 117
static

117: A timeout occurs for the data stream transmission.

◆ ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED = 119
static

119: Switching the user role fails. Please try to rejoin the channel.

◆ ERR_DECRYPTION_FAILED

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_DECRYPTION_FAILED = 120
static

120: Decryption fails. The user may have tried to join the channel with a wrong password. Check your settings or try rejoining the channel.

◆ ERR_INVALID_USER_ID

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_INVALID_USER_ID = 121
static

121: The user ID is invalid.

◆ ERR_CLIENT_IS_BANNED_BY_SERVER

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_CLIENT_IS_BANNED_BY_SERVER = 123
static

123: The app is banned by the server.

◆ ERR_WATERMARK_PARAM

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_WATERMARK_PARAM = 124
static

124: Incorrect watermark file parameter.

◆ ERR_WATERMARK_PATH

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_WATERMARK_PATH = 125
static

125: Incorrect watermark file path.

◆ ERR_WATERMARK_PNG

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_WATERMARK_PNG = 126
static

126: Incorrect watermark file format.

◆ ERR_WATERMARKR_INFO

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_WATERMARKR_INFO = 127
static

127: Incorrect watermark file information.

◆ ERR_WATERMARK_ARGB

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_WATERMARK_ARGB = 128
static

128: Incorrect watermark file data format.

◆ ERR_WATERMARK_READ

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_WATERMARK_READ = 129
static

129: An error occurs in reading the watermark file.

◆ ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH = 130
static

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

◆ ERR_LICENSE_CREDENTIAL_INVALID

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_LICENSE_CREDENTIAL_INVALID = 131
static

131: License credential is invalid

◆ ERR_PCMSEND_BUFFEROVERFLOW

final int io.agora.rte.base.AgoraRteErrorCodeType.ERR_PCMSEND_BUFFEROVERFLOW
static
Initial value:
=
201