Documentation

LeaveRequest extends Message
in package

Generated from protobuf message <code>livekit.LeaveRequest</code>

Table of Contents

Properties

$action  : mixed
Generated from protobuf field <code>.livekit.LeaveRequest.Action action = 3;</code>
$can_reconnect  : mixed
sent when server initiates the disconnect due to server-restart indicates clients should attempt full-reconnect sequence NOTE: `can_reconnect` obsoleted by `action` starting in protocol version 13
$reason  : mixed
Generated from protobuf field <code>.livekit.DisconnectReason reason = 2;</code>
$regions  : mixed
Generated from protobuf field <code>.livekit.RegionSettings regions = 4;</code>

Methods

__construct()  : mixed
Constructor.
clearRegions()  : mixed
getAction()  : int
Generated from protobuf field <code>.livekit.LeaveRequest.Action action = 3;</code>
getCanReconnect()  : bool
sent when server initiates the disconnect due to server-restart indicates clients should attempt full-reconnect sequence NOTE: `can_reconnect` obsoleted by `action` starting in protocol version 13
getReason()  : int
Generated from protobuf field <code>.livekit.DisconnectReason reason = 2;</code>
getRegions()  : RegionSettings|null
Generated from protobuf field <code>.livekit.RegionSettings regions = 4;</code>
hasRegions()  : mixed
setAction()  : $this
Generated from protobuf field <code>.livekit.LeaveRequest.Action action = 3;</code>
setCanReconnect()  : $this
sent when server initiates the disconnect due to server-restart indicates clients should attempt full-reconnect sequence NOTE: `can_reconnect` obsoleted by `action` starting in protocol version 13
setReason()  : $this
Generated from protobuf field <code>.livekit.DisconnectReason reason = 2;</code>
setRegions()  : $this
Generated from protobuf field <code>.livekit.RegionSettings regions = 4;</code>

Properties

$action

Generated from protobuf field <code>.livekit.LeaveRequest.Action action = 3;</code>

protected mixed $action = 0

$can_reconnect

sent when server initiates the disconnect due to server-restart indicates clients should attempt full-reconnect sequence NOTE: `can_reconnect` obsoleted by `action` starting in protocol version 13

protected mixed $can_reconnect = false

Generated from protobuf field bool can_reconnect = 1;

$reason

Generated from protobuf field <code>.livekit.DisconnectReason reason = 2;</code>

protected mixed $reason = 0

$regions

Generated from protobuf field <code>.livekit.RegionSettings regions = 4;</code>

protected mixed $regions = null

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

{ Optional. Data for populating the Message object.

@type bool $can_reconnect
      sent when server initiates the disconnect due to server-restart
      indicates clients should attempt full-reconnect sequence
      NOTE: `can_reconnect` obsoleted by `action` starting in protocol version 13
@type int $reason
@type int $action
@type \Livekit\RegionSettings $regions

}

getAction()

Generated from protobuf field <code>.livekit.LeaveRequest.Action action = 3;</code>

public getAction() : int
Return values
int

getCanReconnect()

sent when server initiates the disconnect due to server-restart indicates clients should attempt full-reconnect sequence NOTE: `can_reconnect` obsoleted by `action` starting in protocol version 13

public getCanReconnect() : bool

Generated from protobuf field bool can_reconnect = 1;

Return values
bool

getReason()

Generated from protobuf field <code>.livekit.DisconnectReason reason = 2;</code>

public getReason() : int
Return values
int

setAction()

Generated from protobuf field <code>.livekit.LeaveRequest.Action action = 3;</code>

public setAction(int $var) : $this
Parameters
$var : int
Return values
$this

setCanReconnect()

sent when server initiates the disconnect due to server-restart indicates clients should attempt full-reconnect sequence NOTE: `can_reconnect` obsoleted by `action` starting in protocol version 13

public setCanReconnect(bool $var) : $this

Generated from protobuf field bool can_reconnect = 1;

Parameters
$var : bool
Return values
$this

setReason()

Generated from protobuf field <code>.livekit.DisconnectReason reason = 2;</code>

public setReason(int $var) : $this
Parameters
$var : int
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results