Documentation

JoinResponse extends Message
in package

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

Table of Contents

Properties

$alternative_url  : mixed
when the current server isn't available, return alternate url to retry connection when this is set, the other fields will be largely empty
$client_configuration  : mixed
Generated from protobuf field <code>.livekit.ClientConfiguration client_configuration = 8;</code>
$fast_publish  : mixed
when set, client should attempt to establish publish peer connection when joining room to speed up publishing
$participant  : mixed
Generated from protobuf field <code>.livekit.ParticipantInfo participant = 2;</code>
$ping_interval  : mixed
Generated from protobuf field <code>int32 ping_interval = 11;</code>
$ping_timeout  : mixed
Generated from protobuf field <code>int32 ping_timeout = 10;</code>
$room  : mixed
Generated from protobuf field <code>.livekit.Room room = 1;</code>
$server_info  : mixed
Generated from protobuf field <code>.livekit.ServerInfo server_info = 12;</code>
$server_region  : mixed
deprecated. use server_info.region instead.
$server_version  : mixed
deprecated. use server_info.version instead.
$sif_trailer  : mixed
Server-Injected-Frame byte trailer, used to identify unencrypted frames when e2ee is enabled
$subscriber_primary  : mixed
use subscriber as the primary PeerConnection
$enabled_publish_codecs  : mixed
Generated from protobuf field <code>repeated .livekit.Codec enabled_publish_codecs = 14;</code>
$ice_servers  : mixed
Generated from protobuf field <code>repeated .livekit.ICEServer ice_servers = 5;</code>
$other_participants  : mixed
Generated from protobuf field <code>repeated .livekit.ParticipantInfo other_participants = 3;</code>

Methods

__construct()  : mixed
Constructor.
clearClientConfiguration()  : mixed
clearParticipant()  : mixed
clearRoom()  : mixed
clearServerInfo()  : mixed
getAlternativeUrl()  : string
when the current server isn't available, return alternate url to retry connection when this is set, the other fields will be largely empty
getClientConfiguration()  : ClientConfiguration|null
Generated from protobuf field <code>.livekit.ClientConfiguration client_configuration = 8;</code>
getEnabledPublishCodecs()  : RepeatedField<string|int, Codec>
Generated from protobuf field <code>repeated .livekit.Codec enabled_publish_codecs = 14;</code>
getFastPublish()  : bool
when set, client should attempt to establish publish peer connection when joining room to speed up publishing
getIceServers()  : RepeatedField<string|int, ICEServer>
Generated from protobuf field <code>repeated .livekit.ICEServer ice_servers = 5;</code>
getOtherParticipants()  : RepeatedField<string|int, ParticipantInfo>
Generated from protobuf field <code>repeated .livekit.ParticipantInfo other_participants = 3;</code>
getParticipant()  : ParticipantInfo|null
Generated from protobuf field <code>.livekit.ParticipantInfo participant = 2;</code>
getPingInterval()  : int
Generated from protobuf field <code>int32 ping_interval = 11;</code>
getPingTimeout()  : int
Generated from protobuf field <code>int32 ping_timeout = 10;</code>
getRoom()  : Room|null
Generated from protobuf field <code>.livekit.Room room = 1;</code>
getServerInfo()  : ServerInfo|null
Generated from protobuf field <code>.livekit.ServerInfo server_info = 12;</code>
getServerRegion()  : string
deprecated. use server_info.region instead.
getServerVersion()  : string
deprecated. use server_info.version instead.
getSifTrailer()  : string
Server-Injected-Frame byte trailer, used to identify unencrypted frames when e2ee is enabled
getSubscriberPrimary()  : bool
use subscriber as the primary PeerConnection
hasClientConfiguration()  : mixed
hasParticipant()  : mixed
hasRoom()  : mixed
hasServerInfo()  : mixed
setAlternativeUrl()  : $this
when the current server isn't available, return alternate url to retry connection when this is set, the other fields will be largely empty
setClientConfiguration()  : $this
Generated from protobuf field <code>.livekit.ClientConfiguration client_configuration = 8;</code>
setEnabledPublishCodecs()  : $this
Generated from protobuf field <code>repeated .livekit.Codec enabled_publish_codecs = 14;</code>
setFastPublish()  : $this
when set, client should attempt to establish publish peer connection when joining room to speed up publishing
setIceServers()  : $this
Generated from protobuf field <code>repeated .livekit.ICEServer ice_servers = 5;</code>
setOtherParticipants()  : $this
Generated from protobuf field <code>repeated .livekit.ParticipantInfo other_participants = 3;</code>
setParticipant()  : $this
Generated from protobuf field <code>.livekit.ParticipantInfo participant = 2;</code>
setPingInterval()  : $this
Generated from protobuf field <code>int32 ping_interval = 11;</code>
setPingTimeout()  : $this
Generated from protobuf field <code>int32 ping_timeout = 10;</code>
setRoom()  : $this
Generated from protobuf field <code>.livekit.Room room = 1;</code>
setServerInfo()  : $this
Generated from protobuf field <code>.livekit.ServerInfo server_info = 12;</code>
setServerRegion()  : $this
deprecated. use server_info.region instead.
setServerVersion()  : $this
deprecated. use server_info.version instead.
setSifTrailer()  : $this
Server-Injected-Frame byte trailer, used to identify unencrypted frames when e2ee is enabled
setSubscriberPrimary()  : $this
use subscriber as the primary PeerConnection

Properties

$alternative_url

when the current server isn't available, return alternate url to retry connection when this is set, the other fields will be largely empty

protected mixed $alternative_url = ''

Generated from protobuf field string alternative_url = 7;

$client_configuration

Generated from protobuf field <code>.livekit.ClientConfiguration client_configuration = 8;</code>

protected mixed $client_configuration = null

$fast_publish

when set, client should attempt to establish publish peer connection when joining room to speed up publishing

protected mixed $fast_publish = false

Generated from protobuf field bool fast_publish = 15;

$participant

Generated from protobuf field <code>.livekit.ParticipantInfo participant = 2;</code>

protected mixed $participant = null

$ping_interval

Generated from protobuf field <code>int32 ping_interval = 11;</code>

protected mixed $ping_interval = 0

$ping_timeout

Generated from protobuf field <code>int32 ping_timeout = 10;</code>

protected mixed $ping_timeout = 0

$room

Generated from protobuf field <code>.livekit.Room room = 1;</code>

protected mixed $room = null

$server_info

Generated from protobuf field <code>.livekit.ServerInfo server_info = 12;</code>

protected mixed $server_info = null

$server_region

deprecated. use server_info.region instead.

protected mixed $server_region = ''

Generated from protobuf field string server_region = 9;

$server_version

deprecated. use server_info.version instead.

protected mixed $server_version = ''

Generated from protobuf field string server_version = 4;

$sif_trailer

Server-Injected-Frame byte trailer, used to identify unencrypted frames when e2ee is enabled

protected mixed $sif_trailer = ''

Generated from protobuf field bytes sif_trailer = 13;

$subscriber_primary

use subscriber as the primary PeerConnection

protected mixed $subscriber_primary = false

Generated from protobuf field bool subscriber_primary = 6;

$enabled_publish_codecs

Generated from protobuf field <code>repeated .livekit.Codec enabled_publish_codecs = 14;</code>

private mixed $enabled_publish_codecs

$ice_servers

Generated from protobuf field <code>repeated .livekit.ICEServer ice_servers = 5;</code>

private mixed $ice_servers

$other_participants

Generated from protobuf field <code>repeated .livekit.ParticipantInfo other_participants = 3;</code>

private mixed $other_participants

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\Room $room
@type \Livekit\ParticipantInfo $participant
@type \Livekit\ParticipantInfo[] $other_participants
@type string $server_version
      deprecated. use server_info.version instead.
@type \Livekit\ICEServer[] $ice_servers
@type bool $subscriber_primary
      use subscriber as the primary PeerConnection
@type string $alternative_url
      when the current server isn't available, return alternate url to retry connection
      when this is set, the other fields will be largely empty
@type \Livekit\ClientConfiguration $client_configuration
@type string $server_region
      deprecated. use server_info.region instead.
@type int $ping_timeout
@type int $ping_interval
@type \Livekit\ServerInfo $server_info
@type string $sif_trailer
      Server-Injected-Frame byte trailer, used to identify unencrypted frames when e2ee is enabled
@type \Livekit\Codec[] $enabled_publish_codecs
@type bool $fast_publish
      when set, client should attempt to establish publish peer connection when joining room to speed up publishing

}

clearClientConfiguration()

public clearClientConfiguration() : mixed

getAlternativeUrl()

when the current server isn't available, return alternate url to retry connection when this is set, the other fields will be largely empty

public getAlternativeUrl() : string

Generated from protobuf field string alternative_url = 7;

Return values
string

getEnabledPublishCodecs()

Generated from protobuf field <code>repeated .livekit.Codec enabled_publish_codecs = 14;</code>

public getEnabledPublishCodecs() : RepeatedField<string|int, Codec>
Return values
RepeatedField<string|int, Codec>

getFastPublish()

when set, client should attempt to establish publish peer connection when joining room to speed up publishing

public getFastPublish() : bool

Generated from protobuf field bool fast_publish = 15;

Return values
bool

getIceServers()

Generated from protobuf field <code>repeated .livekit.ICEServer ice_servers = 5;</code>

public getIceServers() : RepeatedField<string|int, ICEServer>
Return values
RepeatedField<string|int, ICEServer>

getOtherParticipants()

Generated from protobuf field <code>repeated .livekit.ParticipantInfo other_participants = 3;</code>

public getOtherParticipants() : RepeatedField<string|int, ParticipantInfo>
Return values
RepeatedField<string|int, ParticipantInfo>

getPingInterval()

Generated from protobuf field <code>int32 ping_interval = 11;</code>

public getPingInterval() : int
Return values
int

getPingTimeout()

Generated from protobuf field <code>int32 ping_timeout = 10;</code>

public getPingTimeout() : int
Return values
int

getRoom()

Generated from protobuf field <code>.livekit.Room room = 1;</code>

public getRoom() : Room|null
Return values
Room|null

getServerInfo()

Generated from protobuf field <code>.livekit.ServerInfo server_info = 12;</code>

public getServerInfo() : ServerInfo|null
Return values
ServerInfo|null

getServerRegion()

deprecated. use server_info.region instead.

public getServerRegion() : string

Generated from protobuf field string server_region = 9;

Return values
string

getServerVersion()

deprecated. use server_info.version instead.

public getServerVersion() : string

Generated from protobuf field string server_version = 4;

Return values
string

getSifTrailer()

Server-Injected-Frame byte trailer, used to identify unencrypted frames when e2ee is enabled

public getSifTrailer() : string

Generated from protobuf field bytes sif_trailer = 13;

Return values
string

getSubscriberPrimary()

use subscriber as the primary PeerConnection

public getSubscriberPrimary() : bool

Generated from protobuf field bool subscriber_primary = 6;

Return values
bool

hasClientConfiguration()

public hasClientConfiguration() : mixed

setAlternativeUrl()

when the current server isn't available, return alternate url to retry connection when this is set, the other fields will be largely empty

public setAlternativeUrl(string $var) : $this

Generated from protobuf field string alternative_url = 7;

Parameters
$var : string
Return values
$this

setClientConfiguration()

Generated from protobuf field <code>.livekit.ClientConfiguration client_configuration = 8;</code>

public setClientConfiguration(ClientConfiguration $var) : $this
Parameters
$var : ClientConfiguration
Return values
$this

setEnabledPublishCodecs()

Generated from protobuf field <code>repeated .livekit.Codec enabled_publish_codecs = 14;</code>

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

setFastPublish()

when set, client should attempt to establish publish peer connection when joining room to speed up publishing

public setFastPublish(bool $var) : $this

Generated from protobuf field bool fast_publish = 15;

Parameters
$var : bool
Return values
$this

setIceServers()

Generated from protobuf field <code>repeated .livekit.ICEServer ice_servers = 5;</code>

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

setOtherParticipants()

Generated from protobuf field <code>repeated .livekit.ParticipantInfo other_participants = 3;</code>

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

setParticipant()

Generated from protobuf field <code>.livekit.ParticipantInfo participant = 2;</code>

public setParticipant(ParticipantInfo $var) : $this
Parameters
$var : ParticipantInfo
Return values
$this

setPingInterval()

Generated from protobuf field <code>int32 ping_interval = 11;</code>

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

setPingTimeout()

Generated from protobuf field <code>int32 ping_timeout = 10;</code>

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

setRoom()

Generated from protobuf field <code>.livekit.Room room = 1;</code>

public setRoom(Room $var) : $this
Parameters
$var : Room
Return values
$this

setServerInfo()

Generated from protobuf field <code>.livekit.ServerInfo server_info = 12;</code>

public setServerInfo(ServerInfo $var) : $this
Parameters
$var : ServerInfo
Return values
$this

setServerRegion()

deprecated. use server_info.region instead.

public setServerRegion(string $var) : $this

Generated from protobuf field string server_region = 9;

Parameters
$var : string
Return values
$this

setServerVersion()

deprecated. use server_info.version instead.

public setServerVersion(string $var) : $this

Generated from protobuf field string server_version = 4;

Parameters
$var : string
Return values
$this

setSifTrailer()

Server-Injected-Frame byte trailer, used to identify unencrypted frames when e2ee is enabled

public setSifTrailer(string $var) : $this

Generated from protobuf field bytes sif_trailer = 13;

Parameters
$var : string
Return values
$this

setSubscriberPrimary()

use subscriber as the primary PeerConnection

public setSubscriberPrimary(bool $var) : $this

Generated from protobuf field bool subscriber_primary = 6;

Parameters
$var : bool
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results