Documentation

Scenario extends Message
in package

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

Table of Contents

Properties

$agent_expectations  : mixed
Generated from protobuf field <code>string agent_expectations = 5;</code>
$created_at  : mixed
Generated from protobuf field <code>.google.protobuf.Timestamp created_at = 7;</code>
$error  : mixed
Generated from protobuf field <code>string error = 9;</code>
$group_id  : mixed
Generated from protobuf field <code>string group_id = 10;</code>
$id  : mixed
Generated from protobuf field <code>string id = 1;</code>
$instructions  : mixed
Generated from protobuf field <code>string instructions = 4;</code>
$label  : mixed
Generated from protobuf field <code>string label = 3;</code>
$project_id  : mixed
Generated from protobuf field <code>string project_id = 2;</code>
$source_room_id  : mixed
Generated from protobuf field <code>string source_room_id = 6;</code>
$status  : mixed
Generated from protobuf field <code>.livekit.Scenario.Status status = 8;</code>
$metadata  : mixed
Set as participant attributes on the simulation participant's access token.

Methods

__construct()  : mixed
Constructor.
clearCreatedAt()  : mixed
getAgentExpectations()  : string
Generated from protobuf field <code>string agent_expectations = 5;</code>
getCreatedAt()  : Timestamp|null
Generated from protobuf field <code>.google.protobuf.Timestamp created_at = 7;</code>
getError()  : string
Generated from protobuf field <code>string error = 9;</code>
getGroupId()  : string
Generated from protobuf field <code>string group_id = 10;</code>
getId()  : string
Generated from protobuf field <code>string id = 1;</code>
getInstructions()  : string
Generated from protobuf field <code>string instructions = 4;</code>
getLabel()  : string
Generated from protobuf field <code>string label = 3;</code>
getMetadata()  : MapField
Set as participant attributes on the simulation participant's access token.
getProjectId()  : string
Generated from protobuf field <code>string project_id = 2;</code>
getSourceRoomId()  : string
Generated from protobuf field <code>string source_room_id = 6;</code>
getStatus()  : int
Generated from protobuf field <code>.livekit.Scenario.Status status = 8;</code>
hasCreatedAt()  : mixed
setAgentExpectations()  : $this
Generated from protobuf field <code>string agent_expectations = 5;</code>
setCreatedAt()  : $this
Generated from protobuf field <code>.google.protobuf.Timestamp created_at = 7;</code>
setError()  : $this
Generated from protobuf field <code>string error = 9;</code>
setGroupId()  : $this
Generated from protobuf field <code>string group_id = 10;</code>
setId()  : $this
Generated from protobuf field <code>string id = 1;</code>
setInstructions()  : $this
Generated from protobuf field <code>string instructions = 4;</code>
setLabel()  : $this
Generated from protobuf field <code>string label = 3;</code>
setMetadata()  : $this
Set as participant attributes on the simulation participant's access token.
setProjectId()  : $this
Generated from protobuf field <code>string project_id = 2;</code>
setSourceRoomId()  : $this
Generated from protobuf field <code>string source_room_id = 6;</code>
setStatus()  : $this
Generated from protobuf field <code>.livekit.Scenario.Status status = 8;</code>

Properties

$agent_expectations

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

protected mixed $agent_expectations = ''

$created_at

Generated from protobuf field <code>.google.protobuf.Timestamp created_at = 7;</code>

protected mixed $created_at = null

$error

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

protected mixed $error = ''

$group_id

Generated from protobuf field <code>string group_id = 10;</code>

protected mixed $group_id = ''

$id

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

protected mixed $id = ''

$instructions

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

protected mixed $instructions = ''

$label

Generated from protobuf field <code>string label = 3;</code>

protected mixed $label = ''

$project_id

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

protected mixed $project_id = ''

$source_room_id

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

protected mixed $source_room_id = ''

$status

Generated from protobuf field <code>.livekit.Scenario.Status status = 8;</code>

protected mixed $status = 0

$metadata

Set as participant attributes on the simulation participant's access token.

private mixed $metadata

Generated from protobuf field map<string, string> metadata = 11;

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 $project_id
@type string $label
@type string $instructions
@type string $agent_expectations
@type string $source_room_id
@type \Google\Protobuf\Timestamp $created_at
@type int $status
@type string $error
@type string $group_id
@type array|\Google\Protobuf\Internal\MapField $metadata
      Set as participant attributes on the simulation participant's access token.

}

clearCreatedAt()

public clearCreatedAt() : mixed

getAgentExpectations()

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

public getAgentExpectations() : string
Return values
string

getCreatedAt()

Generated from protobuf field <code>.google.protobuf.Timestamp created_at = 7;</code>

public getCreatedAt() : Timestamp|null
Return values
Timestamp|null

getError()

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

public getError() : string
Return values
string

getGroupId()

Generated from protobuf field <code>string group_id = 10;</code>

public getGroupId() : string
Return values
string

getId()

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

public getId() : string
Return values
string

getInstructions()

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

public getInstructions() : string
Return values
string

getLabel()

Generated from protobuf field <code>string label = 3;</code>

public getLabel() : string
Return values
string

getMetadata()

Set as participant attributes on the simulation participant's access token.

public getMetadata() : MapField

Generated from protobuf field map<string, string> metadata = 11;

Return values
MapField

getProjectId()

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

public getProjectId() : string
Return values
string

getSourceRoomId()

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

public getSourceRoomId() : string
Return values
string

getStatus()

Generated from protobuf field <code>.livekit.Scenario.Status status = 8;</code>

public getStatus() : int
Return values
int

hasCreatedAt()

public hasCreatedAt() : mixed

setAgentExpectations()

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

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

setCreatedAt()

Generated from protobuf field <code>.google.protobuf.Timestamp created_at = 7;</code>

public setCreatedAt(Timestamp $var) : $this
Parameters
$var : Timestamp
Return values
$this

setError()

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

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

setGroupId()

Generated from protobuf field <code>string group_id = 10;</code>

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

setId()

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

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

setInstructions()

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

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

setLabel()

Generated from protobuf field <code>string label = 3;</code>

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

setMetadata()

Set as participant attributes on the simulation participant's access token.

public setMetadata(array<string|int, mixed>|MapField $var) : $this

Generated from protobuf field map<string, string> metadata = 11;

Parameters
$var : array<string|int, mixed>|MapField
Return values
$this

setProjectId()

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

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

setSourceRoomId()

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

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

setStatus()

Generated from protobuf field <code>.livekit.Scenario.Status status = 8;</code>

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results