Table of Contents

Class SignalResponse

Namespace
LiveKit.Proto
Assembly
LiveKit.AspNetCore.ServerSdk.Abstractions.dll
public sealed class SignalResponse : IMessage<SignalResponse>, IEquatable<SignalResponse>, IDeepCloneable<SignalResponse>, IBufferMessage, IMessage
Inheritance
SignalResponse
Implements
IMessage<SignalResponse>
IDeepCloneable<SignalResponse>
IBufferMessage
IMessage
Inherited Members

Constructors

SignalResponse() 

public SignalResponse()

SignalResponse(SignalResponse) 

public SignalResponse(SignalResponse other)

Parameters

other SignalResponse

Fields

AnswerFieldNumber

Field number for the "answer" field.

public const int AnswerFieldNumber = 2

Field Value

int

ConnectionQualityFieldNumber

Field number for the "connection_quality" field.

public const int ConnectionQualityFieldNumber = 12

Field Value

int

DataTrackSubscriberHandlesFieldNumber

Field number for the "data_track_subscriber_handles" field.

public const int DataTrackSubscriberHandlesFieldNumber = 29

Field Value

int

JoinFieldNumber

Field number for the "join" field.

public const int JoinFieldNumber = 1

Field Value

int

LeaveFieldNumber

Field number for the "leave" field.

public const int LeaveFieldNumber = 8

Field Value

int

MediaSectionsRequirementFieldNumber

Field number for the "media_sections_requirement" field.

public const int MediaSectionsRequirementFieldNumber = 25

Field Value

int

MuteFieldNumber

Field number for the "mute" field.

public const int MuteFieldNumber = 9

Field Value

int

OfferFieldNumber

Field number for the "offer" field.

public const int OfferFieldNumber = 3

Field Value

int

PongFieldNumber

Field number for the "pong" field.

public const int PongFieldNumber = 18

Field Value

int

PongRespFieldNumber

Field number for the "pong_resp" field.

public const int PongRespFieldNumber = 20

Field Value

int

PublishDataTrackResponseFieldNumber

Field number for the "publish_data_track_response" field.

public const int PublishDataTrackResponseFieldNumber = 27

Field Value

int

ReconnectFieldNumber

Field number for the "reconnect" field.

public const int ReconnectFieldNumber = 19

Field Value

int

RefreshTokenFieldNumber

Field number for the "refresh_token" field.

public const int RefreshTokenFieldNumber = 16

Field Value

int

RequestResponseFieldNumber

Field number for the "request_response" field.

public const int RequestResponseFieldNumber = 22

Field Value

int

RoomMovedFieldNumber

Field number for the "room_moved" field.

public const int RoomMovedFieldNumber = 24

Field Value

int

RoomUpdateFieldNumber

Field number for the "room_update" field.

public const int RoomUpdateFieldNumber = 11

Field Value

int

SpeakersChangedFieldNumber

Field number for the "speakers_changed" field.

public const int SpeakersChangedFieldNumber = 10

Field Value

int

StreamStateUpdateFieldNumber

Field number for the "stream_state_update" field.

public const int StreamStateUpdateFieldNumber = 13

Field Value

int

SubscribedAudioCodecUpdateFieldNumber

Field number for the "subscribed_audio_codec_update" field.

public const int SubscribedAudioCodecUpdateFieldNumber = 26

Field Value

int

SubscribedQualityUpdateFieldNumber

Field number for the "subscribed_quality_update" field.

public const int SubscribedQualityUpdateFieldNumber = 14

Field Value

int

SubscriptionPermissionUpdateFieldNumber

Field number for the "subscription_permission_update" field.

public const int SubscriptionPermissionUpdateFieldNumber = 15

Field Value

int

SubscriptionResponseFieldNumber

Field number for the "subscription_response" field.

public const int SubscriptionResponseFieldNumber = 21

Field Value

int

TrackPublishedFieldNumber

Field number for the "track_published" field.

public const int TrackPublishedFieldNumber = 6

Field Value

int

TrackSubscribedFieldNumber

Field number for the "track_subscribed" field.

public const int TrackSubscribedFieldNumber = 23

Field Value

int

TrackUnpublishedFieldNumber

Field number for the "track_unpublished" field.

public const int TrackUnpublishedFieldNumber = 17

Field Value

int

TrickleFieldNumber

Field number for the "trickle" field.

public const int TrickleFieldNumber = 4

Field Value

int

UnpublishDataTrackResponseFieldNumber

Field number for the "unpublish_data_track_response" field.

public const int UnpublishDataTrackResponseFieldNumber = 28

Field Value

int

UpdateFieldNumber

Field number for the "update" field.

public const int UpdateFieldNumber = 5

Field Value

int

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

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

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

Parser 

public static MessageParser<SignalResponse> Parser { get; }

Property Value

MessageParser<SignalResponse>

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

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

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

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

Clone()

Creates a deep clone of this object.

public SignalResponse Clone()

Returns

SignalResponse

A deep clone of this object.

Equals(SignalResponse) 

public bool Equals(SignalResponse other)

Parameters

other SignalResponse

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

Merges the given message into this one.

public void MergeFrom(SignalResponse other)

Parameters

other SignalResponse

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.

Edit this page