Class SignalRequest

Inheritance

object

SignalRequest

Implements

IMessage<SignalRequest>

IEquatable<SignalRequest>

IDeepCloneable<SignalRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: LiveKit.Proto

Assembly: Uniform.LiveKit.Protocol.dll

Syntax

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

Constructors

SignalRequest()

Declaration

public SignalRequest()

SignalRequest(SignalRequest)

Declaration

public SignalRequest(SignalRequest other)

Parameters

Type	Name	Description
SignalRequest	other

Fields

AddTrackFieldNumber

Field number for the "add_track" field.

Declaration

public const int AddTrackFieldNumber = 4

Field Value

Type	Description
int

AnswerFieldNumber

Field number for the "answer" field.

Declaration

public const int AnswerFieldNumber = 2

Field Value

Type	Description
int

GetDataBlobRequestFieldNumber

Field number for the "get_data_blob_request" field.

Declaration

public const int GetDataBlobRequestFieldNumber = 23

Field Value

Type	Description
int

LeaveFieldNumber

Field number for the "leave" field.

Declaration

public const int LeaveFieldNumber = 8

Field Value

Type	Description
int

MuteFieldNumber

Field number for the "mute" field.

Declaration

public const int MuteFieldNumber = 5

Field Value

Type	Description
int

OfferFieldNumber

Field number for the "offer" field.

Declaration

public const int OfferFieldNumber = 1

Field Value

Type	Description
int

PingFieldNumber

Field number for the "ping" field.

Declaration

public const int PingFieldNumber = 14

Field Value

Type	Description
int

PingReqFieldNumber

Field number for the "ping_req" field.

Declaration

public const int PingReqFieldNumber = 16

Field Value

Type	Description
int

PublishDataTrackRequestFieldNumber

Field number for the "publish_data_track_request" field.

Declaration

public const int PublishDataTrackRequestFieldNumber = 19

Field Value

Type	Description
int

SimulateFieldNumber

Field number for the "simulate" field.

Declaration

public const int SimulateFieldNumber = 13

Field Value

Type	Description
int

StoreDataBlobRequestFieldNumber

Field number for the "store_data_blob_request" field.

Declaration

public const int StoreDataBlobRequestFieldNumber = 22

Field Value

Type	Description
int

SubscriptionFieldNumber

Field number for the "subscription" field.

Declaration

public const int SubscriptionFieldNumber = 6

Field Value

Type	Description
int

SubscriptionPermissionFieldNumber

Field number for the "subscription_permission" field.

Declaration

public const int SubscriptionPermissionFieldNumber = 11

Field Value

Type	Description
int

SyncStateFieldNumber

Field number for the "sync_state" field.

Declaration

public const int SyncStateFieldNumber = 12

Field Value

Type	Description
int

TrackSettingFieldNumber

Field number for the "track_setting" field.

Declaration

public const int TrackSettingFieldNumber = 7

Field Value

Type	Description
int

TrickleFieldNumber

Field number for the "trickle" field.

Declaration

public const int TrickleFieldNumber = 3

Field Value

Type	Description
int

UnpublishDataTrackRequestFieldNumber

Field number for the "unpublish_data_track_request" field.

Declaration

public const int UnpublishDataTrackRequestFieldNumber = 20

Field Value

Type	Description
int

UpdateAudioTrackFieldNumber

Field number for the "update_audio_track" field.

Declaration

public const int UpdateAudioTrackFieldNumber = 17

Field Value

Type	Description
int

UpdateDataSubscriptionFieldNumber

Field number for the "update_data_subscription" field.

Declaration

public const int UpdateDataSubscriptionFieldNumber = 21

Field Value

Type	Description
int

UpdateLayersFieldNumber

Field number for the "update_layers" field.

Declaration

public const int UpdateLayersFieldNumber = 10

Field Value

Type	Description
int

UpdateMetadataFieldNumber

Field number for the "update_metadata" field.

Declaration

public const int UpdateMetadataFieldNumber = 15

Field Value

Type	Description
int

UpdateVideoTrackFieldNumber

Field number for the "update_video_track" field.

Declaration

public const int UpdateVideoTrackFieldNumber = 18

Field Value

Type	Description
int

Properties

AddTrack

Declaration

public AddTrackRequest AddTrack { get; set; }

Property Value

Type	Description
AddTrackRequest

Answer

participant answering subscriber offer

Declaration

public SessionDescription Answer { get; set; }

Property Value

Type	Description
SessionDescription

Descriptor

Declaration

public static MessageDescriptor Descriptor { get; }

Property Value

Type	Description
MessageDescriptor

GetDataBlobRequest

Retrieve a stored data blob.

Declaration

public GetDataBlobRequest GetDataBlobRequest { get; set; }

Property Value

Type	Description
GetDataBlobRequest

HasPing

Gets whether the "ping" field is set

Declaration

public bool HasPing { get; }

Property Value

Type	Description
bool

Leave

Immediately terminate session

Declaration

public LeaveRequest Leave { get; set; }

Property Value

Type	Description
LeaveRequest

MessageCase

Declaration

public SignalRequest.MessageOneofCase MessageCase { get; }

Property Value

Type	Description
SignalRequest.MessageOneofCase

Mute

mute the participant's published tracks

Declaration

public MuteTrackRequest Mute { get; set; }

Property Value

Type	Description
MuteTrackRequest

Offer

participant offer for publisher

Declaration

public SessionDescription Offer { get; set; }

Property Value

Type	Description
SessionDescription

Parser

Declaration

public static MessageParser<SignalRequest> Parser { get; }

Property Value

Type	Description
MessageParser<SignalRequest>

Ping

client triggered ping to server

Declaration

public long Ping { get; set; }

Property Value

Type	Description
long

PingReq

Declaration

public Ping PingReq { get; set; }

Property Value

Type	Description
Ping

PublishDataTrackRequest

Publish a data track

Declaration

public PublishDataTrackRequest PublishDataTrackRequest { get; set; }

Property Value

Type	Description
PublishDataTrackRequest

Simulate

Simulate conditions, for client validations

Declaration

public SimulateScenario Simulate { get; set; }

Property Value

Type	Description
SimulateScenario

StoreDataBlobRequest

Store a data blob.

Declaration

public StoreDataBlobRequest StoreDataBlobRequest { get; set; }

Property Value

Type	Description
StoreDataBlobRequest

Subscription

Subscribe or unsubscribe from tracks

Declaration

public UpdateSubscription Subscription { get; set; }

Property Value

Type	Description
UpdateSubscription

SubscriptionPermission

Update subscriber permissions

Declaration

public SubscriptionPermission SubscriptionPermission { get; set; }

Property Value

Type	Description
SubscriptionPermission

SyncState

sync client's subscribe state to server during reconnect

Declaration

public SyncState SyncState { get; set; }

Property Value

Type	Description
SyncState

TrackSetting

Update settings of subscribed tracks

Declaration

public UpdateTrackSettings TrackSetting { get; set; }

Property Value

Type	Description
UpdateTrackSettings

Trickle

Declaration

public TrickleRequest Trickle { get; set; }

Property Value

Type	Description
TrickleRequest

UnpublishDataTrackRequest

Unpublish a data track

Declaration

public UnpublishDataTrackRequest UnpublishDataTrackRequest { get; set; }

Property Value

Type	Description
UnpublishDataTrackRequest

UpdateAudioTrack

Update local audio track settings

Declaration

public UpdateLocalAudioTrack UpdateAudioTrack { get; set; }

Property Value

Type	Description
UpdateLocalAudioTrack

UpdateDataSubscription

Update subscription state for one or more data tracks

Declaration

public UpdateDataSubscription UpdateDataSubscription { get; set; }

Property Value

Type	Description
UpdateDataSubscription

UpdateLayers

Update published video layers

Declaration

[Obsolete]
public UpdateVideoLayers UpdateLayers { get; set; }

Property Value

Type	Description
UpdateVideoLayers

UpdateMetadata

update a participant's own metadata, name, or attributes requires canUpdateOwnParticipantMetadata permission

Declaration

public UpdateParticipantMetadata UpdateMetadata { get; set; }

Property Value

Type	Description
UpdateParticipantMetadata

UpdateVideoTrack

Update local video track settings

Declaration

public UpdateLocalVideoTrack UpdateVideoTrack { get; set; }

Property Value

Type	Description
UpdateLocalVideoTrack

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.

ClearMessage()

Declaration

public void ClearMessage()

ClearPing()

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

Declaration

public void ClearPing()

Clone()

Creates a deep clone of this object.

Declaration

public SignalRequest Clone()

Returns

Type	Description
SignalRequest	A deep clone of this object.

Equals(SignalRequest)

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

Declaration

public bool Equals(SignalRequest other)

Parameters

Type	Name	Description
SignalRequest	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

object.Equals(object)

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()

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

Merges the given message into this one.

Declaration

public void MergeFrom(SignalRequest other)

Parameters

Type	Name	Description
SignalRequest	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

object.ToString()

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>

IEquatable<T>

Google.Protobuf.IDeepCloneable<T>

Google.Protobuf.IBufferMessage

Google.Protobuf.IMessage