Documentation

RegisterWorkerRequest extends Message
in package

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

Table of Contents

Properties

$agent_name  : mixed
Generated from protobuf field <code>string agent_name = 8;</code>
$allowed_permissions  : mixed
Generated from protobuf field <code>.livekit.ParticipantPermission allowed_permissions = 7;</code>
$namespace  : mixed
Generated from protobuf field <code>optional string namespace = 6;</code>
$ping_interval  : mixed
string name = 4 [deprecated = true];
$type  : mixed
Generated from protobuf field <code>.livekit.JobType type = 1;</code>
$version  : mixed
string worker_id = 2;

Methods

__construct()  : mixed
Constructor.
clearAllowedPermissions()  : mixed
clearNamespace()  : mixed
getAgentName()  : string
Generated from protobuf field <code>string agent_name = 8;</code>
getAllowedPermissions()  : ParticipantPermission|null
Generated from protobuf field <code>.livekit.ParticipantPermission allowed_permissions = 7;</code>
getNamespace()  : string
Generated from protobuf field <code>optional string namespace = 6;</code>
getPingInterval()  : int
string name = 4 [deprecated = true];
getType()  : int
Generated from protobuf field <code>.livekit.JobType type = 1;</code>
getVersion()  : string
string worker_id = 2;
hasAllowedPermissions()  : mixed
hasNamespace()  : mixed
setAgentName()  : $this
Generated from protobuf field <code>string agent_name = 8;</code>
setAllowedPermissions()  : $this
Generated from protobuf field <code>.livekit.ParticipantPermission allowed_permissions = 7;</code>
setNamespace()  : $this
Generated from protobuf field <code>optional string namespace = 6;</code>
setPingInterval()  : $this
string name = 4 [deprecated = true];
setType()  : $this
Generated from protobuf field <code>.livekit.JobType type = 1;</code>
setVersion()  : $this
string worker_id = 2;

Properties

$agent_name

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

protected mixed $agent_name = ''

$allowed_permissions

Generated from protobuf field <code>.livekit.ParticipantPermission allowed_permissions = 7;</code>

protected mixed $allowed_permissions = null

$namespace

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

protected mixed $namespace = null

$ping_interval

string name = 4 [deprecated = true];

protected mixed $ping_interval = 0

Generated from protobuf field uint32 ping_interval = 5;

$type

Generated from protobuf field <code>.livekit.JobType type = 1;</code>

protected mixed $type = 0

$version

string worker_id = 2;

protected mixed $version = ''

Generated from protobuf field string version = 3;

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 $type
@type string $agent_name
@type string $version
      string worker_id = 2;
@type int $ping_interval
      string name = 4 [deprecated = true];
@type string $namespace
@type \Livekit\ParticipantPermission $allowed_permissions

}

getAgentName()

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

public getAgentName() : string
Return values
string

getNamespace()

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

public getNamespace() : string
Return values
string

getPingInterval()

string name = 4 [deprecated = true];

public getPingInterval() : int

Generated from protobuf field uint32 ping_interval = 5;

Return values
int

getType()

Generated from protobuf field <code>.livekit.JobType type = 1;</code>

public getType() : int
Return values
int

getVersion()

string worker_id = 2;

public getVersion() : string

Generated from protobuf field string version = 3;

Return values
string

setAgentName()

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

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

setNamespace()

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

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

setPingInterval()

string name = 4 [deprecated = true];

public setPingInterval(int $var) : $this

Generated from protobuf field uint32 ping_interval = 5;

Parameters
$var : int
Return values
$this

setType()

Generated from protobuf field <code>.livekit.JobType type = 1;</code>

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

setVersion()

string worker_id = 2;

public setVersion(string $var) : $this

Generated from protobuf field string version = 3;

Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results