Class SignalResponse

Inheritance

object

SignalResponse

Implements

IMessage<SignalResponse>

IEquatable<SignalResponse>

IDeepCloneable<SignalResponse>

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 SignalResponse : IMessage<SignalResponse>, IEquatable<SignalResponse>, IDeepCloneable<SignalResponse>, IBufferMessage, IMessage

Constructors

SignalResponse()

Declaration

public SignalResponse()

SignalResponse(SignalResponse)

Declaration

public SignalResponse(SignalResponse other)

Parameters

Type	Name	Description
SignalResponse	other

Fields

AnswerFieldNumber

Field number for the "answer" field.

Declaration

public const int AnswerFieldNumber = 2

Field Value

Type	Description
int

ConnectionQualityFieldNumber

Field number for the "connection_quality" field.

Declaration

public const int ConnectionQualityFieldNumber = 12

Field Value

Type	Description
int

DataTrackSubscriberHandlesFieldNumber

Field number for the "data_track_subscriber_handles" field.

Declaration

public const int DataTrackSubscriberHandlesFieldNumber = 29

Field Value

Type	Description
int

GetDataBlobResponseFieldNumber

Field number for the "get_data_blob_response" field.

Declaration

public const int GetDataBlobResponseFieldNumber = 31

Field Value

Type	Description
int

JoinFieldNumber

Field number for the "join" field.

Declaration

public const int JoinFieldNumber = 1

Field Value

Type	Description
int

LeaveFieldNumber

Field number for the "leave" field.

Declaration

public const int LeaveFieldNumber = 8

Field Value

Type	Description
int

MediaSectionsRequirementFieldNumber

Field number for the "media_sections_requirement" field.

Declaration

public const int MediaSectionsRequirementFieldNumber = 25

Field Value

Type	Description
int

MuteFieldNumber

Field number for the "mute" field.

Declaration

public const int MuteFieldNumber = 9

Field Value

Type	Description
int

OfferFieldNumber

Field number for the "offer" field.

Declaration

public const int OfferFieldNumber = 3

Field Value

Type	Description
int

PongFieldNumber

Field number for the "pong" field.

Declaration

public const int PongFieldNumber = 18

Field Value

Type	Description
int

PongRespFieldNumber

Field number for the "pong_resp" field.

Declaration

public const int PongRespFieldNumber = 20

Field Value

Type	Description
int

PublishDataTrackResponseFieldNumber

Field number for the "publish_data_track_response" field.

Declaration

public const int PublishDataTrackResponseFieldNumber = 27

Field Value

Type	Description
int

ReconnectFieldNumber

Field number for the "reconnect" field.

Declaration

public const int ReconnectFieldNumber = 19

Field Value

Type	Description
int

RefreshTokenFieldNumber

Field number for the "refresh_token" field.

Declaration

public const int RefreshTokenFieldNumber = 16

Field Value

Type	Description
int

RequestResponseFieldNumber

Field number for the "request_response" field.

Declaration

public const int RequestResponseFieldNumber = 22

Field Value

Type	Description
int

RoomMovedFieldNumber

Field number for the "room_moved" field.

Declaration

public const int RoomMovedFieldNumber = 24

Field Value

Type	Description
int

RoomUpdateFieldNumber

Field number for the "room_update" field.

Declaration

public const int RoomUpdateFieldNumber = 11

Field Value

Type	Description
int

SpeakersChangedFieldNumber

Field number for the "speakers_changed" field.

Declaration

public const int SpeakersChangedFieldNumber = 10

Field Value

Type	Description
int

StoreDataBlobResponseFieldNumber

Field number for the "store_data_blob_response" field.

Declaration

public const int StoreDataBlobResponseFieldNumber = 30

Field Value

Type	Description
int

StreamStateUpdateFieldNumber

Field number for the "stream_state_update" field.

Declaration

public const int StreamStateUpdateFieldNumber = 13

Field Value

Type	Description
int

SubscribedAudioCodecUpdateFieldNumber

Field number for the "subscribed_audio_codec_update" field.

Declaration

public const int SubscribedAudioCodecUpdateFieldNumber = 26

Field Value

Type	Description
int

SubscribedQualityUpdateFieldNumber

Field number for the "subscribed_quality_update" field.

Declaration

public const int SubscribedQualityUpdateFieldNumber = 14

Field Value

Type	Description
int

SubscriptionPermissionUpdateFieldNumber

Field number for the "subscription_permission_update" field.

Declaration

public const int SubscriptionPermissionUpdateFieldNumber = 15

Field Value

Type	Description
int

SubscriptionResponseFieldNumber

Field number for the "subscription_response" field.

Declaration

public const int SubscriptionResponseFieldNumber = 21

Field Value

Type	Description
int

TrackPublishedFieldNumber

Field number for the "track_published" field.

Declaration

public const int TrackPublishedFieldNumber = 6

Field Value

Type	Description
int

TrackSubscribedFieldNumber

Field number for the "track_subscribed" field.

Declaration

public const int TrackSubscribedFieldNumber = 23

Field Value

Type	Description
int

TrackUnpublishedFieldNumber

Field number for the "track_unpublished" field.

Declaration

public const int TrackUnpublishedFieldNumber = 17

Field Value

Type	Description
int

TrickleFieldNumber

Field number for the "trickle" field.

Declaration

public const int TrickleFieldNumber = 4

Field Value

Type	Description
int

UnpublishDataTrackResponseFieldNumber

Field number for the "unpublish_data_track_response" field.

Declaration

public const int UnpublishDataTrackResponseFieldNumber = 28

Field Value

Type	Description
int

UpdateFieldNumber

Field number for the "update" field.

Declaration

public const int UpdateFieldNumber = 5

Field Value

Type	Description
int

Properties

Answer

sent when server answers publisher

Declaration

public SessionDescription Answer { get; set; }

Property Value

Type	Description
SessionDescription

ConnectionQuality

when connection quality changed

Declaration

public ConnectionQualityUpdate ConnectionQuality { get; set; }

Property Value

Type	Description
ConnectionQualityUpdate

DataTrackSubscriberHandles

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

Declaration

public DataTrackSubscriberHandles DataTrackSubscriberHandles { get; set; }

Property Value

Type	Description
DataTrackSubscriberHandles

Descriptor

Declaration

public static MessageDescriptor Descriptor { get; }

Property Value

Type	Description
MessageDescriptor

GetDataBlobResponse

Sent in response to GetDataBlobRequest.

Declaration

public GetDataBlobResponse GetDataBlobResponse { get; set; }

Property Value

Type	Description
GetDataBlobResponse

HasPong

Gets whether the "pong" field is set

Declaration

public bool HasPong { get; }

Property Value

Type	Description
bool

HasRefreshToken

Gets whether the "refresh_token" field is set

Declaration

public bool HasRefreshToken { get; }

Property Value

Type	Description
bool

Join

sent when join is accepted

Declaration

public JoinResponse Join { get; set; }

Property Value

Type	Description
JoinResponse

Leave

Immediately terminate session

Declaration

public LeaveRequest Leave { get; set; }

Property Value

Type	Description
LeaveRequest

MediaSectionsRequirement

notify number of required media sections to satisfy subscribed tracks

Declaration

public MediaSectionsRequirement MediaSectionsRequirement { get; set; }

Property Value

Type	Description
MediaSectionsRequirement

MessageCase

Declaration

public SignalResponse.MessageOneofCase MessageCase { get; }

Property Value

Type	Description
SignalResponse.MessageOneofCase

Mute

server initiated mute

Declaration

public MuteTrackRequest Mute { get; set; }

Property Value

Type	Description
MuteTrackRequest

Offer

sent when server is sending subscriber an offer

Declaration

public SessionDescription Offer { get; set; }

Property Value

Type	Description
SessionDescription

Parser

Declaration

public static MessageParser<SignalResponse> Parser { get; }

Property Value

Type	Description
MessageParser<SignalResponse>

Pong

respond to ping

Declaration

public long Pong { get; set; }

Property Value

Type	Description
long

PongResp

respond to Ping

Declaration

public Pong PongResp { get; set; }

Property Value

Type	Description
Pong

PublishDataTrackResponse

Sent in response to PublishDataTrackRequest.

Declaration

public PublishDataTrackResponse PublishDataTrackResponse { get; set; }

Property Value

Type	Description
PublishDataTrackResponse

Reconnect

sent when client reconnects

Declaration

public ReconnectResponse Reconnect { get; set; }

Property Value

Type	Description
ReconnectResponse

RefreshToken

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

Declaration

public string RefreshToken { get; set; }

Property Value

Type	Description
string

RequestResponse

Response relating to user inititated requests that carry a request_id

Declaration

public RequestResponse RequestResponse { get; set; }

Property Value

Type	Description
RequestResponse

RoomMoved

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

Declaration

public RoomMovedResponse RoomMoved { get; set; }

Property Value

Type	Description
RoomMovedResponse

RoomUpdate

sent when metadata of the room has changed

Declaration

public RoomUpdate RoomUpdate { get; set; }

Property Value

Type	Description
RoomUpdate

SpeakersChanged

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

Declaration

public SpeakersChanged SpeakersChanged { get; set; }

Property Value

Type	Description
SpeakersChanged

StoreDataBlobResponse

Sent in response to StoreDataBlobRequest.

Declaration

public StoreDataBlobResponse StoreDataBlobResponse { get; set; }

Property Value

Type	Description
StoreDataBlobResponse

StreamStateUpdate

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

Declaration

public StreamStateUpdate StreamStateUpdate { get; set; }

Property Value

Type	Description
StreamStateUpdate

SubscribedAudioCodecUpdate

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

Declaration

public SubscribedAudioCodecUpdate SubscribedAudioCodecUpdate { get; set; }

Property Value

Type	Description
SubscribedAudioCodecUpdate

SubscribedQualityUpdate

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

Declaration

public SubscribedQualityUpdate SubscribedQualityUpdate { get; set; }

Property Value

Type	Description
SubscribedQualityUpdate

SubscriptionPermissionUpdate

when subscription permission changed

Declaration

public SubscriptionPermissionUpdate SubscriptionPermissionUpdate { get; set; }

Property Value

Type	Description
SubscriptionPermissionUpdate

SubscriptionResponse

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

Declaration

public SubscriptionResponse SubscriptionResponse { get; set; }

Property Value

Type	Description
SubscriptionResponse

TrackPublished

sent to the participant when their track has been published

Declaration

public TrackPublishedResponse TrackPublished { get; set; }

Property Value

Type	Description
TrackPublishedResponse

TrackSubscribed

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

Declaration

public TrackSubscribed TrackSubscribed { get; set; }

Property Value

Type	Description
TrackSubscribed

TrackUnpublished

server initiated track unpublish

Declaration

public TrackUnpublishedResponse TrackUnpublished { get; set; }

Property Value

Type	Description
TrackUnpublishedResponse

Trickle

sent when an ICE candidate is available

Declaration

public TrickleRequest Trickle { get; set; }

Property Value

Type	Description
TrickleRequest

UnpublishDataTrackResponse

Sent in response to UnpublishDataTrackRequest or SFU-initiated unpublish.

Declaration

public UnpublishDataTrackResponse UnpublishDataTrackResponse { get; set; }

Property Value

Type	Description
UnpublishDataTrackResponse

Update

sent when participants in the room has changed

Declaration

public ParticipantUpdate Update { get; set; }

Property Value

Type	Description
ParticipantUpdate

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

ClearPong()

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

Declaration

public void ClearPong()

ClearRefreshToken()

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

Declaration

public void ClearRefreshToken()

Clone()

Creates a deep clone of this object.

Declaration

public SignalResponse Clone()

Returns

Type	Description
SignalResponse	A deep clone of this object.

Equals(SignalResponse)

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

Declaration

public bool Equals(SignalResponse other)

Parameters

Type	Name	Description
SignalResponse	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(SignalResponse)

Merges the given message into this one.

Declaration

public void MergeFrom(SignalResponse other)

Parameters

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