ErrorCode enum

{zh} * @detail errorcode @brief 回调错误码。
SDK 内部遇到不可恢复的错误时,会通过 onError 回调通知用户。

Inheritance
Available extensions

Values

invalidToken → const ErrorCode

@brief Token is invalid. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.
The token used when entering the room is invalid or expired. The user is required to retrieve the token and call the updateToken method to update the token.

joinRoom → const ErrorCode

@brief Join room error. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.
An unknown error occurred while entering the room, which caused the joining room to fail. Users are required to rejoin the room.

noPublishPermission → const ErrorCode

@brief No permission to publish audio & video streams. Returned by onVideoPublishStateChanged{@link #IRTCRoomEventHandler#onVideoPublishStateChanged}, onAudioPublishStateChanged{@link #IRTCRoomEventHandler#onAudioPublishStateChanged}.
The user failed to publish the audio & video stream in the room. The reason for the failure is that the user does not have permission to publish the stream.

noSubscribePermission → const ErrorCode

@brief No subscription permissions for audio & video streams. Returned by onVideoSubscribeStateChanged{@link #IRTCRoomEventHandler#onVideoSubscribeStateChanged}, onAudioSubscribeStateChanged{@link #IRTCRoomEventHandler#onAudioSubscribeStateChanged}.
The user failed to subscribe to the audio & video stream in the room where the user is located. The reason for the failure is that the user does not have permission to subscribe to the stream.

duplicateLogin → const ErrorCode

@brief The user has been removed from the room because the same user joined the room on the other client. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.

appIdNull → const ErrorCode

@platform android @brief The App ID parameter is abnormal.
The App ID parameter passed in when the engine was created is empty.

kickedOut → const ErrorCode

@brief The user has been remove from the room by the administrator via a OpenAPI call. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.

roomIdIllegal → const ErrorCode

@brief When calling createRoom, if the roomId is illegal, it will return null and throw the error. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.

tokenExpired → const ErrorCode

@brief Token expired. Call joinRoom to rejoin with a valid Token. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.

updateTokenWithInvalidToken → const ErrorCode

@brief The Token you provided when calling updateToken is invalid. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.

roomDismiss → const ErrorCode

@brief Users have been removed from the room because the administrator dismissed the room by calling OpenAPI. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.

joinRoomWithoutLicenseAuthenticateSDK → const ErrorCode

@hidden internal use only @brief Join room error. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.
The LICENSE billing account does not use the LICENSE_AUTHENTICATE SDK while calling joinRoom, which caused the joining room to fail.

roomAlreadyExist → const ErrorCode

@brief A room with the same roomId already exists during the call echo test. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.

userIdDifferent → const ErrorCode

@brief The local user joins multiple rooms with different uid. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.
In the same engine instance, users need to use the same uid to join different rooms.

joinRoomServerLicenseExpired → const ErrorCode

@hidden internal use only @brief Server license expired, refused to enter the room. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.

joinRoomExceedsTheUpperLimit → const ErrorCode

@hidden internal use only @brief Exceeds the upper limit of the concurrency allowed by the server license, and refuses to enter the room. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.

joinRoomLicenseParameterError → const ErrorCode

@hidden internal use only @brief The license parameter is wrong and refuses to enter the room. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.

joinRoomLicenseFilePathError → const ErrorCode

@hidden internal use only @brief wrong license certificate path. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.

joinRoomLicenseIllegal → const ErrorCode

@hidden internal use only @brief The license certificate is illegal, refuse to enter the room. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.

joinRoomLicenseExpired → const ErrorCode

@hidden internal use only @brief License certificate has expired, refused to enter the room. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.

joinRoomLicenseInformationNotMatch → const ErrorCode

@hidden internal use only @brief The content of the license certificate does not match. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.

joinRoomLicenseNotMatchWithCache → const ErrorCode

@hidden internal use only @brief licenseThe current certificate does not match the cached certificate. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.

joinRoomRoomForbidden → const ErrorCode

@brief The room has banned before the user calls joinRoom. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.

joinRoomUserForbidden → const ErrorCode

@brief The user has banned before calling joinRoom. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.

joinRoomLicenseFunctionNotFound → const ErrorCode

@platform android @hidden internal use only @brief The license method did not load successfully. Check the corresponding extension. Returned by onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.

loadSOLib → const ErrorCode

@platform android @hidden for internal use only

overStreamPublishLimit → const ErrorCode

@brief Failed to publish video stream because the total number of published streams has exceeded the upper limit. Returned by onVideoPublishStateChanged{@link #IRTCRoomEventHandler#onVideoPublishStateChanged}, onAudioPublishStateChanged{@link #IRTCRoomEventHandler#onAudioPublishStateChanged}.
RTC will limit the total number of streams published in a single room, including video, audio, and screen streams. Local users will fail to publish streams to the room when the maximum number of published streams in the room has been reached, and will receive this error notification.

abnormalServerStatus → const ErrorCode

@brief The user has been removed from the room due to the abnormal status of server. This code will be received via onRoomStateChanged{@link #IRTCRoomEventHandler#onRoomStateChanged}.
SDK is disconnected with the signaling server. It will not reconnect automatically. Please contact technical support.

ERROR_CODE_MULTI_ROOM_UNPUBLISH_FAILED → const ErrorCode

@hidden for internal use only @brief In the scenario of one stream publish to multiple rooms, when at least two rooms are publishing the same stream, one of the rooms fails to unpublish. At this time, the business party needs to retry or notify the user to retry unpublish.

ERROR_CODE_WRONG_AREA_CODE → const ErrorCode

@hidden for internal use only @brief The area codes are wrong when specifying service area.

overStreamSubscribeLimit → const ErrorCode

@brief Failed to subscribe to streams because the total number of subscribed streams has exceeded the upper limit. Returned by onVideoSubscribeStateChanged{@link #IRTCRoomEventHandler#onVideoSubscribeStateChanged}, onAudioSubscribeStateChanged{@link #IRTCRoomEventHandler#onAudioSubscribeStateChanged}.
In order to ensure the performance and quality of audio & video calls in the game scenario, the server will limit the total number of audio & video streams subscribed by the user. When the total number of audio & video streams subscribed by the user has reached the maximum, continuing to subscribe to more streams will fail, and the user will receive this error notification.

overScreenPublishLimit → const ErrorCode

@platform android @deprecated since 3.52, use ERROR_CODE_OVER_STREAM_PUBLISH_LIMIT(-1080) instead @brief Publishing the screen stream failed, and the total number of publishing streams exceeded the upper limit. The
RTC will limit the total number of streams published in a single room, including video, audio, and screen streams.
Local users will fail to publish streams to the room when the maximum number of published streams in the room has been reached, and will receive this error notification.

invalidAudioSyncUidRepeated → const ErrorCode

@deprecated since 3.60, use INVALID_UID_REPEATED(0) carried by onAVSyncEvent{@link #IRTCRoomEventHandler#onAVSyncEvent} instead. @brief A/V synchronization failed.
Current source audio ID has been set by other video publishers in the same room.
One single audio source cannot be synchronized with multiple video sources at the same time.
Returned by onStreamStateChanged.

overVideoPublishLimit → const ErrorCode

@deprecated since 3.52, use ERROR_CODE_OVER_STREAM_PUBLISH_LIMIT(-1080) instead @brief The total number of published video streams exceeds the upper limit.
The RTC system limits the number of video streams posted in a single room. If the maximum number of video streams posted in the room has been reached, local users will fail to post video streams to the room again and will receive this error notification.

ByteRTCErrorCodeDeadLockNotify → const ErrorCode

@platform ios @hidden for internal use only @brief notify deadlock

Properties

$value → dynamic
final
hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
name String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

values → const List<ErrorCode>
A constant List of the values in this enum, in order of their declaration.