Documentation

Job extends Message
in package

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

Table of Contents

Properties

$agent_name  : mixed
Generated from protobuf field <code>string agent_name = 7;</code>
$dispatch_id  : mixed
Generated from protobuf field <code>string dispatch_id = 9;</code>
$enable_recording  : mixed
Generated from protobuf field <code>bool enable_recording = 10;</code>
$id  : mixed
Generated from protobuf field <code>string id = 1;</code>
$metadata  : mixed
Generated from protobuf field <code>string metadata = 6;</code>
$namespace  : mixed
Generated from protobuf field <code>string namespace = 5 [deprecated = true];</code>
$participant  : mixed
Generated from protobuf field <code>optional .livekit.ParticipantInfo participant = 4;</code>
$room  : mixed
Generated from protobuf field <code>.livekit.Room room = 3;</code>
$state  : mixed
Generated from protobuf field <code>.livekit.JobState state = 8;</code>
$type  : mixed
Generated from protobuf field <code>.livekit.JobType type = 2;</code>

Methods

__construct()  : mixed
Constructor.
clearParticipant()  : mixed
clearRoom()  : mixed
clearState()  : mixed
getAgentName()  : string
Generated from protobuf field <code>string agent_name = 7;</code>
getDispatchId()  : string
Generated from protobuf field <code>string dispatch_id = 9;</code>
getEnableRecording()  : bool
Generated from protobuf field <code>bool enable_recording = 10;</code>
getId()  : string
Generated from protobuf field <code>string id = 1;</code>
getMetadata()  : string
Generated from protobuf field <code>string metadata = 6;</code>
getNamespace()  : string
Generated from protobuf field <code>string namespace = 5 [deprecated = true];</code>
getParticipant()  : ParticipantInfo|null
Generated from protobuf field <code>optional .livekit.ParticipantInfo participant = 4;</code>
getRoom()  : Room|null
Generated from protobuf field <code>.livekit.Room room = 3;</code>
getState()  : JobState|null
Generated from protobuf field <code>.livekit.JobState state = 8;</code>
getType()  : int
Generated from protobuf field <code>.livekit.JobType type = 2;</code>
hasParticipant()  : mixed
hasRoom()  : mixed
hasState()  : mixed
setAgentName()  : $this
Generated from protobuf field <code>string agent_name = 7;</code>
setDispatchId()  : $this
Generated from protobuf field <code>string dispatch_id = 9;</code>
setEnableRecording()  : $this
Generated from protobuf field <code>bool enable_recording = 10;</code>
setId()  : $this
Generated from protobuf field <code>string id = 1;</code>
setMetadata()  : $this
Generated from protobuf field <code>string metadata = 6;</code>
setNamespace()  : $this
Generated from protobuf field <code>string namespace = 5 [deprecated = true];</code>
setParticipant()  : $this
Generated from protobuf field <code>optional .livekit.ParticipantInfo participant = 4;</code>
setRoom()  : $this
Generated from protobuf field <code>.livekit.Room room = 3;</code>
setState()  : $this
Generated from protobuf field <code>.livekit.JobState state = 8;</code>
setType()  : $this
Generated from protobuf field <code>.livekit.JobType type = 2;</code>

Properties

$agent_name

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

protected mixed $agent_name = ''

$dispatch_id

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

protected mixed $dispatch_id = ''

$enable_recording

Generated from protobuf field <code>bool enable_recording = 10;</code>

protected mixed $enable_recording = false

$id

Generated from protobuf field <code>string id = 1;</code>

protected mixed $id = ''

$metadata

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

protected mixed $metadata = ''

$namespace

Generated from protobuf field <code>string namespace = 5 [deprecated = true];</code>

protected mixed $namespace = ''

$participant

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

protected mixed $participant = null

$room

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

protected mixed $room = null

$state

Generated from protobuf field <code>.livekit.JobState state = 8;</code>

protected mixed $state = null

$type

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

protected mixed $type = 0

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 string $id
@type string $dispatch_id
@type int $type
@type \Livekit\Room $room
@type \Livekit\ParticipantInfo $participant
@type string $namespace
@type string $metadata
@type string $agent_name
@type \Livekit\JobState $state
@type bool $enable_recording

}

clearParticipant()

public clearParticipant() : mixed

clearRoom()

public clearRoom() : mixed

clearState()

public clearState() : mixed

getAgentName()

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

public getAgentName() : string
Return values
string

getDispatchId()

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

public getDispatchId() : string
Return values
string

getEnableRecording()

Generated from protobuf field <code>bool enable_recording = 10;</code>

public getEnableRecording() : bool
Return values
bool

getId()

Generated from protobuf field <code>string id = 1;</code>

public getId() : string
Return values
string

getMetadata()

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

public getMetadata() : string
Return values
string

getNamespace()

Generated from protobuf field <code>string namespace = 5 [deprecated = true];</code>

public getNamespace() : string
Return values
string

getParticipant()

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

public getParticipant() : ParticipantInfo|null
Return values
ParticipantInfo|null

getRoom()

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

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

getState()

Generated from protobuf field <code>.livekit.JobState state = 8;</code>

public getState() : JobState|null
Return values
JobState|null

getType()

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

public getType() : int
Return values
int

hasParticipant()

public hasParticipant() : mixed

hasRoom()

public hasRoom() : mixed

hasState()

public hasState() : mixed

setAgentName()

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

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

setDispatchId()

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

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

setEnableRecording()

Generated from protobuf field <code>bool enable_recording = 10;</code>

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

setId()

Generated from protobuf field <code>string id = 1;</code>

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

setMetadata()

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

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

setNamespace()

Generated from protobuf field <code>string namespace = 5 [deprecated = true];</code>

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

setParticipant()

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

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

setRoom()

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

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

setState()

Generated from protobuf field <code>.livekit.JobState state = 8;</code>

public setState(JobState $var) : $this
Parameters
$var : JobState
Return values
$this

setType()

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

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results