Class SignalRequest

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

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

Inheritance

object

SignalRequest

Implements

IMessage<SignalRequest>

IEquatable<SignalRequest>

IDeepCloneable<SignalRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SignalRequest()

public SignalRequest()

SignalRequest(SignalRequest)

public SignalRequest(SignalRequest other)

Parameters

other SignalRequest

Fields

AddTrackFieldNumber

Field number for the "add_track" field.

public const int AddTrackFieldNumber = 4

Field Value

int

AnswerFieldNumber

Field number for the "answer" field.

public const int AnswerFieldNumber = 2

Field Value

int

LeaveFieldNumber

Field number for the "leave" field.

public const int LeaveFieldNumber = 8

Field Value

int

MuteFieldNumber

Field number for the "mute" field.

public const int MuteFieldNumber = 5

Field Value

int

OfferFieldNumber

Field number for the "offer" field.

public const int OfferFieldNumber = 1

Field Value

int

PingFieldNumber

Field number for the "ping" field.

public const int PingFieldNumber = 14

Field Value

int

PingReqFieldNumber

Field number for the "ping_req" field.

public const int PingReqFieldNumber = 16

Field Value

int

PublishDataTrackRequestFieldNumber

Field number for the "publish_data_track_request" field.

public const int PublishDataTrackRequestFieldNumber = 19

Field Value

int

SimulateFieldNumber

Field number for the "simulate" field.

public const int SimulateFieldNumber = 13

Field Value

int

SubscriptionFieldNumber

Field number for the "subscription" field.

public const int SubscriptionFieldNumber = 6

Field Value

int

SubscriptionPermissionFieldNumber

Field number for the "subscription_permission" field.

public const int SubscriptionPermissionFieldNumber = 11

Field Value

int

SyncStateFieldNumber

Field number for the "sync_state" field.

public const int SyncStateFieldNumber = 12

Field Value

int

TrackSettingFieldNumber

Field number for the "track_setting" field.

public const int TrackSettingFieldNumber = 7

Field Value

int

TrickleFieldNumber

Field number for the "trickle" field.

public const int TrickleFieldNumber = 3

Field Value

int

UnpublishDataTrackRequestFieldNumber

Field number for the "unpublish_data_track_request" field.

public const int UnpublishDataTrackRequestFieldNumber = 20

Field Value

int

UpdateAudioTrackFieldNumber

Field number for the "update_audio_track" field.

public const int UpdateAudioTrackFieldNumber = 17

Field Value

int

UpdateDataSubscriptionFieldNumber

Field number for the "update_data_subscription" field.

public const int UpdateDataSubscriptionFieldNumber = 21

Field Value

int

UpdateLayersFieldNumber

Field number for the "update_layers" field.

public const int UpdateLayersFieldNumber = 10

Field Value

int

UpdateMetadataFieldNumber

Field number for the "update_metadata" field.

public const int UpdateMetadataFieldNumber = 15

Field Value

int

UpdateVideoTrackFieldNumber

Field number for the "update_video_track" field.

public const int UpdateVideoTrackFieldNumber = 18

Field Value

int

Properties

AddTrack

public AddTrackRequest AddTrack { get; set; }

Property Value

AddTrackRequest

Answer

participant answering subscriber offer

public SessionDescription Answer { get; set; }

Property Value

SessionDescription

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

HasPing

Gets whether the "ping" field is set

public bool HasPing { get; }

Property Value

bool

Leave

Immediately terminate session

public LeaveRequest Leave { get; set; }

Property Value

LeaveRequest

MessageCase

public SignalRequest.MessageOneofCase MessageCase { get; }

Property Value

SignalRequest.MessageOneofCase

Mute

mute the participant's published tracks

public MuteTrackRequest Mute { get; set; }

Property Value

MuteTrackRequest

Offer

participant offer for publisher

public SessionDescription Offer { get; set; }

Property Value

SessionDescription

Parser

public static MessageParser<SignalRequest> Parser { get; }

Property Value

MessageParser<SignalRequest>

Ping

client triggered ping to server

public long Ping { get; set; }

Property Value

long

PingReq

public Ping PingReq { get; set; }

Property Value

Ping

PublishDataTrackRequest

Publish a data track

public PublishDataTrackRequest PublishDataTrackRequest { get; set; }

Property Value

PublishDataTrackRequest

Simulate

Simulate conditions, for client validations

public SimulateScenario Simulate { get; set; }

Property Value

SimulateScenario

Subscription

Subscribe or unsubscribe from tracks

public UpdateSubscription Subscription { get; set; }

Property Value

UpdateSubscription

SubscriptionPermission

Update subscriber permissions

public SubscriptionPermission SubscriptionPermission { get; set; }

Property Value

SubscriptionPermission

SyncState

sync client's subscribe state to server during reconnect

public SyncState SyncState { get; set; }

Property Value

SyncState

TrackSetting

Update settings of subscribed tracks

public UpdateTrackSettings TrackSetting { get; set; }

Property Value

UpdateTrackSettings

Trickle

public TrickleRequest Trickle { get; set; }

Property Value

TrickleRequest

UnpublishDataTrackRequest

Unpublish a data track

public UnpublishDataTrackRequest UnpublishDataTrackRequest { get; set; }

Property Value

UnpublishDataTrackRequest

UpdateAudioTrack

Update local audio track settings

public UpdateLocalAudioTrack UpdateAudioTrack { get; set; }

Property Value

UpdateLocalAudioTrack

UpdateDataSubscription

Update subscription state for one or more data tracks

public UpdateDataSubscription UpdateDataSubscription { get; set; }

Property Value

UpdateDataSubscription

UpdateLayers

Update published video layers

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

Property Value

UpdateVideoLayers

UpdateMetadata

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

public UpdateParticipantMetadata UpdateMetadata { get; set; }

Property Value

UpdateParticipantMetadata

UpdateVideoTrack

Update local video track settings

public UpdateLocalVideoTrack UpdateVideoTrack { get; set; }

Property Value

UpdateLocalVideoTrack

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.

ClearMessage()

public void ClearMessage()

ClearPing()

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

public void ClearPing()

Clone()

Creates a deep clone of this object.

public SignalRequest Clone()

Returns

SignalRequest

A deep clone of this object.

Equals(SignalRequest)

public bool Equals(SignalRequest other)

Parameters

other SignalRequest

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

Merges the given message into this one.

public void MergeFrom(SignalRequest other)

Parameters

other SignalRequest

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.