ERROR_CODE_TYPE
Error codes.
Enumerations
- ERR_OK
- (0): No error.
- ERR_FAILED
- (1): General error with unspecified reason. Please retry the method.
- ERR_INVALID_ARGUMENT
- (2): Invalid parameter. For example, the channel name contains illegal characters. Please reset the parameter.
- ERR_NOT_READY
- (3): SDK is not ready. Possible causes include: IRtcEngine failed to initialize; the method was called before joining a channel; rate or complain was called before leaving the channel; the audio module is disabled; the program is incomplete.
- ERR_NOT_SUPPORTED
- (4): IRtcEngine does not support the request. Possible causes include: incorrect built-in encryption mode setting, or SDK failed to load the external encryption library. Please check the encryption mode setting or reload the external encryption library.
- ERR_REFUSED
- (5): Request was refused. Possible causes include: IRtcEngine failed to initialize; the channel name is empty when joining a channel; the channel name is already in use when calling joinChannelEx to join multiple channels.
- ERR_BUFFER_TOO_SMALL
- (6): Buffer size is insufficient to store the returned data.
- ERR_NOT_INITIALIZED
- (7): Method called before IRtcEngine initialization. Please ensure the IRtcEngine object is initialized before calling this method.
- ERR_INVALID_STATE
- (8): Invalid state.
- ERR_NO_PERMISSION
- (9): No access permission. Please check whether the app has obtained audio/video device permissions.
- ERR_TIMEDOUT
- (10): Request timed out. Some API calls require the SDK to return the execution result. If no result is returned within 10 seconds, this error is triggered.
- ERR_CANCELED
- (11): Request was canceled. This error is for internal use only and is not returned to the app via any method or callback.
- ERR_TOO_OFTEN
- (12): Method called too frequently. This error is for internal use only and is not returned to the app via any method or callback.
- ERR_BIND_SOCKET
- (13): SDK failed to bind network socket. This error is for internal use only and is not returned to the app via any method or callback.
- ERR_NET_DOWN
- (14): Network is unavailable. This error is for internal use only and is not returned to the app via any method or callback.
- ERR_JOIN_CHANNEL_REJECTED
- (17): Join channel request was rejected. Possible causes include: the user is already in a channel; startEchoTest was called but stopEchoTest was not called before attempting to join a channel.
- ERR_LEAVE_CHANNEL_REJECTED
- (18): Failed to leave the channel. Possible causes include: the user already left the channel before calling
leaveChannel;leaveChannelwas called before joining a channel. - ERR_ALREADY_IN_USE
- (19): Resource is already in use.
- ERR_ABORTED
- (20): Request was aborted by the SDK, possibly due to sending requests too frequently.
- ERR_INIT_NET_ENGINE
- (21): IRtcEngine initialization failed and crashed, possibly due to specific Windows firewall settings.
- ERR_RESOURCE_LIMITED
- (22): SDK failed to allocate resources, possibly due to excessive use of system resources by the app or insufficient system resources.
- ERR_INVALID_CHANNEL_NAME
- (102): The specified channel name is invalid. Possible cause: incorrect parameter type. Please use a valid channel name to rejoin the channel.
- ERR_NO_SERVER_RESOURCES
- (103): Unable to obtain server resources in the specified region. Please try using another region when initializing IRtcEngine.
- ERR_TOKEN_EXPIRED
- (109): The current Token has expired. Please request a new Token from the server and call the renewToken method.
- ERR_INVALID_TOKEN
- (110): Invalid Token. Common causes include:
- The App certificate is enabled in the Agora Console, but the code still uses the App ID for authentication. When the App certificate is enabled, the project must use Token authentication.
- The
uidused to generate the Token is inconsistent with theuidused to join the channel.
- ERR_CONNECTION_INTERRUPTED
- (111): Network connection interrupted. After the connection is established, if the client instance is disconnected from the server for more than 4 seconds, the SDK triggers this callback.
- ERR_CONNECTION_LOST
- (112): Network connection lost. After the connection is interrupted, if the client instance fails to reconnect to the Agora edge server within 10 seconds, this error is triggered.
- ERR_NOT_IN_CHANNEL
- (113): The user is not in a channel when calling the sendStreamMessage method.
- ERR_SIZE_TOO_LARGE
- (114): The data size exceeds 1 KB when calling the sendStreamMessage method.
- ERR_BITRATE_LIMIT
- (115): The data bitrate exceeds 6 KB/s when calling the sendStreamMessage method.
- ERR_TOO_MANY_DATA_STREAMS
- (116): More than five data streams were created when calling the
createDataStream(int* streamId, const DataStreamConfig& config)method. - ERR_STREAM_MESSAGE_TIMEOUT
- (117): Data stream transmission timed out.
- ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED
- (119): Failed to switch roles. Please try rejoining the channel.
- ERR_DECRYPTION_FAILED
- (120): Failed to decrypt media stream. The user may have joined the channel using an incorrect password. Please check the input password or advise the user to rejoin the channel.
- ERR_INVALID_USER_ID
- (121): Invalid user ID.
- ERR_DATASTREAM_DECRYPTION_FAILED
- (122): Failed to decrypt data stream. The user may have joined the channel using an incorrect password. Please check the input password or advise the user to rejoin the channel.
- ERR_CLIENT_IS_BANNED_BY_SERVER
- (123): The user is banned by the server.
- ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH
- (130): SDK does not support pushing encrypted streams to CDN.
- ERR_LOAD_MEDIA_ENGINE
- (1001): Failed to load media engine.
- ERR_ADM_GENERAL_ERROR
- (1005): General error occurred (no specific reason). Please check if the audio device is occupied by another app or try rejoining the channel.
- ERR_ADM_INIT_PLAYOUT
- (1008): Error occurred while initializing playback device. Please check if the playback device is occupied by another app or try rejoining the channel.
- ERR_ADM_START_PLAYOUT
- (1009): Error occurred while starting playback device. Please check the playback device.
- ERR_ADM_STOP_PLAYOUT
- (1010): Error occurred while stopping playback device.
- ERR_ADM_INIT_RECORDING
- (1011): Error occurred while initializing recording device. Please check the recording device or try rejoining the channel.
- ERR_ADM_START_RECORDING
- (1012): Error occurred while starting recording device. Please check the recording device.
- ERR_ADM_STOP_RECORDING
- (1013): Error occurred while stopping recording device.
- ERR_VDM_CAMERA_NOT_AUTHORIZED
- (1501): Camera access permission not granted. Please check if camera permission has been granted.
- ERR_PCMSEND_FORMAT
- (200): Unsupported PCM format.
- ERR_PCMSEND_BUFFEROVERFLOW
- (201): Buffer overflow due to excessive PCM send rate.