Documentation

ClientInfo extends Message
in package

details about the client

Generated from protobuf message livekit.ClientInfo

Table of Contents

Properties

$address  : mixed
Generated from protobuf field <code>string address = 9;</code>
$browser  : mixed
Generated from protobuf field <code>string browser = 7;</code>
$browser_version  : mixed
Generated from protobuf field <code>string browser_version = 8;</code>
$device_model  : mixed
Generated from protobuf field <code>string device_model = 6;</code>
$network  : mixed
wifi, wired, cellular, vpn, empty if not known
$os  : mixed
Generated from protobuf field <code>string os = 4;</code>
$os_version  : mixed
Generated from protobuf field <code>string os_version = 5;</code>
$other_sdks  : mixed
comma separated list of additional LiveKit SDKs in use of this client, with versions e.g. "components-js:1.2.3,track-processors-js:1.2.3"
$protocol  : mixed
Generated from protobuf field <code>int32 protocol = 3;</code>
$sdk  : mixed
Generated from protobuf field <code>.livekit.ClientInfo.SDK sdk = 1;</code>
$version  : mixed
Generated from protobuf field <code>string version = 2;</code>

Methods

__construct()  : mixed
Constructor.
getAddress()  : string
Generated from protobuf field <code>string address = 9;</code>
getBrowser()  : string
Generated from protobuf field <code>string browser = 7;</code>
getBrowserVersion()  : string
Generated from protobuf field <code>string browser_version = 8;</code>
getDeviceModel()  : string
Generated from protobuf field <code>string device_model = 6;</code>
getNetwork()  : string
wifi, wired, cellular, vpn, empty if not known
getOs()  : string
Generated from protobuf field <code>string os = 4;</code>
getOsVersion()  : string
Generated from protobuf field <code>string os_version = 5;</code>
getOtherSdks()  : string
comma separated list of additional LiveKit SDKs in use of this client, with versions e.g. "components-js:1.2.3,track-processors-js:1.2.3"
getProtocol()  : int
Generated from protobuf field <code>int32 protocol = 3;</code>
getSdk()  : int
Generated from protobuf field <code>.livekit.ClientInfo.SDK sdk = 1;</code>
getVersion()  : string
Generated from protobuf field <code>string version = 2;</code>
setAddress()  : $this
Generated from protobuf field <code>string address = 9;</code>
setBrowser()  : $this
Generated from protobuf field <code>string browser = 7;</code>
setBrowserVersion()  : $this
Generated from protobuf field <code>string browser_version = 8;</code>
setDeviceModel()  : $this
Generated from protobuf field <code>string device_model = 6;</code>
setNetwork()  : $this
wifi, wired, cellular, vpn, empty if not known
setOs()  : $this
Generated from protobuf field <code>string os = 4;</code>
setOsVersion()  : $this
Generated from protobuf field <code>string os_version = 5;</code>
setOtherSdks()  : $this
comma separated list of additional LiveKit SDKs in use of this client, with versions e.g. "components-js:1.2.3,track-processors-js:1.2.3"
setProtocol()  : $this
Generated from protobuf field <code>int32 protocol = 3;</code>
setSdk()  : $this
Generated from protobuf field <code>.livekit.ClientInfo.SDK sdk = 1;</code>
setVersion()  : $this
Generated from protobuf field <code>string version = 2;</code>

Properties

$address

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

protected mixed $address = ''

$browser

Generated from protobuf field <code>string browser = 7;</code>

protected mixed $browser = ''

$browser_version

Generated from protobuf field <code>string browser_version = 8;</code>

protected mixed $browser_version = ''

$device_model

Generated from protobuf field <code>string device_model = 6;</code>

protected mixed $device_model = ''

$network

wifi, wired, cellular, vpn, empty if not known

protected mixed $network = ''

Generated from protobuf field string network = 10;

$os

Generated from protobuf field <code>string os = 4;</code>

protected mixed $os = ''

$os_version

Generated from protobuf field <code>string os_version = 5;</code>

protected mixed $os_version = ''

$other_sdks

comma separated list of additional LiveKit SDKs in use of this client, with versions e.g. "components-js:1.2.3,track-processors-js:1.2.3"

protected mixed $other_sdks = ''

Generated from protobuf field string other_sdks = 11;

$protocol

Generated from protobuf field <code>int32 protocol = 3;</code>

protected mixed $protocol = 0

$sdk

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

protected mixed $sdk = 0

$version

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

protected mixed $version = ''

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 int $sdk
@type string $version
@type int $protocol
@type string $os
@type string $os_version
@type string $device_model
@type string $browser
@type string $browser_version
@type string $address
@type string $network
      wifi, wired, cellular, vpn, empty if not known
@type string $other_sdks
      comma separated list of additional LiveKit SDKs in use of this client, with versions
      e.g. "components-js:1.2.3,track-processors-js:1.2.3"

}

getAddress()

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

public getAddress() : string
Return values
string

getBrowser()

Generated from protobuf field <code>string browser = 7;</code>

public getBrowser() : string
Return values
string

getBrowserVersion()

Generated from protobuf field <code>string browser_version = 8;</code>

public getBrowserVersion() : string
Return values
string

getDeviceModel()

Generated from protobuf field <code>string device_model = 6;</code>

public getDeviceModel() : string
Return values
string

getNetwork()

wifi, wired, cellular, vpn, empty if not known

public getNetwork() : string

Generated from protobuf field string network = 10;

Return values
string

getOs()

Generated from protobuf field <code>string os = 4;</code>

public getOs() : string
Return values
string

getOsVersion()

Generated from protobuf field <code>string os_version = 5;</code>

public getOsVersion() : string
Return values
string

getOtherSdks()

comma separated list of additional LiveKit SDKs in use of this client, with versions e.g. "components-js:1.2.3,track-processors-js:1.2.3"

public getOtherSdks() : string

Generated from protobuf field string other_sdks = 11;

Return values
string

getProtocol()

Generated from protobuf field <code>int32 protocol = 3;</code>

public getProtocol() : int
Return values
int

getSdk()

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

public getSdk() : int
Return values
int

getVersion()

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

public getVersion() : string
Return values
string

setAddress()

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

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

setBrowser()

Generated from protobuf field <code>string browser = 7;</code>

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

setBrowserVersion()

Generated from protobuf field <code>string browser_version = 8;</code>

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

setDeviceModel()

Generated from protobuf field <code>string device_model = 6;</code>

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

setNetwork()

wifi, wired, cellular, vpn, empty if not known

public setNetwork(string $var) : $this

Generated from protobuf field string network = 10;

Parameters
$var : string
Return values
$this

setOs()

Generated from protobuf field <code>string os = 4;</code>

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

setOsVersion()

Generated from protobuf field <code>string os_version = 5;</code>

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

setOtherSdks()

comma separated list of additional LiveKit SDKs in use of this client, with versions e.g. "components-js:1.2.3,track-processors-js:1.2.3"

public setOtherSdks(string $var) : $this

Generated from protobuf field string other_sdks = 11;

Parameters
$var : string
Return values
$this

setProtocol()

Generated from protobuf field <code>int32 protocol = 3;</code>

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

setSdk()

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

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

setVersion()

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

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results