Documentation

JobState extends Message
in package

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

Table of Contents

Properties

$agent_id  : mixed
Generated from protobuf field <code>string agent_id = 8;</code>
$ended_at  : mixed
Generated from protobuf field <code>int64 ended_at = 4;</code>
$error  : mixed
Generated from protobuf field <code>string error = 2;</code>
$participant_identity  : mixed
Generated from protobuf field <code>string participant_identity = 6;</code>
$started_at  : mixed
Generated from protobuf field <code>int64 started_at = 3;</code>
$status  : mixed
Generated from protobuf field <code>.livekit.JobStatus status = 1;</code>
$updated_at  : mixed
Generated from protobuf field <code>int64 updated_at = 5;</code>
$worker_id  : mixed
Generated from protobuf field <code>string worker_id = 7;</code>

Methods

__construct()  : mixed
Constructor.
getAgentId()  : string
Generated from protobuf field <code>string agent_id = 8;</code>
getEndedAt()  : int|string
Generated from protobuf field <code>int64 ended_at = 4;</code>
getError()  : string
Generated from protobuf field <code>string error = 2;</code>
getParticipantIdentity()  : string
Generated from protobuf field <code>string participant_identity = 6;</code>
getStartedAt()  : int|string
Generated from protobuf field <code>int64 started_at = 3;</code>
getStatus()  : int
Generated from protobuf field <code>.livekit.JobStatus status = 1;</code>
getUpdatedAt()  : int|string
Generated from protobuf field <code>int64 updated_at = 5;</code>
getWorkerId()  : string
Generated from protobuf field <code>string worker_id = 7;</code>
setAgentId()  : $this
Generated from protobuf field <code>string agent_id = 8;</code>
setEndedAt()  : $this
Generated from protobuf field <code>int64 ended_at = 4;</code>
setError()  : $this
Generated from protobuf field <code>string error = 2;</code>
setParticipantIdentity()  : $this
Generated from protobuf field <code>string participant_identity = 6;</code>
setStartedAt()  : $this
Generated from protobuf field <code>int64 started_at = 3;</code>
setStatus()  : $this
Generated from protobuf field <code>.livekit.JobStatus status = 1;</code>
setUpdatedAt()  : $this
Generated from protobuf field <code>int64 updated_at = 5;</code>
setWorkerId()  : $this
Generated from protobuf field <code>string worker_id = 7;</code>

Properties

$agent_id

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

protected mixed $agent_id = ''

$ended_at

Generated from protobuf field <code>int64 ended_at = 4;</code>

protected mixed $ended_at = 0

$error

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

protected mixed $error = ''

$participant_identity

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

protected mixed $participant_identity = ''

$started_at

Generated from protobuf field <code>int64 started_at = 3;</code>

protected mixed $started_at = 0

$status

Generated from protobuf field <code>.livekit.JobStatus status = 1;</code>

protected mixed $status = 0

$updated_at

Generated from protobuf field <code>int64 updated_at = 5;</code>

protected mixed $updated_at = 0

$worker_id

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

protected mixed $worker_id = ''

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 $status
@type string $error
@type int|string $started_at
@type int|string $ended_at
@type int|string $updated_at
@type string $participant_identity
@type string $worker_id
@type string $agent_id

}

getAgentId()

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

public getAgentId() : string
Return values
string

getEndedAt()

Generated from protobuf field <code>int64 ended_at = 4;</code>

public getEndedAt() : int|string
Return values
int|string

getError()

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

public getError() : string
Return values
string

getParticipantIdentity()

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

public getParticipantIdentity() : string
Return values
string

getStartedAt()

Generated from protobuf field <code>int64 started_at = 3;</code>

public getStartedAt() : int|string
Return values
int|string

getStatus()

Generated from protobuf field <code>.livekit.JobStatus status = 1;</code>

public getStatus() : int
Return values
int

getUpdatedAt()

Generated from protobuf field <code>int64 updated_at = 5;</code>

public getUpdatedAt() : int|string
Return values
int|string

getWorkerId()

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

public getWorkerId() : string
Return values
string

setAgentId()

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

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

setEndedAt()

Generated from protobuf field <code>int64 ended_at = 4;</code>

public setEndedAt(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setError()

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

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

setParticipantIdentity()

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

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

setStartedAt()

Generated from protobuf field <code>int64 started_at = 3;</code>

public setStartedAt(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setStatus()

Generated from protobuf field <code>.livekit.JobStatus status = 1;</code>

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

setUpdatedAt()

Generated from protobuf field <code>int64 updated_at = 5;</code>

public setUpdatedAt(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setWorkerId()

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

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results