Class SignalRequest

Namespace

Livekit.Server.Sdk.Dotnet

Assembly

LivekitApi.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.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SignalRequest()

public SignalRequest()

SignalRequest(SignalRequest)

public SignalRequest(SignalRequest other)

Parameters

other SignalRequest

Properties

AddTrack

public AddTrackRequest AddTrack { get; set; }

Property Value

AddTrackRequest

Answer

participant answering subscriber offer

public SessionDescription Answer { get; set; }

Property Value

SessionDescription

GetDataBlobRequest

Retrieve a stored data blob.

public GetDataBlobRequest GetDataBlobRequest { get; set; }

Property Value

GetDataBlobRequest

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

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

StoreDataBlobRequest

Store a data blob.

public StoreDataBlobRequest StoreDataBlobRequest { get; set; }

Property Value

StoreDataBlobRequest

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

ClearMessage()

public void ClearMessage()

ClearPing()

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

public void ClearPing()