Class JoinRequest
Implements
IBufferMessage
IMessage
Namespace: LiveKit.Proto
Assembly: Uniform.LiveKit.Protocol.dll
Syntax
public sealed class JoinRequest : IMessage<JoinRequest>, IEquatable<JoinRequest>, IDeepCloneable<JoinRequest>, IBufferMessage, IMessage
Constructors
JoinRequest()
Declaration
JoinRequest(JoinRequest)
Declaration
public JoinRequest(JoinRequest other)
Parameters
Fields
AddTrackRequestsFieldNumber
Field number for the "add_track_requests" field.
Declaration
public const int AddTrackRequestsFieldNumber = 5
Field Value
ClientInfoFieldNumber
Field number for the "client_info" field.
Declaration
public const int ClientInfoFieldNumber = 1
Field Value
ConnectionSettingsFieldNumber
Field number for the "connection_settings" field.
Declaration
public const int ConnectionSettingsFieldNumber = 2
Field Value
Field number for the "metadata" field.
Declaration
public const int MetadataFieldNumber = 3
Field Value
ParticipantAttributesFieldNumber
Field number for the "participant_attributes" field.
Declaration
public const int ParticipantAttributesFieldNumber = 4
Field Value
ParticipantSidFieldNumber
Field number for the "participant_sid" field.
Declaration
public const int ParticipantSidFieldNumber = 9
Field Value
PublisherOfferFieldNumber
Field number for the "publisher_offer" field.
Declaration
public const int PublisherOfferFieldNumber = 6
Field Value
ReconnectFieldNumber
Field number for the "reconnect" field.
Declaration
public const int ReconnectFieldNumber = 7
Field Value
ReconnectReasonFieldNumber
Field number for the "reconnect_reason" field.
Declaration
public const int ReconnectReasonFieldNumber = 8
Field Value
SyncStateFieldNumber
Field number for the "sync_state" field.
Declaration
public const int SyncStateFieldNumber = 10
Field Value
Properties
AddTrackRequests
Declaration
public RepeatedField<AddTrackRequest> AddTrackRequests { get; }
Property Value
ClientInfo
Declaration
public ClientInfo ClientInfo { get; set; }
Property Value
ConnectionSettings
Declaration
public ConnectionSettings ConnectionSettings { get; set; }
Property Value
Descriptor
Declaration
public static MessageDescriptor Descriptor { get; }
Property Value
| Type |
Description |
| MessageDescriptor |
|
if not empty, will overwrite metadata in token
Declaration
public string Metadata { get; set; }
Property Value
Parser
Declaration
public static MessageParser<JoinRequest> Parser { get; }
Property Value
ParticipantAttributes
will set keys provided via this
will overwrite if the same key is in the token
will not delete keys from token if there is a key collision and this sets that key to empty value
Declaration
public MapField<string, string> ParticipantAttributes { get; }
Property Value
ParticipantSid
Declaration
public string ParticipantSid { get; set; }
Property Value
PublisherOffer
Declaration
public SessionDescription PublisherOffer { get; set; }
Property Value
Reconnect
Declaration
public bool Reconnect { get; set; }
Property Value
ReconnectReason
Declaration
public ReconnectReason ReconnectReason { get; set; }
Property Value
SyncState
Declaration
public SyncState SyncState { get; set; }
Property Value
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.
|
Clone()
Creates a deep clone of this object.
Declaration
public JoinRequest Clone()
Returns
| Type |
Description |
| JoinRequest |
A deep clone of this object.
|
Equals(JoinRequest)
Indicates whether the current object is equal to another object of the same type.
Declaration
public bool Equals(JoinRequest other)
Parameters
| Type |
Name |
Description |
| JoinRequest |
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
GetHashCode()
Serves as the default hash function.
Declaration
public override int GetHashCode()
Returns
| Type |
Description |
| int |
A hash code for the current object.
|
Overrides
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 |
|
MergeFrom(JoinRequest)
Merges the given message into this one.
Declaration
public void MergeFrom(JoinRequest other)
Parameters
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
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>
Google.Protobuf.IDeepCloneable<T>
Google.Protobuf.IBufferMessage
Google.Protobuf.IMessage