Class ScenarioGroup

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

A named group of scenarios, mirroring a whole scenarios.yaml file.

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

Inheritance

object

ScenarioGroup

Implements

IMessage<ScenarioGroup>

IEquatable<ScenarioGroup>

IDeepCloneable<ScenarioGroup>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ScenarioGroup()

public ScenarioGroup()

ScenarioGroup(ScenarioGroup)

public ScenarioGroup(ScenarioGroup other)

Parameters

other ScenarioGroup

Fields

IdFieldNumber

Field number for the "id" field.

public const int IdFieldNumber = 3

Field Value

int

NameFieldNumber

Field number for the "name" field.

public const int NameFieldNumber = 1

Field Value

int

ScenariosFieldNumber

Field number for the "scenarios" field.

public const int ScenariosFieldNumber = 2

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Id

SCNG_-prefixed guid. Stable identity of the scenarios file, independent of its name.

public string Id { get; set; }

Property Value

string

Name

public string Name { get; set; }

Property Value

string

Parser

public static MessageParser<ScenarioGroup> Parser { get; }

Property Value

MessageParser<ScenarioGroup>

Scenarios

public RepeatedField<Scenario> Scenarios { get; }

Property Value

RepeatedField<Scenario>

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 ScenarioGroup Clone()

Returns

ScenarioGroup

A deep clone of this object.

Equals(ScenarioGroup)

public bool Equals(ScenarioGroup other)

Parameters

other ScenarioGroup

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

Merges the given message into this one.

public void MergeFrom(ScenarioGroup other)

Parameters

other ScenarioGroup

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.