SDK error codes

Updated

List of commonly encountered API errors and their causes.

When interacting with the Agora API, the Video SDK may return an error code. Receiving an error code indicates that the SDK has encountered an unrecoverable error that requires intervention from your app.

This page provides descriptions for common error codes, their causes, and suggested solutions. For error codes without predefined solutions, contact technical support for assistance.

The error codes listed in this section apply to Agora RTC v4.x SDK on native platforms and third-party frameworks, including Android, iOS, macOS, Windows, Electron, Unity, React Native, Flutter, Unreal Engine, and Unreal Blueprint.

During operation, error codes may be returned in the following ways:

  • In the return value of a failed method call.
  • Through the onError callback.

When the SDK returns an error code, it may return a negative number. This negative number corresponds to the positive integer in the error code. For example, if it returns -2, it corresponds to 2 in the error code.

The API names in this article are based on the C++ API. API names for other platforms may be different. Refer to the API documentation for the corresponding platform.

Common error codes

Error codeDescription
1General error with no clearly categorized cause. Call the method again.
2An invalid parameter was set in the method. For example, the specified channel name contains illegal characters. Reset the parameters.
3The SDK is not ready. Possible reasons include failed RtcEngine initialization, calling a method before joining a channel, calling a method after leaving a channel, the audio module not being enabled, or incomplete assembly.
4The current state of RtcEngine does not support this operation. Possible reasons include an incorrect built-in encryption mode or a failed external encryption library load.
5The method call is rejected. Possible reasons include failed RtcEngine initialization, an empty channel name, or reusing an existing channel name in a multi-channel use case.
6The buffer size is not large enough to hold the returned data.
7The method is called before RtcEngine is initialized. Create and initialize the RtcEngine object before calling the method.
8The current state is invalid. Check the SDK callback logs to find the exact reason.
9There is no permission to operate. Check whether the user has granted the app permission to use audio or video devices.
10Method call timed out. Some method calls require the SDK to return results, and this error occurs if the SDK does not return for more than 10 seconds.
17Joining a channel is rejected. The user may already be in the channel, or an echo test may still be running. Use onConnectionStateChanged to determine whether the user is in the channel, and call stopEchoTest before joining after an echo test.
18Failed to leave the channel. The user may already have left the channel, or the leave method may have been called before the user joined.
19The resource is occupied and cannot be reused.
20The SDK abandons the request, possibly due to too many requests.
21Specific firewall settings on Windows cause RtcEngine initialization to fail and then crash.
22The SDK failed to allocate resources, possibly because the app uses too many resources or system resources are exhausted.
101The App ID is invalid. Rejoin the channel with a valid App ID.
102The channel name is invalid. Check whether the parameter data type is correct and rejoin with a valid channel name.
103The SDK cannot get server resources for the current region. Specify a different region when initializing RtcEngine.
109The current token has expired. Generate a new token on the server and call renewToken to update it. This error code is deprecated; the SDK returns CONNECTION_CHANGED_TOKEN_EXPIRED(9) in onConnectionStateChanged instead.
110The token is invalid. Possible reasons include enabling the App Certificate without using App ID plus token authentication, or using a token whose uid does not match the uid used to join the channel. This error code is deprecated; the SDK returns CONNECTION_CHANGED_INVALID_TOKEN(8) in onConnectionStateChanged instead.
111The network connection is interrupted. After the SDK established a connection with the server, the network connection was lost for more than 4 seconds.
112Network connection lost. The network connection was interrupted and the SDK could not connect to the server within 10 seconds.
119The user failed to switch roles. Try joining the channel again.
120Decryption failed. The user may have used the wrong password when joining the channel. Check the password or ask the user to rejoin.
121The user ID is invalid.
123This user has been banned by the server. This error is reported when the user is kicked out by the server.
134The user account is invalid, possibly because invalid parameters are set.
Error codeDescription
1005An unspecified error occurred in the audio device. Check if the audio device is occupied by another application or re-enter the channel.
1008An error occurred while initializing the playback device. Check if the playback device is occupied by another application or re-enter the channel.
1009Error starting the playback device. Check whether the playback device is working properly.
1010Error stopping the playback device.
1011Error initializing the recording device. Check whether the recording device is working properly or re-enter the channel.
1012Error starting the recording device. Check whether the recording device is working properly.
1013Error stopping the recording device.
Error codeDescription
113The user was not in the channel when sendStreamMessage was called.
114The length of the data sent by sendStreamMessage was greater than 1024 bytes.
115The frequency of sending data exceeded the limit of 6 KB/s when calling sendStreamMessage.
116The number of data streams exceeded the limit of 5 when createDataStream was called.
117Data stream send timeout. If the receiver does not receive reliable or ordered data within 5 seconds, or detects missing data, onStreamMessageError is triggered on the receiving end.

Other error codes

Error codeDescription
130The SDK does not support pushing encrypted streams to a CDN.
1001Failed to load the media engine.
1501There is no permission to use the camera. Check whether camera permission is enabled.