Class JoinResponse
Implements
IBufferMessage
IMessage
Namespace: LiveKit.Proto
Assembly: Uniform.LiveKit.Protocol.dll
Syntax
public sealed class JoinResponse : IMessage<JoinResponse>, IEquatable<JoinResponse>, IDeepCloneable<JoinResponse>, IBufferMessage, IMessage
Constructors
JoinResponse()
Declaration
JoinResponse(JoinResponse)
Declaration
public JoinResponse(JoinResponse other)
Parameters
Fields
AlternativeUrlFieldNumber
Field number for the "alternative_url" field.
Declaration
public const int AlternativeUrlFieldNumber = 7
Field Value
ClientConfigurationFieldNumber
Field number for the "client_configuration" field.
Declaration
public const int ClientConfigurationFieldNumber = 8
Field Value
EnabledPublishCodecsFieldNumber
Field number for the "enabled_publish_codecs" field.
Declaration
public const int EnabledPublishCodecsFieldNumber = 14
Field Value
FastPublishFieldNumber
Field number for the "fast_publish" field.
Declaration
public const int FastPublishFieldNumber = 15
Field Value
IceServersFieldNumber
Field number for the "ice_servers" field.
Declaration
public const int IceServersFieldNumber = 5
Field Value
OtherParticipantsFieldNumber
Field number for the "other_participants" field.
Declaration
public const int OtherParticipantsFieldNumber = 3
Field Value
ParticipantFieldNumber
Field number for the "participant" field.
Declaration
public const int ParticipantFieldNumber = 2
Field Value
PingIntervalFieldNumber
Field number for the "ping_interval" field.
Declaration
public const int PingIntervalFieldNumber = 11
Field Value
PingTimeoutFieldNumber
Field number for the "ping_timeout" field.
Declaration
public const int PingTimeoutFieldNumber = 10
Field Value
RoomFieldNumber
Field number for the "room" field.
Declaration
public const int RoomFieldNumber = 1
Field Value
ServerInfoFieldNumber
Field number for the "server_info" field.
Declaration
public const int ServerInfoFieldNumber = 12
Field Value
ServerRegionFieldNumber
Field number for the "server_region" field.
Declaration
public const int ServerRegionFieldNumber = 9
Field Value
ServerVersionFieldNumber
Field number for the "server_version" field.
Declaration
public const int ServerVersionFieldNumber = 4
Field Value
SifTrailerFieldNumber
Field number for the "sif_trailer" field.
Declaration
public const int SifTrailerFieldNumber = 13
Field Value
SubscriberPrimaryFieldNumber
Field number for the "subscriber_primary" field.
Declaration
public const int SubscriberPrimaryFieldNumber = 6
Field Value
Properties
AlternativeUrl
when the current server isn't available, return alternate url to retry connection
when this is set, the other fields will be largely empty
Declaration
public string AlternativeUrl { get; set; }
Property Value
ClientConfiguration
Declaration
public ClientConfiguration ClientConfiguration { get; set; }
Property Value
Descriptor
Declaration
public static MessageDescriptor Descriptor { get; }
Property Value
| Type |
Description |
| MessageDescriptor |
|
EnabledPublishCodecs
Declaration
public RepeatedField<Codec> EnabledPublishCodecs { get; }
Property Value
| Type |
Description |
| RepeatedField<Codec> |
|
FastPublish
when set, client should attempt to establish publish peer connection when joining room to speed up publishing
Declaration
public bool FastPublish { get; set; }
Property Value
IceServers
Declaration
public RepeatedField<ICEServer> IceServers { get; }
Property Value
OtherParticipants
Declaration
public RepeatedField<ParticipantInfo> OtherParticipants { get; }
Property Value
Parser
Declaration
public static MessageParser<JoinResponse> Parser { get; }
Property Value
Participant
Declaration
public ParticipantInfo Participant { get; set; }
Property Value
PingInterval
Declaration
public int PingInterval { get; set; }
Property Value
PingTimeout
Declaration
public int PingTimeout { get; set; }
Property Value
Room
Declaration
public Room Room { get; set; }
Property Value
ServerInfo
Declaration
public ServerInfo ServerInfo { get; set; }
Property Value
ServerRegion
deprecated. use server_info.region instead.
Declaration
public string ServerRegion { get; set; }
Property Value
ServerVersion
deprecated. use server_info.version instead.
Declaration
public string ServerVersion { get; set; }
Property Value
SifTrailer
Server-Injected-Frame byte trailer, used to identify unencrypted frames when e2ee is enabled
Declaration
public ByteString SifTrailer { get; set; }
Property Value
| Type |
Description |
| ByteString |
|
SubscriberPrimary
use subscriber as the primary PeerConnection
Declaration
public bool SubscriberPrimary { 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 JoinResponse Clone()
Returns
Equals(JoinResponse)
Indicates whether the current object is equal to another object of the same type.
Declaration
public bool Equals(JoinResponse other)
Parameters
| Type |
Name |
Description |
| JoinResponse |
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(JoinResponse)
Merges the given message into this one.
Declaration
public void MergeFrom(JoinResponse 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