Class SimulationDispatch

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

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

public sealed class SimulationDispatch : IMessage<SimulationDispatch>, IEquatable<SimulationDispatch>, IDeepCloneable<SimulationDispatch>, IBufferMessage, IMessage

Inheritance

object

SimulationDispatch

Implements

IMessage<SimulationDispatch>

IEquatable<SimulationDispatch>

IDeepCloneable<SimulationDispatch>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SimulationDispatch()

public SimulationDispatch()

SimulationDispatch(SimulationDispatch)

public SimulationDispatch(SimulationDispatch other)

Parameters

other SimulationDispatch

Fields

JobIdFieldNumber

Field number for the "job_id" field.

public const int JobIdFieldNumber = 2

Field Value

int

ModeFieldNumber

Field number for the "mode" field.

public const int ModeFieldNumber = 4

Field Value

int

ScenarioFieldNumber

Field number for the "scenario" field.

public const int ScenarioFieldNumber = 3

Field Value

int

SimulationRunIdFieldNumber

Field number for the "simulation_run_id" field.

public const int SimulationRunIdFieldNumber = 1

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

JobId

public string JobId { get; set; }

Property Value

string

Mode

public SimulationMode Mode { get; set; }

Property Value

SimulationMode

Parser

public static MessageParser<SimulationDispatch> Parser { get; }

Property Value

MessageParser<SimulationDispatch>

Scenario

public Scenario Scenario { get; set; }

Property Value

Scenario

SimulationRunId

public string SimulationRunId { get; set; }

Property Value

string

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public SimulationDispatch Clone()

Returns

SimulationDispatch

A deep clone of this object.

Equals(SimulationDispatch)

public bool Equals(SimulationDispatch other)

Parameters

other SimulationDispatch

Returns

bool

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(SimulationDispatch)

Merges the given message into this one.

public void MergeFrom(SimulationDispatch other)

Parameters

other SimulationDispatch

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.