Documentation

SimulationDispatch extends Message
in package

Carried (protojson-encoded) in the simulation room's metadata so the agent under test can read the scenario + run identity synchronously at connect.

Generated from protobuf message livekit.SimulationDispatch

Table of Contents

Properties

$job_id  : mixed
Generated from protobuf field <code>string job_id = 2;</code>
$mode  : mixed
Generated from protobuf field <code>.livekit.SimulationMode mode = 4;</code>
$scenario  : mixed
Generated from protobuf field <code>.livekit.Scenario scenario = 3;</code>
$simulation_run_id  : mixed
Generated from protobuf field <code>string simulation_run_id = 1;</code>

Methods

__construct()  : mixed
Constructor.
clearScenario()  : mixed
getJobId()  : string
Generated from protobuf field <code>string job_id = 2;</code>
getMode()  : int
Generated from protobuf field <code>.livekit.SimulationMode mode = 4;</code>
getScenario()  : Scenario|null
Generated from protobuf field <code>.livekit.Scenario scenario = 3;</code>
getSimulationRunId()  : string
Generated from protobuf field <code>string simulation_run_id = 1;</code>
hasScenario()  : mixed
setJobId()  : $this
Generated from protobuf field <code>string job_id = 2;</code>
setMode()  : $this
Generated from protobuf field <code>.livekit.SimulationMode mode = 4;</code>
setScenario()  : $this
Generated from protobuf field <code>.livekit.Scenario scenario = 3;</code>
setSimulationRunId()  : $this
Generated from protobuf field <code>string simulation_run_id = 1;</code>

Properties

$job_id

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

protected mixed $job_id = ''

$mode

Generated from protobuf field <code>.livekit.SimulationMode mode = 4;</code>

protected mixed $mode = 0

$scenario

Generated from protobuf field <code>.livekit.Scenario scenario = 3;</code>

protected mixed $scenario = null

$simulation_run_id

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

protected mixed $simulation_run_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 string $simulation_run_id
@type string $job_id
@type \Livekit\Scenario $scenario
@type int $mode

}

getJobId()

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

public getJobId() : string
Return values
string

getMode()

Generated from protobuf field <code>.livekit.SimulationMode mode = 4;</code>

public getMode() : int
Return values
int

getSimulationRunId()

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

public getSimulationRunId() : string
Return values
string

setJobId()

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

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

setMode()

Generated from protobuf field <code>.livekit.SimulationMode mode = 4;</code>

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

setScenario()

Generated from protobuf field <code>.livekit.Scenario scenario = 3;</code>

public setScenario(Scenario $var) : $this
Parameters
$var : Scenario
Return values
$this

setSimulationRunId()

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

public setSimulationRunId(string $var) : $this
Parameters
$var : string
Return values
$this
On this page

Search results