ByteRTCRoomStateChangeReason enum

Inheritance

• Object
• Enum
• ByteRTCRoomStateChangeReason

Available extensions

• EnumName

Values

ByteRTCRoomStateChangeReasonJoinRoom → const ByteRTCRoomStateChangeReason

@brief Join room success for the first time.

ByteRTCRoomStateChangeReasonReconnect → const ByteRTCRoomStateChangeReason

@brief Rejoin the room, such as the network is reconnected.

ByteRTCRoomStateChangeReasonLeaveRoom → const ByteRTCRoomStateChangeReason

@brief Leave room.

ByteRTCRoomStateChangeReasonJoinRoomFailed → const ByteRTCRoomStateChangeReason

@brief Failed to enter the room.
When entering the room for the first time or when the network is disconnected and reconnected due to poor network conditions, entering the room failed due to a server error. The SDK automatically retries the room.

ByteRTCRoomStateChangeReasonInvalidToken → const ByteRTCRoomStateChangeReason

@brief Token is invalid.
The Token used when calling joinRoom:userInfo:userVisibility:roomConfig:{@link #ByteRTCRoom#joinRoom:userInfo:userVisibility:roomConfig} is invalid or expired. The user is required to retrieve the token and call the updateToken:{@link #ByteRTCRTSRoom#updateToken} to update the token.

ByteRTCRoomStateChangeReasonTokenExpired → const ByteRTCRoomStateChangeReason

@brief Token expired. This error code is returned when the user's token expires in the room.
Call joinRoom:userInfo:userVisibility:roomConfig:{@link #ByteRTCRoom#joinRoom:userInfo:userVisibility:roomConfig} to rejoin the room with a new required Token.

ByteRTCRoomStateChangeReasonUpdateTokenWithInvalidToken → const ByteRTCRoomStateChangeReason

@brief The Token you provided when calling updateToken: is invalid.

ByteRTCRoomStateChangeReasonRoomForbidden → const ByteRTCRoomStateChangeReason

@brief The room has banned before the user calls joinRoom.

ByteRTCRoomStateChangeReasonUserForbidden → const ByteRTCRoomStateChangeReason

@brief The user has banned before calling joinRoom.

ByteRTCRoomStateChangeReasonKickedOut → const ByteRTCRoomStateChangeReason

@brief The user has been removed from the room by the administrator via a OpenAPI call.

ByteRTCRoomStateChangeReasonRoomDismiss → const ByteRTCRoomStateChangeReason

@brief Users have been removed from the room because the administrator dismissed the room by calling OpenAPI.

ByteRTCRoomStateChangeReasonDuplicateLogin → const ByteRTCRoomStateChangeReason

@brief The current user is removed from the room because another with the same user ID joins the room.

ByteRTCRoomStateChangeReasonWithoutLicenseAuthenticateSDK → const ByteRTCRoomStateChangeReason

@hidden internal use only @brief Join room error.
The LICENSE billing account does not use the LICENSE_AUTHENTICATE SDK while calling joinRoom:userInfo:roomConfig:, which caused the joining room to fail.

ByteRTCRoomStateChangeReasonServerLicenseExpired → const ByteRTCRoomStateChangeReason

@hidden internal use only @brief Server license expired, refused to enter the room.

ByteRTCRoomStateChangeReasonExceedsTheUpperLimit → const ByteRTCRoomStateChangeReason

@hidden internal use only @brief Exceeds the upper limit of the concurrency allowed by the server license, and refuses to enter the room.

ByteRTCRoomStateChangeReasonLicenseParameterError → const ByteRTCRoomStateChangeReason

@hidden internal use only @brief The license parameter is wrong and refuses to enter the room.

ByteRTCRoomStateChangeReasonLicenseFilePathError → const ByteRTCRoomStateChangeReason

@hidden internal use only @brief wrong license certificate path.

ByteRTCRoomStateChangeReasonLicenseIllegal → const ByteRTCRoomStateChangeReason

@hidden internal use only @brief The license certificate is illegal, refuse to enter the room.

ByteRTCRoomStateChangeReasonLicenseExpired → const ByteRTCRoomStateChangeReason

@hidden internal use only @brief License certificate has expired, refused to enter the room.

ByteRTCRoomStateChangeReasonLicenseInformationNotMatch → const ByteRTCRoomStateChangeReason

@hidden internal use only @brief The content of the license certificate does not match.

ByteRTCRoomStateChangeReasonLicenseNotMatchWithCache → const ByteRTCRoomStateChangeReason

@hidden internal use only @brief licenseThe current certificate does not match the cached certificate.

ByteRTCRoomStateChangeReasonLicenseFunctionNotFound → const ByteRTCRoomStateChangeReason

@hidden internal use only @brief The license method did not load successfully. Check the corresponding extension.

ByteRTCRoomStateChangeReasonStateAbnormalServerStatus → const ByteRTCRoomStateChangeReason

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

ByteRTCRoomStateChangeReasonUnknown → const ByteRTCRoomStateChangeReason

@brief Join room error.
An unknown error occurred when joining the room, which caused the room to fail to join. Users are required to rejoin the room.

Properties

$value → dynamic

final

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

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 setter, inherited

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<ByteRTCRoomStateChangeReason>

A constant List of the values in this enum, in order of their declaration.