Documentation

JoinRequest extends Message
in package

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

Table of Contents

Properties

$client_info  : mixed
Generated from protobuf field <code>.livekit.ClientInfo client_info = 1;</code>
$connection_settings  : mixed
Generated from protobuf field <code>.livekit.ConnectionSettings connection_settings = 2;</code>
$metadata  : mixed
if not empty, will overwrite `metadata` in token
$participant_sid  : mixed
Generated from protobuf field <code>string participant_sid = 9;</code>
$publisher_offer  : mixed
Generated from protobuf field <code>.livekit.SessionDescription publisher_offer = 6;</code>
$reconnect  : mixed
Generated from protobuf field <code>bool reconnect = 7;</code>
$reconnect_reason  : mixed
Generated from protobuf field <code>.livekit.ReconnectReason reconnect_reason = 8;</code>
$sync_state  : mixed
Generated from protobuf field <code>.livekit.SyncState sync_state = 10;</code>
$add_track_requests  : mixed
Generated from protobuf field <code>repeated .livekit.AddTrackRequest add_track_requests = 5;</code>
$participant_attributes  : mixed
will set keys provided via this will overwrite if the same key is in the token will not delete keys from token if there is a key collision and this sets that key to empty value

Methods

__construct()  : mixed
Constructor.
clearClientInfo()  : mixed
clearConnectionSettings()  : mixed
clearPublisherOffer()  : mixed
clearSyncState()  : mixed
getAddTrackRequests()  : RepeatedField<string|int, AddTrackRequest>
Generated from protobuf field <code>repeated .livekit.AddTrackRequest add_track_requests = 5;</code>
getClientInfo()  : ClientInfo|null
Generated from protobuf field <code>.livekit.ClientInfo client_info = 1;</code>
getConnectionSettings()  : ConnectionSettings|null
Generated from protobuf field <code>.livekit.ConnectionSettings connection_settings = 2;</code>
getMetadata()  : string
if not empty, will overwrite `metadata` in token
getParticipantAttributes()  : MapField
will set keys provided via this will overwrite if the same key is in the token will not delete keys from token if there is a key collision and this sets that key to empty value
getParticipantSid()  : string
Generated from protobuf field <code>string participant_sid = 9;</code>
getPublisherOffer()  : SessionDescription|null
Generated from protobuf field <code>.livekit.SessionDescription publisher_offer = 6;</code>
getReconnect()  : bool
Generated from protobuf field <code>bool reconnect = 7;</code>
getReconnectReason()  : int
Generated from protobuf field <code>.livekit.ReconnectReason reconnect_reason = 8;</code>
getSyncState()  : SyncState|null
Generated from protobuf field <code>.livekit.SyncState sync_state = 10;</code>
hasClientInfo()  : mixed
hasConnectionSettings()  : mixed
hasPublisherOffer()  : mixed
hasSyncState()  : mixed
setAddTrackRequests()  : $this
Generated from protobuf field <code>repeated .livekit.AddTrackRequest add_track_requests = 5;</code>
setClientInfo()  : $this
Generated from protobuf field <code>.livekit.ClientInfo client_info = 1;</code>
setConnectionSettings()  : $this
Generated from protobuf field <code>.livekit.ConnectionSettings connection_settings = 2;</code>
setMetadata()  : $this
if not empty, will overwrite `metadata` in token
setParticipantAttributes()  : $this
will set keys provided via this will overwrite if the same key is in the token will not delete keys from token if there is a key collision and this sets that key to empty value
setParticipantSid()  : $this
Generated from protobuf field <code>string participant_sid = 9;</code>
setPublisherOffer()  : $this
Generated from protobuf field <code>.livekit.SessionDescription publisher_offer = 6;</code>
setReconnect()  : $this
Generated from protobuf field <code>bool reconnect = 7;</code>
setReconnectReason()  : $this
Generated from protobuf field <code>.livekit.ReconnectReason reconnect_reason = 8;</code>
setSyncState()  : $this
Generated from protobuf field <code>.livekit.SyncState sync_state = 10;</code>

Properties

$client_info

Generated from protobuf field <code>.livekit.ClientInfo client_info = 1;</code>

protected mixed $client_info = null

$connection_settings

Generated from protobuf field <code>.livekit.ConnectionSettings connection_settings = 2;</code>

protected mixed $connection_settings = null

$metadata

if not empty, will overwrite `metadata` in token

protected mixed $metadata = ''

Generated from protobuf field string metadata = 3 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

$participant_sid

Generated from protobuf field <code>string participant_sid = 9;</code>

protected mixed $participant_sid = ''

$publisher_offer

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

protected mixed $publisher_offer = null

$reconnect

Generated from protobuf field <code>bool reconnect = 7;</code>

protected mixed $reconnect = false

$reconnect_reason

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

protected mixed $reconnect_reason = 0

$sync_state

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

protected mixed $sync_state = null

$add_track_requests

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

private mixed $add_track_requests

$participant_attributes

will set keys provided via this will overwrite if the same key is in the token will not delete keys from token if there is a key collision and this sets that key to empty value

private mixed $participant_attributes

Generated from protobuf field map<string, string> participant_attributes = 4 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

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 \Livekit\ClientInfo $client_info
@type \Livekit\ConnectionSettings $connection_settings
@type string $metadata
      if not empty, will overwrite `metadata` in token
@type array|\Google\Protobuf\Internal\MapField $participant_attributes
      will set keys provided via this
      will overwrite if the same key is in the token
      will not delete keys from token if there is a key collision and this sets that key to empty value
@type \Livekit\AddTrackRequest[] $add_track_requests
@type \Livekit\SessionDescription $publisher_offer
@type bool $reconnect
@type int $reconnect_reason
@type string $participant_sid
@type \Livekit\SyncState $sync_state

}

clearConnectionSettings()

public clearConnectionSettings() : mixed

clearPublisherOffer()

public clearPublisherOffer() : mixed

getAddTrackRequests()

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

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

getClientInfo()

Generated from protobuf field <code>.livekit.ClientInfo client_info = 1;</code>

public getClientInfo() : ClientInfo|null
Return values
ClientInfo|null

getMetadata()

if not empty, will overwrite `metadata` in token

public getMetadata() : string

Generated from protobuf field string metadata = 3 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Return values
string

getParticipantAttributes()

will set keys provided via this will overwrite if the same key is in the token will not delete keys from token if there is a key collision and this sets that key to empty value

public getParticipantAttributes() : MapField

Generated from protobuf field map<string, string> participant_attributes = 4 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Return values
MapField

getParticipantSid()

Generated from protobuf field <code>string participant_sid = 9;</code>

public getParticipantSid() : string
Return values
string

getReconnect()

Generated from protobuf field <code>bool reconnect = 7;</code>

public getReconnect() : bool
Return values
bool

getReconnectReason()

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

public getReconnectReason() : int
Return values
int

getSyncState()

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

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

hasConnectionSettings()

public hasConnectionSettings() : mixed

hasPublisherOffer()

public hasPublisherOffer() : mixed

setAddTrackRequests()

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

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

setClientInfo()

Generated from protobuf field <code>.livekit.ClientInfo client_info = 1;</code>

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

setConnectionSettings()

Generated from protobuf field <code>.livekit.ConnectionSettings connection_settings = 2;</code>

public setConnectionSettings(ConnectionSettings $var) : $this
Parameters
$var : ConnectionSettings
Return values
$this

setMetadata()

if not empty, will overwrite `metadata` in token

public setMetadata(string $var) : $this

Generated from protobuf field string metadata = 3 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Parameters
$var : string
Return values
$this

setParticipantAttributes()

will set keys provided via this will overwrite if the same key is in the token will not delete keys from token if there is a key collision and this sets that key to empty value

public setParticipantAttributes(array<string|int, mixed>|MapField $var) : $this

Generated from protobuf field map<string, string> participant_attributes = 4 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Parameters
$var : array<string|int, mixed>|MapField
Return values
$this

setParticipantSid()

Generated from protobuf field <code>string participant_sid = 9;</code>

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

setReconnect()

Generated from protobuf field <code>bool reconnect = 7;</code>

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

setReconnectReason()

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

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

setSyncState()

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

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results