Class Scenario

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

A single scenario, mirroring one entry in a scenarios.yaml file. Scenarios are no longer stored server-side; the yaml file is the source of truth.

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

Inheritance

object

Scenario

Implements

IMessage<Scenario>

IEquatable<Scenario>

IDeepCloneable<Scenario>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

Scenario()

public Scenario()

Scenario(Scenario)

public Scenario(Scenario other)

Parameters

other Scenario

Fields

AgentExpectationsFieldNumber

Field number for the "agent_expectations" field.

public const int AgentExpectationsFieldNumber = 3

Field Value

int

IdFieldNumber

Field number for the "id" field.

public const int IdFieldNumber = 6

Field Value

int

InstructionsFieldNumber

Field number for the "instructions" field.

public const int InstructionsFieldNumber = 2

Field Value

int

LabelFieldNumber

Field number for the "label" field.

public const int LabelFieldNumber = 1

Field Value

int

TagsFieldNumber

Field number for the "tags" field.

public const int TagsFieldNumber = 4

Field Value

int

UserdataFieldNumber

Field number for the "userdata" field.

public const int UserdataFieldNumber = 5

Field Value

int

Properties

AgentExpectations

public string AgentExpectations { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Id

SCN_-prefixed guid. Stable across edits to label, instructions, or expectations, so runs of the same scenario can be correlated over time.

public string Id { get; set; }

Property Value

string

Instructions

public string Instructions { get; set; }

Property Value

string

Label

public string Label { get; set; }

Property Value

string

Parser

public static MessageParser<Scenario> Parser { get; }

Property Value

MessageParser<Scenario>

Tags

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

public MapField<string, string> Tags { get; }

Property Value

MapField<string, string>

Userdata

Arbitrary JSON-encoded object, surfaced to the agent under test as SimulationContext userdata (e.g. inputs and benchmark target state).

public string Userdata { 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 Scenario Clone()

Returns

Scenario

A deep clone of this object.

Equals(Scenario)

public bool Equals(Scenario other)

Parameters

other Scenario

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(Scenario)

Merges the given message into this one.

public void MergeFrom(Scenario other)

Parameters

other Scenario

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.