Table of Contents

Class SignalResponse

Namespace
Livekit.Server.Sdk.Dotnet
Assembly
LivekitApi.dll
public sealed class SignalResponse : IMessage<SignalResponse>, IEquatable<SignalResponse>, IDeepCloneable<SignalResponse>, IBufferMessage, IMessage
Inheritance
SignalResponse
Implements
IBufferMessage
Inherited Members

Constructors

SignalResponse() 

public SignalResponse()

SignalResponse(SignalResponse) 

public SignalResponse(SignalResponse other)

Parameters

other SignalResponse

Properties

Answer

sent when server answers publisher

public SessionDescription Answer { get; set; }

Property Value

SessionDescription

ConnectionQuality

when connection quality changed

public ConnectionQualityUpdate ConnectionQuality { get; set; }

Property Value

ConnectionQualityUpdate

DataTrackSubscriberHandles

Sent to data track subscribers to provide mapping from track SIDs to handles.

public DataTrackSubscriberHandles DataTrackSubscriberHandles { get; set; }

Property Value

DataTrackSubscriberHandles

GetDataBlobResponse

Sent in response to GetDataBlobRequest.

public GetDataBlobResponse GetDataBlobResponse { get; set; }

Property Value

GetDataBlobResponse

HasPong

Gets whether the "pong" field is set

public bool HasPong { get; }

Property Value

bool

HasRefreshToken

Gets whether the "refresh_token" field is set

public bool HasRefreshToken { get; }

Property Value

bool

Join

sent when join is accepted

public JoinResponse Join { get; set; }

Property Value

JoinResponse

Leave

Immediately terminate session

public LeaveRequest Leave { get; set; }

Property Value

LeaveRequest

MediaSectionsRequirement

notify number of required media sections to satisfy subscribed tracks

public MediaSectionsRequirement MediaSectionsRequirement { get; set; }

Property Value

MediaSectionsRequirement

MessageCase 

public SignalResponse.MessageOneofCase MessageCase { get; }

Property Value

SignalResponse.MessageOneofCase

Mute

server initiated mute

public MuteTrackRequest Mute { get; set; }

Property Value

MuteTrackRequest

Offer

sent when server is sending subscriber an offer

public SessionDescription Offer { get; set; }

Property Value

SessionDescription

Pong

respond to ping

public long Pong { get; set; }

Property Value

long

PongResp

respond to Ping

public Pong PongResp { get; set; }

Property Value

Pong

PublishDataTrackResponse

Sent in response to PublishDataTrackRequest.

public PublishDataTrackResponse PublishDataTrackResponse { get; set; }

Property Value

PublishDataTrackResponse

Reconnect

sent when client reconnects

public ReconnectResponse Reconnect { get; set; }

Property Value

ReconnectResponse

RefreshToken

update the token the client was using, to prevent an active client from using an expired token

public string RefreshToken { get; set; }

Property Value

string

RequestResponse

Response relating to user inititated requests that carry a request_id

public RequestResponse RequestResponse { get; set; }

Property Value

RequestResponse

RoomMoved

notify to the participant when they have been moved to a new room

public RoomMovedResponse RoomMoved { get; set; }

Property Value

RoomMovedResponse

RoomUpdate

sent when metadata of the room has changed

public RoomUpdate RoomUpdate { get; set; }

Property Value

RoomUpdate

SpeakersChanged

indicates changes to speaker status, including when they've gone to not speaking

public SpeakersChanged SpeakersChanged { get; set; }

Property Value

SpeakersChanged

StoreDataBlobResponse

Sent in response to StoreDataBlobRequest.

public StoreDataBlobResponse StoreDataBlobResponse { get; set; }

Property Value

StoreDataBlobResponse

StreamStateUpdate

when streamed tracks state changed, used to notify when any of the streams were paused due to congestion

public StreamStateUpdate StreamStateUpdate { get; set; }

Property Value

StreamStateUpdate

SubscribedAudioCodecUpdate

when audio subscription changes, used to enable simulcasting of audio codecs based on subscriptions

public SubscribedAudioCodecUpdate SubscribedAudioCodecUpdate { get; set; }

Property Value

SubscribedAudioCodecUpdate

SubscribedQualityUpdate

when max subscribe quality changed, used by dynamic broadcasting to disable unused layers

public SubscribedQualityUpdate SubscribedQualityUpdate { get; set; }

Property Value

SubscribedQualityUpdate

SubscriptionPermissionUpdate

when subscription permission changed

public SubscriptionPermissionUpdate SubscriptionPermissionUpdate { get; set; }

Property Value

SubscriptionPermissionUpdate

SubscriptionResponse

Subscription response, client should not expect any media from this subscription if it fails

public SubscriptionResponse SubscriptionResponse { get; set; }

Property Value

SubscriptionResponse

TrackPublished

sent to the participant when their track has been published

public TrackPublishedResponse TrackPublished { get; set; }

Property Value

TrackPublishedResponse

TrackSubscribed

notify to the publisher when a published track has been subscribed for the first time

public TrackSubscribed TrackSubscribed { get; set; }

Property Value

TrackSubscribed

TrackUnpublished

server initiated track unpublish

public TrackUnpublishedResponse TrackUnpublished { get; set; }

Property Value

TrackUnpublishedResponse

Trickle

sent when an ICE candidate is available

public TrickleRequest Trickle { get; set; }

Property Value

TrickleRequest

UnpublishDataTrackResponse

Sent in response to UnpublishDataTrackRequest or SFU-initiated unpublish.

public UnpublishDataTrackResponse UnpublishDataTrackResponse { get; set; }

Property Value

UnpublishDataTrackResponse

Update

sent when participants in the room has changed

public ParticipantUpdate Update { get; set; }

Property Value

ParticipantUpdate

Methods

ClearMessage() 

public void ClearMessage()

ClearPong()

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

public void ClearPong()

ClearRefreshToken()

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

public void ClearRefreshToken()
Edit this page