Documentation

ServerInfo extends Message
in package

details about the server

Generated from protobuf message livekit.ServerInfo

Table of Contents

Properties

$agent_protocol  : mixed
Generated from protobuf field <code>int32 agent_protocol = 7;</code>
$debug_info  : mixed
additional debugging information. sent only if server is in development mode
$edition  : mixed
Generated from protobuf field <code>.livekit.ServerInfo.Edition edition = 1;</code>
$node_id  : mixed
Generated from protobuf field <code>string node_id = 5;</code>
$protocol  : mixed
Generated from protobuf field <code>int32 protocol = 3;</code>
$region  : mixed
Generated from protobuf field <code>string region = 4;</code>
$version  : mixed
Generated from protobuf field <code>string version = 2;</code>

Methods

__construct()  : mixed
Constructor.
getAgentProtocol()  : int
Generated from protobuf field <code>int32 agent_protocol = 7;</code>
getDebugInfo()  : string
additional debugging information. sent only if server is in development mode
getEdition()  : int
Generated from protobuf field <code>.livekit.ServerInfo.Edition edition = 1;</code>
getNodeId()  : string
Generated from protobuf field <code>string node_id = 5;</code>
getProtocol()  : int
Generated from protobuf field <code>int32 protocol = 3;</code>
getRegion()  : string
Generated from protobuf field <code>string region = 4;</code>
getVersion()  : string
Generated from protobuf field <code>string version = 2;</code>
setAgentProtocol()  : $this
Generated from protobuf field <code>int32 agent_protocol = 7;</code>
setDebugInfo()  : $this
additional debugging information. sent only if server is in development mode
setEdition()  : $this
Generated from protobuf field <code>.livekit.ServerInfo.Edition edition = 1;</code>
setNodeId()  : $this
Generated from protobuf field <code>string node_id = 5;</code>
setProtocol()  : $this
Generated from protobuf field <code>int32 protocol = 3;</code>
setRegion()  : $this
Generated from protobuf field <code>string region = 4;</code>
setVersion()  : $this
Generated from protobuf field <code>string version = 2;</code>

Properties

$agent_protocol

Generated from protobuf field <code>int32 agent_protocol = 7;</code>

protected mixed $agent_protocol = 0

$debug_info

additional debugging information. sent only if server is in development mode

protected mixed $debug_info = ''

Generated from protobuf field string debug_info = 6;

$edition

Generated from protobuf field <code>.livekit.ServerInfo.Edition edition = 1;</code>

protected mixed $edition = 0

$node_id

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

protected mixed $node_id = ''

$protocol

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

protected mixed $protocol = 0

$region

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

protected mixed $region = ''

$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 $edition
@type string $version
@type int $protocol
@type string $region
@type string $node_id
@type string $debug_info
      additional debugging information. sent only if server is in development mode
@type int $agent_protocol

}

getAgentProtocol()

Generated from protobuf field <code>int32 agent_protocol = 7;</code>

public getAgentProtocol() : int
Return values
int

getDebugInfo()

additional debugging information. sent only if server is in development mode

public getDebugInfo() : string

Generated from protobuf field string debug_info = 6;

Return values
string

getEdition()

Generated from protobuf field <code>.livekit.ServerInfo.Edition edition = 1;</code>

public getEdition() : int
Return values
int

getNodeId()

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

public getNodeId() : string
Return values
string

getProtocol()

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

public getProtocol() : int
Return values
int

getRegion()

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

public getRegion() : string
Return values
string

getVersion()

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

public getVersion() : string
Return values
string

setAgentProtocol()

Generated from protobuf field <code>int32 agent_protocol = 7;</code>

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

setDebugInfo()

additional debugging information. sent only if server is in development mode

public setDebugInfo(string $var) : $this

Generated from protobuf field string debug_info = 6;

Parameters
$var : string
Return values
$this

setEdition()

Generated from protobuf field <code>.livekit.ServerInfo.Edition edition = 1;</code>

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

setNodeId()

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

public setNodeId(string $var) : $this
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

setRegion()

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

public setRegion(string $var) : $this
Parameters
$var : string
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