Table of Contents

Class SimulateScenario

Namespace
LiveKit.Proto
Assembly
LiveKit.AspNetCore.ServerSdk.Abstractions.dll
public sealed class SimulateScenario : IMessage<SimulateScenario>, IEquatable<SimulateScenario>, IDeepCloneable<SimulateScenario>, IBufferMessage, IMessage
Inheritance
SimulateScenario
Implements
IDeepCloneable<SimulateScenario>
IBufferMessage
IMessage
Inherited Members

Constructors

SimulateScenario() 

public SimulateScenario()

SimulateScenario(SimulateScenario) 

public SimulateScenario(SimulateScenario other)

Parameters

other SimulateScenario

Fields

DisconnectSignalOnResumeFieldNumber

Field number for the "disconnect_signal_on_resume" field.

public const int DisconnectSignalOnResumeFieldNumber = 7

Field Value

int

DisconnectSignalOnResumeNoMessagesFieldNumber

Field number for the "disconnect_signal_on_resume_no_messages" field.

public const int DisconnectSignalOnResumeNoMessagesFieldNumber = 8

Field Value

int

LeaveRequestFullReconnectFieldNumber

Field number for the "leave_request_full_reconnect" field.

public const int LeaveRequestFullReconnectFieldNumber = 9

Field Value

int

MigrationFieldNumber

Field number for the "migration" field.

public const int MigrationFieldNumber = 3

Field Value

int

NodeFailureFieldNumber

Field number for the "node_failure" field.

public const int NodeFailureFieldNumber = 2

Field Value

int

ServerLeaveFieldNumber

Field number for the "server_leave" field.

public const int ServerLeaveFieldNumber = 4

Field Value

int

SpeakerUpdateFieldNumber

Field number for the "speaker_update" field.

public const int SpeakerUpdateFieldNumber = 1

Field Value

int

SubscriberBandwidthFieldNumber

Field number for the "subscriber_bandwidth" field.

public const int SubscriberBandwidthFieldNumber = 6

Field Value

int

SwitchCandidateProtocolFieldNumber

Field number for the "switch_candidate_protocol" field.

public const int SwitchCandidateProtocolFieldNumber = 5

Field Value

int

Properties

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

DisconnectSignalOnResume

disconnect signal on resume

public bool DisconnectSignalOnResume { get; set; }

Property Value

bool

DisconnectSignalOnResumeNoMessages

disconnect signal on resume before sending any messages from server

public bool DisconnectSignalOnResumeNoMessages { get; set; }

Property Value

bool

HasDisconnectSignalOnResume

Gets whether the "disconnect_signal_on_resume" field is set

public bool HasDisconnectSignalOnResume { get; }

Property Value

bool

HasDisconnectSignalOnResumeNoMessages

Gets whether the "disconnect_signal_on_resume_no_messages" field is set

public bool HasDisconnectSignalOnResumeNoMessages { get; }

Property Value

bool

HasLeaveRequestFullReconnect

Gets whether the "leave_request_full_reconnect" field is set

public bool HasLeaveRequestFullReconnect { get; }

Property Value

bool

HasMigration

Gets whether the "migration" field is set

public bool HasMigration { get; }

Property Value

bool

HasNodeFailure

Gets whether the "node_failure" field is set

public bool HasNodeFailure { get; }

Property Value

bool

HasServerLeave

Gets whether the "server_leave" field is set

public bool HasServerLeave { get; }

Property Value

bool

HasSpeakerUpdate

Gets whether the "speaker_update" field is set

public bool HasSpeakerUpdate { get; }

Property Value

bool

HasSubscriberBandwidth

Gets whether the "subscriber_bandwidth" field is set

public bool HasSubscriberBandwidth { get; }

Property Value

bool

HasSwitchCandidateProtocol

Gets whether the "switch_candidate_protocol" field is set

public bool HasSwitchCandidateProtocol { get; }

Property Value

bool

LeaveRequestFullReconnect

full reconnect leave request

public bool LeaveRequestFullReconnect { get; set; }

Property Value

bool

Migration

simulate migration

public bool Migration { get; set; }

Property Value

bool

NodeFailure

simulate local node failure

public bool NodeFailure { get; set; }

Property Value

bool

Parser 

public static MessageParser<SimulateScenario> Parser { get; }

Property Value

MessageParser<SimulateScenario>

ScenarioCase 

public SimulateScenario.ScenarioOneofCase ScenarioCase { get; }

Property Value

SimulateScenario.ScenarioOneofCase

ServerLeave

server to send leave

public bool ServerLeave { get; set; }

Property Value

bool

SpeakerUpdate

simulate N seconds of speaker activity

public int SpeakerUpdate { get; set; }

Property Value

int

SubscriberBandwidth

maximum bandwidth for subscribers, in bps when zero, clears artificial bandwidth limit

public long SubscriberBandwidth { get; set; }

Property Value

long

SwitchCandidateProtocol

switch candidate protocol to tcp

public CandidateProtocol SwitchCandidateProtocol { get; set; }

Property Value

CandidateProtocol

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.

ClearDisconnectSignalOnResume()

Clears the value of the oneof if it's currently set to "disconnect_signal_on_resume"

public void ClearDisconnectSignalOnResume()

ClearDisconnectSignalOnResumeNoMessages()

Clears the value of the oneof if it's currently set to "disconnect_signal_on_resume_no_messages"

public void ClearDisconnectSignalOnResumeNoMessages()

ClearLeaveRequestFullReconnect()

Clears the value of the oneof if it's currently set to "leave_request_full_reconnect"

public void ClearLeaveRequestFullReconnect()

ClearMigration()

Clears the value of the oneof if it's currently set to "migration"

public void ClearMigration()

ClearNodeFailure()

Clears the value of the oneof if it's currently set to "node_failure"

public void ClearNodeFailure()

ClearScenario() 

public void ClearScenario()

ClearServerLeave()

Clears the value of the oneof if it's currently set to "server_leave"

public void ClearServerLeave()

ClearSpeakerUpdate()

Clears the value of the oneof if it's currently set to "speaker_update"

public void ClearSpeakerUpdate()

ClearSubscriberBandwidth()

Clears the value of the oneof if it's currently set to "subscriber_bandwidth"

public void ClearSubscriberBandwidth()

ClearSwitchCandidateProtocol()

Clears the value of the oneof if it's currently set to "switch_candidate_protocol"

public void ClearSwitchCandidateProtocol()

Clone()

Creates a deep clone of this object.

public SimulateScenario Clone()

Returns

SimulateScenario

A deep clone of this object.

Equals(SimulateScenario) 

public bool Equals(SimulateScenario other)

Parameters

other SimulateScenario

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

Merges the given message into this one.

public void MergeFrom(SimulateScenario other)

Parameters

other SimulateScenario

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.

Edit this page