Class JoinResponse

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

public sealed class JoinResponse : IMessage<JoinResponse>, IEquatable<JoinResponse>, IDeepCloneable<JoinResponse>, IBufferMessage, IMessage

Inheritance

object

JoinResponse

Implements

IMessage<JoinResponse>

IEquatable<JoinResponse>

IDeepCloneable<JoinResponse>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

JoinResponse()

public JoinResponse()

JoinResponse(JoinResponse)

public JoinResponse(JoinResponse other)

Parameters

other JoinResponse

Fields

AlternativeUrlFieldNumber

Field number for the "alternative_url" field.

public const int AlternativeUrlFieldNumber = 7

Field Value

int

ClientConfigurationFieldNumber

Field number for the "client_configuration" field.

public const int ClientConfigurationFieldNumber = 8

Field Value

int

EnabledPublishCodecsFieldNumber

Field number for the "enabled_publish_codecs" field.

public const int EnabledPublishCodecsFieldNumber = 14

Field Value

int

FastPublishFieldNumber

Field number for the "fast_publish" field.

public const int FastPublishFieldNumber = 15

Field Value

int

IceServersFieldNumber

Field number for the "ice_servers" field.

public const int IceServersFieldNumber = 5

Field Value

int

OtherParticipantsFieldNumber

Field number for the "other_participants" field.

public const int OtherParticipantsFieldNumber = 3

Field Value

int

ParticipantFieldNumber

Field number for the "participant" field.

public const int ParticipantFieldNumber = 2

Field Value

int

PingIntervalFieldNumber

Field number for the "ping_interval" field.

public const int PingIntervalFieldNumber = 11

Field Value

int

PingTimeoutFieldNumber

Field number for the "ping_timeout" field.

public const int PingTimeoutFieldNumber = 10

Field Value

int

RoomFieldNumber

Field number for the "room" field.

public const int RoomFieldNumber = 1

Field Value

int

ServerInfoFieldNumber

Field number for the "server_info" field.

public const int ServerInfoFieldNumber = 12

Field Value

int

ServerRegionFieldNumber

Field number for the "server_region" field.

public const int ServerRegionFieldNumber = 9

Field Value

int

ServerVersionFieldNumber

Field number for the "server_version" field.

public const int ServerVersionFieldNumber = 4

Field Value

int

SifTrailerFieldNumber

Field number for the "sif_trailer" field.

public const int SifTrailerFieldNumber = 13

Field Value

int

SubscriberPrimaryFieldNumber

Field number for the "subscriber_primary" field.

public const int SubscriberPrimaryFieldNumber = 6

Field Value

int

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

public string AlternativeUrl { get; set; }

Property Value

string

ClientConfiguration

public ClientConfiguration ClientConfiguration { get; set; }

Property Value

ClientConfiguration

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

EnabledPublishCodecs

public RepeatedField<Codec> EnabledPublishCodecs { get; }

Property Value

RepeatedField<Codec>

FastPublish

when set, client should attempt to establish publish peer connection when joining room to speed up publishing

public bool FastPublish { get; set; }

Property Value

bool

IceServers

public RepeatedField<ICEServer> IceServers { get; }

Property Value

RepeatedField<ICEServer>

OtherParticipants

public RepeatedField<ParticipantInfo> OtherParticipants { get; }

Property Value

RepeatedField<ParticipantInfo>

Parser

public static MessageParser<JoinResponse> Parser { get; }

Property Value

MessageParser<JoinResponse>

Participant

public ParticipantInfo Participant { get; set; }

Property Value

ParticipantInfo

PingInterval

public int PingInterval { get; set; }

Property Value

int

PingTimeout

public int PingTimeout { get; set; }

Property Value

int

Room

public Room Room { get; set; }

Property Value

Room

ServerInfo

public ServerInfo ServerInfo { get; set; }

Property Value

ServerInfo

ServerRegion

deprecated. use server_info.region instead.

public string ServerRegion { get; set; }

Property Value

string

ServerVersion

deprecated. use server_info.version instead.

public string ServerVersion { get; set; }

Property Value

string

SifTrailer

Server-Injected-Frame byte trailer, used to identify unencrypted frames when e2ee is enabled

public ByteString SifTrailer { get; set; }

Property Value

ByteString

SubscriberPrimary

use subscriber as the primary PeerConnection

public bool SubscriberPrimary { get; set; }

Property Value

bool

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.

Clone()

Creates a deep clone of this object.

public JoinResponse Clone()

Returns

JoinResponse

A deep clone of this object.

Equals(JoinResponse)

public bool Equals(JoinResponse other)

Parameters

other JoinResponse

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

Merges the given message into this one.

public void MergeFrom(JoinResponse other)

Parameters

other JoinResponse

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.