Class JoinRequest

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

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

Inheritance

object

JoinRequest

Implements

IMessage<JoinRequest>

IEquatable<JoinRequest>

IDeepCloneable<JoinRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

JoinRequest()

public JoinRequest()

JoinRequest(JoinRequest)

public JoinRequest(JoinRequest other)

Parameters

other JoinRequest

Fields

AddTrackRequestsFieldNumber

Field number for the "add_track_requests" field.

public const int AddTrackRequestsFieldNumber = 5

Field Value

int

ClientInfoFieldNumber

Field number for the "client_info" field.

public const int ClientInfoFieldNumber = 1

Field Value

int

ConnectionSettingsFieldNumber

Field number for the "connection_settings" field.

public const int ConnectionSettingsFieldNumber = 2

Field Value

int

MetadataFieldNumber

Field number for the "metadata" field.

public const int MetadataFieldNumber = 3

Field Value

int

ParticipantAttributesFieldNumber

Field number for the "participant_attributes" field.

public const int ParticipantAttributesFieldNumber = 4

Field Value

int

ParticipantSidFieldNumber

Field number for the "participant_sid" field.

public const int ParticipantSidFieldNumber = 9

Field Value

int

PublisherOfferFieldNumber

Field number for the "publisher_offer" field.

public const int PublisherOfferFieldNumber = 6

Field Value

int

ReconnectFieldNumber

Field number for the "reconnect" field.

public const int ReconnectFieldNumber = 7

Field Value

int

ReconnectReasonFieldNumber

Field number for the "reconnect_reason" field.

public const int ReconnectReasonFieldNumber = 8

Field Value

int

SyncStateFieldNumber

Field number for the "sync_state" field.

public const int SyncStateFieldNumber = 10

Field Value

int

Properties

AddTrackRequests

public RepeatedField<AddTrackRequest> AddTrackRequests { get; }

Property Value

RepeatedField<AddTrackRequest>

ClientInfo

public ClientInfo ClientInfo { get; set; }

Property Value

ClientInfo

ConnectionSettings

public ConnectionSettings ConnectionSettings { get; set; }

Property Value

ConnectionSettings

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Metadata

if not empty, will overwrite metadata in token

public string Metadata { get; set; }

Property Value

string

Parser

public static MessageParser<JoinRequest> Parser { get; }

Property Value

MessageParser<JoinRequest>

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

public MapField<string, string> ParticipantAttributes { get; }

Property Value

MapField<string, string>

ParticipantSid

public string ParticipantSid { get; set; }

Property Value

string

PublisherOffer

public SessionDescription PublisherOffer { get; set; }

Property Value

SessionDescription

Reconnect

public bool Reconnect { get; set; }

Property Value

bool

ReconnectReason

public ReconnectReason ReconnectReason { get; set; }

Property Value

ReconnectReason

SyncState

public SyncState SyncState { get; set; }

Property Value

SyncState

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

Returns

JoinRequest

A deep clone of this object.

Equals(JoinRequest)

public bool Equals(JoinRequest other)

Parameters

other JoinRequest

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

Merges the given message into this one.

public void MergeFrom(JoinRequest other)

Parameters

other JoinRequest

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.