Class SimulateScenario

Inheritance
object
SimulateScenario
Implements
IDeepCloneable<SimulateScenario>
IBufferMessage
IMessage
Inherited Members
Namespace: LiveKit.Proto
Assembly: Uniform.LiveKit.Protocol.dll
Syntax
public sealed class SimulateScenario : IMessage<SimulateScenario>, IEquatable<SimulateScenario>, IDeepCloneable<SimulateScenario>, IBufferMessage, IMessage

Constructors

SimulateScenario()

Declaration
public SimulateScenario()

SimulateScenario(SimulateScenario)

Declaration
public SimulateScenario(SimulateScenario other)
Parameters
Type Name Description
SimulateScenario other

Fields

DisconnectSignalOnResumeFieldNumber

Field number for the "disconnect_signal_on_resume" field.

Declaration
public const int DisconnectSignalOnResumeFieldNumber = 7
Field Value
Type Description
int

DisconnectSignalOnResumeNoMessagesFieldNumber

Field number for the "disconnect_signal_on_resume_no_messages" field.

Declaration
public const int DisconnectSignalOnResumeNoMessagesFieldNumber = 8
Field Value
Type Description
int

LeaveRequestFullReconnectFieldNumber

Field number for the "leave_request_full_reconnect" field.

Declaration
public const int LeaveRequestFullReconnectFieldNumber = 9
Field Value
Type Description
int

MigrationFieldNumber

Field number for the "migration" field.

Declaration
public const int MigrationFieldNumber = 3
Field Value
Type Description
int

NodeFailureFieldNumber

Field number for the "node_failure" field.

Declaration
public const int NodeFailureFieldNumber = 2
Field Value
Type Description
int

ServerLeaveFieldNumber

Field number for the "server_leave" field.

Declaration
public const int ServerLeaveFieldNumber = 4
Field Value
Type Description
int

SpeakerUpdateFieldNumber

Field number for the "speaker_update" field.

Declaration
public const int SpeakerUpdateFieldNumber = 1
Field Value
Type Description
int

SubscriberBandwidthFieldNumber

Field number for the "subscriber_bandwidth" field.

Declaration
public const int SubscriberBandwidthFieldNumber = 6
Field Value
Type Description
int

SwitchCandidateProtocolFieldNumber

Field number for the "switch_candidate_protocol" field.

Declaration
public const int SwitchCandidateProtocolFieldNumber = 5
Field Value
Type Description
int

Properties

Descriptor

Declaration
public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

DisconnectSignalOnResume

disconnect signal on resume

Declaration
public bool DisconnectSignalOnResume { get; set; }
Property Value
Type Description
bool

DisconnectSignalOnResumeNoMessages

disconnect signal on resume before sending any messages from server

Declaration
public bool DisconnectSignalOnResumeNoMessages { get; set; }
Property Value
Type Description
bool

HasDisconnectSignalOnResume

Gets whether the "disconnect_signal_on_resume" field is set

Declaration
public bool HasDisconnectSignalOnResume { get; }
Property Value
Type Description
bool

HasDisconnectSignalOnResumeNoMessages

Gets whether the "disconnect_signal_on_resume_no_messages" field is set

Declaration
public bool HasDisconnectSignalOnResumeNoMessages { get; }
Property Value
Type Description
bool

HasLeaveRequestFullReconnect

Gets whether the "leave_request_full_reconnect" field is set

Declaration
public bool HasLeaveRequestFullReconnect { get; }
Property Value
Type Description
bool

HasMigration

Gets whether the "migration" field is set

Declaration
public bool HasMigration { get; }
Property Value
Type Description
bool

HasNodeFailure

Gets whether the "node_failure" field is set

Declaration
public bool HasNodeFailure { get; }
Property Value
Type Description
bool

HasServerLeave

Gets whether the "server_leave" field is set

Declaration
public bool HasServerLeave { get; }
Property Value
Type Description
bool

HasSpeakerUpdate

Gets whether the "speaker_update" field is set

Declaration
public bool HasSpeakerUpdate { get; }
Property Value
Type Description
bool

HasSubscriberBandwidth

Gets whether the "subscriber_bandwidth" field is set

Declaration
public bool HasSubscriberBandwidth { get; }
Property Value
Type Description
bool

HasSwitchCandidateProtocol

Gets whether the "switch_candidate_protocol" field is set

Declaration
public bool HasSwitchCandidateProtocol { get; }
Property Value
Type Description
bool

LeaveRequestFullReconnect

full reconnect leave request

Declaration
public bool LeaveRequestFullReconnect { get; set; }
Property Value
Type Description
bool

Migration

simulate migration

Declaration
public bool Migration { get; set; }
Property Value
Type Description
bool

NodeFailure

simulate local node failure

Declaration
public bool NodeFailure { get; set; }
Property Value
Type Description
bool

Parser

Declaration
public static MessageParser<SimulateScenario> Parser { get; }
Property Value
Type Description
MessageParser<SimulateScenario>

ScenarioCase

Declaration
public SimulateScenario.ScenarioOneofCase ScenarioCase { get; }
Property Value
Type Description
SimulateScenario.ScenarioOneofCase

ServerLeave

server to send leave

Declaration
public bool ServerLeave { get; set; }
Property Value
Type Description
bool

SpeakerUpdate

simulate N seconds of speaker activity

Declaration
public int SpeakerUpdate { get; set; }
Property Value
Type Description
int

SubscriberBandwidth

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

Declaration
public long SubscriberBandwidth { get; set; }
Property Value
Type Description
long

SwitchCandidateProtocol

switch candidate protocol to tcp

Declaration
public CandidateProtocol SwitchCandidateProtocol { get; set; }
Property Value
Type Description
CandidateProtocol

Methods

CalculateSize()

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

Declaration
public int CalculateSize()
Returns
Type Description
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"

Declaration
public void ClearDisconnectSignalOnResume()

ClearDisconnectSignalOnResumeNoMessages()

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

Declaration
public void ClearDisconnectSignalOnResumeNoMessages()

ClearLeaveRequestFullReconnect()

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

Declaration
public void ClearLeaveRequestFullReconnect()

ClearMigration()

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

Declaration
public void ClearMigration()

ClearNodeFailure()

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

Declaration
public void ClearNodeFailure()

ClearScenario()

Declaration
public void ClearScenario()

ClearServerLeave()

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

Declaration
public void ClearServerLeave()

ClearSpeakerUpdate()

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

Declaration
public void ClearSpeakerUpdate()

ClearSubscriberBandwidth()

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

Declaration
public void ClearSubscriberBandwidth()

ClearSwitchCandidateProtocol()

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

Declaration
public void ClearSwitchCandidateProtocol()

Clone()

Creates a deep clone of this object.

Declaration
public SimulateScenario Clone()
Returns
Type Description
SimulateScenario

A deep clone of this object.

Equals(SimulateScenario)

Indicates whether the current object is equal to another object of the same type.

Declaration
public bool Equals(SimulateScenario other)
Parameters
Type Name Description
SimulateScenario other

An object to compare with this object.
Returns
Type Description
bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
object other
Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.
Overrides

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides

MergeFrom(CodedInputStream)

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

Declaration
public void MergeFrom(CodedInputStream input)
Parameters
Type Name Description
CodedInputStream input
Remarks

See the user guide for precise merge semantics.

MergeFrom(SimulateScenario)

Merges the given message into this one.

Declaration
public void MergeFrom(SimulateScenario other)
Parameters
Type Name Description
SimulateScenario other
Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents the current object.
Overrides

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

Declaration
public void WriteTo(CodedOutputStream output)
Parameters
Type Name Description
CodedOutputStream output

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

Implements

Google.Protobuf.IMessage<T>
Google.Protobuf.IDeepCloneable<T>
Google.Protobuf.IBufferMessage
Google.Protobuf.IMessage