Documentation

StartSession extends Message
in package

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

Table of Contents

Properties

$adaptive_stream  : mixed
Generated from protobuf field <code>bool adaptive_stream = 15;</code>
$auto_subscribe  : mixed
Generated from protobuf field <code>bool auto_subscribe = 9;</code>
$client  : mixed
Generated from protobuf field <code>.livekit.ClientInfo client = 11;</code>
$connection_id  : mixed
Generated from protobuf field <code>string connection_id = 3;</code>
$create_room  : mixed
Generated from protobuf field <code>.livekit.CreateRoomRequest create_room = 20;</code>
$disable_ice_lite  : mixed
Generated from protobuf field <code>bool disable_ice_lite = 19;</code>
$grants_json  : mixed
A user's ClaimGrants serialized in JSON
$hidden  : mixed
Generated from protobuf field <code>bool hidden = 10 [deprecated = true];</code>
$identity  : mixed
Generated from protobuf field <code>string identity = 2;</code>
$name  : mixed
Generated from protobuf field <code>string name = 13;</code>
$participant_id  : mixed
if reconnect, client will set current sid
$publisher_offer  : mixed
Generated from protobuf field <code>.livekit.SessionDescription publisher_offer = 22;</code>
$reconnect  : mixed
if a client is reconnecting (i.e. resume instead of restart)
$reconnect_reason  : mixed
Generated from protobuf field <code>.livekit.ReconnectReason reconnect_reason = 17;</code>
$recorder  : mixed
Generated from protobuf field <code>bool recorder = 12 [deprecated = true];</code>
$room_name  : mixed
Generated from protobuf field <code>string room_name = 1;</code>
$subscriber_allow_pause  : mixed
Generated from protobuf field <code>optional bool subscriber_allow_pause = 18;</code>
$sync_state  : mixed
Generated from protobuf field <code>.livekit.SyncState sync_state = 23;</code>
$use_single_peer_connection  : mixed
Generated from protobuf field <code>bool use_single_peer_connection = 24;</code>
$add_track_requests  : mixed
Generated from protobuf field <code>repeated .livekit.AddTrackRequest add_track_requests = 21;</code>

Methods

__construct()  : mixed
Constructor.
clearClient()  : mixed
clearCreateRoom()  : mixed
clearPublisherOffer()  : mixed
clearSubscriberAllowPause()  : mixed
clearSyncState()  : mixed
getAdaptiveStream()  : bool
Generated from protobuf field <code>bool adaptive_stream = 15;</code>
getAddTrackRequests()  : RepeatedField<string|int, AddTrackRequest>
Generated from protobuf field <code>repeated .livekit.AddTrackRequest add_track_requests = 21;</code>
getAutoSubscribe()  : bool
Generated from protobuf field <code>bool auto_subscribe = 9;</code>
getClient()  : ClientInfo|null
Generated from protobuf field <code>.livekit.ClientInfo client = 11;</code>
getConnectionId()  : string
Generated from protobuf field <code>string connection_id = 3;</code>
getCreateRoom()  : CreateRoomRequest|null
Generated from protobuf field <code>.livekit.CreateRoomRequest create_room = 20;</code>
getDisableIceLite()  : bool
Generated from protobuf field <code>bool disable_ice_lite = 19;</code>
getGrantsJson()  : string
A user's ClaimGrants serialized in JSON
getHidden()  : bool
Generated from protobuf field <code>bool hidden = 10 [deprecated = true];</code>
getIdentity()  : string
Generated from protobuf field <code>string identity = 2;</code>
getName()  : string
Generated from protobuf field <code>string name = 13;</code>
getParticipantId()  : string
if reconnect, client will set current sid
getPublisherOffer()  : SessionDescription|null
Generated from protobuf field <code>.livekit.SessionDescription publisher_offer = 22;</code>
getReconnect()  : bool
if a client is reconnecting (i.e. resume instead of restart)
getReconnectReason()  : int
Generated from protobuf field <code>.livekit.ReconnectReason reconnect_reason = 17;</code>
getRecorder()  : bool
Generated from protobuf field <code>bool recorder = 12 [deprecated = true];</code>
getRoomName()  : string
Generated from protobuf field <code>string room_name = 1;</code>
getSubscriberAllowPause()  : bool
Generated from protobuf field <code>optional bool subscriber_allow_pause = 18;</code>
getSyncState()  : SyncState|null
Generated from protobuf field <code>.livekit.SyncState sync_state = 23;</code>
getUseSinglePeerConnection()  : bool
Generated from protobuf field <code>bool use_single_peer_connection = 24;</code>
hasClient()  : mixed
hasCreateRoom()  : mixed
hasPublisherOffer()  : mixed
hasSubscriberAllowPause()  : mixed
hasSyncState()  : mixed
setAdaptiveStream()  : $this
Generated from protobuf field <code>bool adaptive_stream = 15;</code>
setAddTrackRequests()  : $this
Generated from protobuf field <code>repeated .livekit.AddTrackRequest add_track_requests = 21;</code>
setAutoSubscribe()  : $this
Generated from protobuf field <code>bool auto_subscribe = 9;</code>
setClient()  : $this
Generated from protobuf field <code>.livekit.ClientInfo client = 11;</code>
setConnectionId()  : $this
Generated from protobuf field <code>string connection_id = 3;</code>
setCreateRoom()  : $this
Generated from protobuf field <code>.livekit.CreateRoomRequest create_room = 20;</code>
setDisableIceLite()  : $this
Generated from protobuf field <code>bool disable_ice_lite = 19;</code>
setGrantsJson()  : $this
A user's ClaimGrants serialized in JSON
setHidden()  : $this
Generated from protobuf field <code>bool hidden = 10 [deprecated = true];</code>
setIdentity()  : $this
Generated from protobuf field <code>string identity = 2;</code>
setName()  : $this
Generated from protobuf field <code>string name = 13;</code>
setParticipantId()  : $this
if reconnect, client will set current sid
setPublisherOffer()  : $this
Generated from protobuf field <code>.livekit.SessionDescription publisher_offer = 22;</code>
setReconnect()  : $this
if a client is reconnecting (i.e. resume instead of restart)
setReconnectReason()  : $this
Generated from protobuf field <code>.livekit.ReconnectReason reconnect_reason = 17;</code>
setRecorder()  : $this
Generated from protobuf field <code>bool recorder = 12 [deprecated = true];</code>
setRoomName()  : $this
Generated from protobuf field <code>string room_name = 1;</code>
setSubscriberAllowPause()  : $this
Generated from protobuf field <code>optional bool subscriber_allow_pause = 18;</code>
setSyncState()  : $this
Generated from protobuf field <code>.livekit.SyncState sync_state = 23;</code>
setUseSinglePeerConnection()  : $this
Generated from protobuf field <code>bool use_single_peer_connection = 24;</code>

Properties

$adaptive_stream

Generated from protobuf field <code>bool adaptive_stream = 15;</code>

protected mixed $adaptive_stream = false

$auto_subscribe

Generated from protobuf field <code>bool auto_subscribe = 9;</code>

protected mixed $auto_subscribe = false

$client

Generated from protobuf field <code>.livekit.ClientInfo client = 11;</code>

protected mixed $client = null

$connection_id

Generated from protobuf field <code>string connection_id = 3;</code>

protected mixed $connection_id = ''

$create_room

Generated from protobuf field <code>.livekit.CreateRoomRequest create_room = 20;</code>

protected mixed $create_room = null

$disable_ice_lite

Generated from protobuf field <code>bool disable_ice_lite = 19;</code>

protected mixed $disable_ice_lite = false

$grants_json

A user's ClaimGrants serialized in JSON

protected mixed $grants_json = ''

Generated from protobuf field string grants_json = 14;

$hidden

Generated from protobuf field <code>bool hidden = 10 [deprecated = true];</code>

protected mixed $hidden = false

$identity

Generated from protobuf field <code>string identity = 2;</code>

protected mixed $identity = ''

$name

Generated from protobuf field <code>string name = 13;</code>

protected mixed $name = ''

$participant_id

if reconnect, client will set current sid

protected mixed $participant_id = ''

Generated from protobuf field string participant_id = 16;

$publisher_offer

Generated from protobuf field <code>.livekit.SessionDescription publisher_offer = 22;</code>

protected mixed $publisher_offer = null

$reconnect

if a client is reconnecting (i.e. resume instead of restart)

protected mixed $reconnect = false

Generated from protobuf field bool reconnect = 4;

$reconnect_reason

Generated from protobuf field <code>.livekit.ReconnectReason reconnect_reason = 17;</code>

protected mixed $reconnect_reason = 0

$recorder

Generated from protobuf field <code>bool recorder = 12 [deprecated = true];</code>

protected mixed $recorder = false

$room_name

Generated from protobuf field <code>string room_name = 1;</code>

protected mixed $room_name = ''

$subscriber_allow_pause

Generated from protobuf field <code>optional bool subscriber_allow_pause = 18;</code>

protected mixed $subscriber_allow_pause = null

$sync_state

Generated from protobuf field <code>.livekit.SyncState sync_state = 23;</code>

protected mixed $sync_state = null

$use_single_peer_connection

Generated from protobuf field <code>bool use_single_peer_connection = 24;</code>

protected mixed $use_single_peer_connection = false

$add_track_requests

Generated from protobuf field <code>repeated .livekit.AddTrackRequest add_track_requests = 21;</code>

private mixed $add_track_requests

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 string $room_name
@type string $identity
@type string $connection_id
@type bool $reconnect
      if a client is reconnecting (i.e. resume instead of restart)
@type bool $auto_subscribe
@type bool $hidden
@type \Livekit\ClientInfo $client
@type bool $recorder
@type string $name
@type string $grants_json
      A user's ClaimGrants serialized in JSON
@type bool $adaptive_stream
@type string $participant_id
     if reconnect, client will set current sid
@type int $reconnect_reason
@type bool $subscriber_allow_pause
@type bool $disable_ice_lite
@type \Livekit\CreateRoomRequest $create_room
@type \Livekit\AddTrackRequest[] $add_track_requests
@type \Livekit\SessionDescription $publisher_offer
@type \Livekit\SyncState $sync_state
@type bool $use_single_peer_connection

}

clearPublisherOffer()

public clearPublisherOffer() : mixed

clearSubscriberAllowPause()

public clearSubscriberAllowPause() : mixed

getAdaptiveStream()

Generated from protobuf field <code>bool adaptive_stream = 15;</code>

public getAdaptiveStream() : bool
Return values
bool

getAddTrackRequests()

Generated from protobuf field <code>repeated .livekit.AddTrackRequest add_track_requests = 21;</code>

public getAddTrackRequests() : RepeatedField<string|int, AddTrackRequest>
Return values
RepeatedField<string|int, AddTrackRequest>

getAutoSubscribe()

Generated from protobuf field <code>bool auto_subscribe = 9;</code>

public getAutoSubscribe() : bool
Return values
bool

getConnectionId()

Generated from protobuf field <code>string connection_id = 3;</code>

public getConnectionId() : string
Return values
string

getDisableIceLite()

Generated from protobuf field <code>bool disable_ice_lite = 19;</code>

public getDisableIceLite() : bool
Return values
bool

getGrantsJson()

A user's ClaimGrants serialized in JSON

public getGrantsJson() : string

Generated from protobuf field string grants_json = 14;

Return values
string

getHidden()

Generated from protobuf field <code>bool hidden = 10 [deprecated = true];</code>

public getHidden() : bool
Return values
bool

getIdentity()

Generated from protobuf field <code>string identity = 2;</code>

public getIdentity() : string
Return values
string

getName()

Generated from protobuf field <code>string name = 13;</code>

public getName() : string
Return values
string

getParticipantId()

if reconnect, client will set current sid

public getParticipantId() : string

Generated from protobuf field string participant_id = 16;

Return values
string

getReconnect()

if a client is reconnecting (i.e. resume instead of restart)

public getReconnect() : bool

Generated from protobuf field bool reconnect = 4;

Return values
bool

getReconnectReason()

Generated from protobuf field <code>.livekit.ReconnectReason reconnect_reason = 17;</code>

public getReconnectReason() : int
Return values
int

getRecorder()

Generated from protobuf field <code>bool recorder = 12 [deprecated = true];</code>

public getRecorder() : bool
Return values
bool

getRoomName()

Generated from protobuf field <code>string room_name = 1;</code>

public getRoomName() : string
Return values
string

getSubscriberAllowPause()

Generated from protobuf field <code>optional bool subscriber_allow_pause = 18;</code>

public getSubscriberAllowPause() : bool
Return values
bool

getSyncState()

Generated from protobuf field <code>.livekit.SyncState sync_state = 23;</code>

public getSyncState() : SyncState|null
Return values
SyncState|null

getUseSinglePeerConnection()

Generated from protobuf field <code>bool use_single_peer_connection = 24;</code>

public getUseSinglePeerConnection() : bool
Return values
bool

hasSubscriberAllowPause()

public hasSubscriberAllowPause() : mixed

setAdaptiveStream()

Generated from protobuf field <code>bool adaptive_stream = 15;</code>

public setAdaptiveStream(bool $var) : $this
Parameters
$var : bool
Return values
$this

setAddTrackRequests()

Generated from protobuf field <code>repeated .livekit.AddTrackRequest add_track_requests = 21;</code>

public setAddTrackRequests(array<string|int, AddTrackRequest> $var) : $this
Parameters
$var : array<string|int, AddTrackRequest>
Return values
$this

setAutoSubscribe()

Generated from protobuf field <code>bool auto_subscribe = 9;</code>

public setAutoSubscribe(bool $var) : $this
Parameters
$var : bool
Return values
$this

setClient()

Generated from protobuf field <code>.livekit.ClientInfo client = 11;</code>

public setClient(ClientInfo $var) : $this
Parameters
$var : ClientInfo
Return values
$this

setConnectionId()

Generated from protobuf field <code>string connection_id = 3;</code>

public setConnectionId(string $var) : $this
Parameters
$var : string
Return values
$this

setDisableIceLite()

Generated from protobuf field <code>bool disable_ice_lite = 19;</code>

public setDisableIceLite(bool $var) : $this
Parameters
$var : bool
Return values
$this

setGrantsJson()

A user's ClaimGrants serialized in JSON

public setGrantsJson(string $var) : $this

Generated from protobuf field string grants_json = 14;

Parameters
$var : string
Return values
$this

setHidden()

Generated from protobuf field <code>bool hidden = 10 [deprecated = true];</code>

public setHidden(bool $var) : $this
Parameters
$var : bool
Return values
$this

setIdentity()

Generated from protobuf field <code>string identity = 2;</code>

public setIdentity(string $var) : $this
Parameters
$var : string
Return values
$this

setName()

Generated from protobuf field <code>string name = 13;</code>

public setName(string $var) : $this
Parameters
$var : string
Return values
$this

setParticipantId()

if reconnect, client will set current sid

public setParticipantId(string $var) : $this

Generated from protobuf field string participant_id = 16;

Parameters
$var : string
Return values
$this

setReconnect()

if a client is reconnecting (i.e. resume instead of restart)

public setReconnect(bool $var) : $this

Generated from protobuf field bool reconnect = 4;

Parameters
$var : bool
Return values
$this

setReconnectReason()

Generated from protobuf field <code>.livekit.ReconnectReason reconnect_reason = 17;</code>

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

setRecorder()

Generated from protobuf field <code>bool recorder = 12 [deprecated = true];</code>

public setRecorder(bool $var) : $this
Parameters
$var : bool
Return values
$this

setRoomName()

Generated from protobuf field <code>string room_name = 1;</code>

public setRoomName(string $var) : $this
Parameters
$var : string
Return values
$this

setSubscriberAllowPause()

Generated from protobuf field <code>optional bool subscriber_allow_pause = 18;</code>

public setSubscriberAllowPause(bool $var) : $this
Parameters
$var : bool
Return values
$this

setSyncState()

Generated from protobuf field <code>.livekit.SyncState sync_state = 23;</code>

public setSyncState(SyncState $var) : $this
Parameters
$var : SyncState
Return values
$this

setUseSinglePeerConnection()

Generated from protobuf field <code>bool use_single_peer_connection = 24;</code>

public setUseSinglePeerConnection(bool $var) : $this
Parameters
$var : bool
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results