DisconnectReason enum
The reason a participant was disconnected from the room.
Most values mirror the server's disconnect reasons from the LiveKit protocol. disconnected, signalingConnectionFailure and reconnectAttemptsExceeded are produced by this SDK for client side conditions and are never sent by the server.
Values
- unknown → const DisconnectReason
- clientInitiated → const DisconnectReason
-
The client initiated the disconnect.
- duplicateIdentity → const DisconnectReason
-
Another participant with the same identity has joined the room.
- serverShutdown → const DisconnectReason
-
The server instance is shutting down.
- participantRemoved → const DisconnectReason
-
RoomService.RemoveParticipant was called.
- roomDeleted → const DisconnectReason
-
RoomService.DeleteRoom was called.
- stateMismatch → const DisconnectReason
-
The client attempted to resume a session, but the server is not aware of it.
- joinFailure → const DisconnectReason
-
The client was unable to connect fully.
- disconnected → const DisconnectReason
-
The signaling connection was closed. Client side, not sent by the server.
- signalingConnectionFailure → const DisconnectReason
-
The signaling connection could not be established. Client side, not sent by the server.
- reconnectAttemptsExceeded → const DisconnectReason
-
The client gave up reconnecting after exhausting all attempts. Client side, not sent by the server.
- migration → const DisconnectReason
-
Cloud only. The server requested the participant to migrate the connection elsewhere.
- signalClose → const DisconnectReason
-
The signal websocket was closed unexpectedly.
- roomClosed → const DisconnectReason
-
The room was closed, due to all Standard and Ingress participants having left. Distinct from roomDeleted, which is an explicit RoomService.DeleteRoom call.
-
SIP callee did not respond in time.
- userRejected → const DisconnectReason
-
SIP callee rejected the call (busy).
- sipTrunkFailure → const DisconnectReason
-
SIP protocol failure or unexpected response.
- connectionTimeout → const DisconnectReason
-
The server timed out the participant session.
- mediaFailure → const DisconnectReason
-
Media stream failure or media timeout.
- agentError → const DisconnectReason
-
The agent encountered an error.
Properties
- 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<
DisconnectReason> - A constant List of the values in this enum, in order of their declaration.