Documentation

DisconnectReason
in package

Protobuf type <code>livekit.DisconnectReason</code>

Table of Contents

Constants

CLIENT_INITIATED  = 1
the client initiated the disconnect
CONNECTION_TIMEOUT  = 14
server timed out a participant session
DUPLICATE_IDENTITY  = 2
another participant with the same identity has joined the room
JOIN_FAILURE  = 7
client was unable to connect fully
MEDIA_FAILURE  = 15
media stream failure or media timeout
MIGRATION  = 8
Cloud-only, the server requested Participant to migrate the connection elsewhere
PARTICIPANT_REMOVED  = 4
RoomService.RemoveParticipant was called
ROOM_CLOSED  = 10
the room was closed, due to all Standard and Ingress participants having left
ROOM_DELETED  = 5
RoomService.DeleteRoom was called
SERVER_SHUTDOWN  = 3
the server instance is shutting down
SIGNAL_CLOSE  = 9
the signal websocket was closed unexpectedly
SIP_TRUNK_FAILURE  = 13
SIP protocol failure or unexpected response
STATE_MISMATCH  = 6
the client is attempting to resume a session, but server is not aware of it
UNKNOWN_REASON  = 0
Generated from protobuf enum <code>UNKNOWN_REASON = 0;</code>
USER_REJECTED  = 12
SIP callee rejected the call (busy)
USER_UNAVAILABLE  = 11
SIP callee did not respond in time

Properties

$valueToName  : mixed

Methods

name()  : mixed
value()  : mixed

Constants

CLIENT_INITIATED

the client initiated the disconnect

public mixed CLIENT_INITIATED = 1

Generated from protobuf enum CLIENT_INITIATED = 1;

CONNECTION_TIMEOUT

server timed out a participant session

public mixed CONNECTION_TIMEOUT = 14

Generated from protobuf enum CONNECTION_TIMEOUT = 14;

DUPLICATE_IDENTITY

another participant with the same identity has joined the room

public mixed DUPLICATE_IDENTITY = 2

Generated from protobuf enum DUPLICATE_IDENTITY = 2;

JOIN_FAILURE

client was unable to connect fully

public mixed JOIN_FAILURE = 7

Generated from protobuf enum JOIN_FAILURE = 7;

MEDIA_FAILURE

media stream failure or media timeout

public mixed MEDIA_FAILURE = 15

Generated from protobuf enum MEDIA_FAILURE = 15;

MIGRATION

Cloud-only, the server requested Participant to migrate the connection elsewhere

public mixed MIGRATION = 8

Generated from protobuf enum MIGRATION = 8;

PARTICIPANT_REMOVED

RoomService.RemoveParticipant was called

public mixed PARTICIPANT_REMOVED = 4

Generated from protobuf enum PARTICIPANT_REMOVED = 4;

ROOM_CLOSED

the room was closed, due to all Standard and Ingress participants having left

public mixed ROOM_CLOSED = 10

Generated from protobuf enum ROOM_CLOSED = 10;

ROOM_DELETED

RoomService.DeleteRoom was called

public mixed ROOM_DELETED = 5

Generated from protobuf enum ROOM_DELETED = 5;

SERVER_SHUTDOWN

the server instance is shutting down

public mixed SERVER_SHUTDOWN = 3

Generated from protobuf enum SERVER_SHUTDOWN = 3;

SIGNAL_CLOSE

the signal websocket was closed unexpectedly

public mixed SIGNAL_CLOSE = 9

Generated from protobuf enum SIGNAL_CLOSE = 9;

SIP_TRUNK_FAILURE

SIP protocol failure or unexpected response

public mixed SIP_TRUNK_FAILURE = 13

Generated from protobuf enum SIP_TRUNK_FAILURE = 13;

STATE_MISMATCH

the client is attempting to resume a session, but server is not aware of it

public mixed STATE_MISMATCH = 6

Generated from protobuf enum STATE_MISMATCH = 6;

UNKNOWN_REASON

Generated from protobuf enum <code>UNKNOWN_REASON = 0;</code>

public mixed UNKNOWN_REASON = 0

USER_REJECTED

SIP callee rejected the call (busy)

public mixed USER_REJECTED = 12

Generated from protobuf enum USER_REJECTED = 12;

USER_UNAVAILABLE

SIP callee did not respond in time

public mixed USER_UNAVAILABLE = 11

Generated from protobuf enum USER_UNAVAILABLE = 11;

Properties

$valueToName

private static mixed $valueToName = [self::UNKNOWN_REASON => 'UNKNOWN_REASON', self::CLIENT_INITIATED => 'CLIENT_INITIATED', self::DUPLICATE_IDENTITY => 'DUPLICATE_IDENTITY', self::SERVER_SHUTDOWN => 'SERVER_SHUTDOWN', self::PARTICIPANT_REMOVED => 'PARTICIPANT_REMOVED', self::ROOM_DELETED => 'ROOM_DELETED', self::STATE_MISMATCH => 'STATE_MISMATCH', self::JOIN_FAILURE => 'JOIN_FAILURE', self::MIGRATION => 'MIGRATION', self::SIGNAL_CLOSE => 'SIGNAL_CLOSE', self::ROOM_CLOSED => 'ROOM_CLOSED', self::USER_UNAVAILABLE => 'USER_UNAVAILABLE', self::USER_REJECTED => 'USER_REJECTED', self::SIP_TRUNK_FAILURE => 'SIP_TRUNK_FAILURE', self::CONNECTION_TIMEOUT => 'CONNECTION_TIMEOUT', self::MEDIA_FAILURE => 'MEDIA_FAILURE']

Methods

name()

public static name(mixed $value) : mixed
Parameters
$value : mixed

value()

public static value(mixed $name) : mixed
Parameters
$name : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results