Class ParticipantInfo

Inheritance

object

ParticipantInfo

Implements

IMessage<ParticipantInfo>

IEquatable<ParticipantInfo>

IDeepCloneable<ParticipantInfo>

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

Constructors

ParticipantInfo()

Declaration

public ParticipantInfo()

ParticipantInfo(ParticipantInfo)

Declaration

public ParticipantInfo(ParticipantInfo other)

Parameters

Type	Name	Description
ParticipantInfo	other

Fields

AttributesFieldNumber

Field number for the "attributes" field.

Declaration

public const int AttributesFieldNumber = 15

Field Value

Type	Description
int

CapabilitiesFieldNumber

Field number for the "capabilities" field.

Declaration

public const int CapabilitiesFieldNumber = 21

Field Value

Type	Description
int

ClientProtocolFieldNumber

Field number for the "client_protocol" field.

Declaration

public const int ClientProtocolFieldNumber = 20

Field Value

Type	Description
int

DataTracksFieldNumber

Field number for the "data_tracks" field.

Declaration

public const int DataTracksFieldNumber = 19

Field Value

Type	Description
int

DisconnectReasonFieldNumber

Field number for the "disconnect_reason" field.

Declaration

public const int DisconnectReasonFieldNumber = 16

Field Value

Type	Description
int

IdentityFieldNumber

Field number for the "identity" field.

Declaration

public const int IdentityFieldNumber = 2

Field Value

Type	Description
int

IsPublisherFieldNumber

Field number for the "is_publisher" field.

Declaration

public const int IsPublisherFieldNumber = 13

Field Value

Type	Description
int

JoinedAtFieldNumber

Field number for the "joined_at" field.

Declaration

public const int JoinedAtFieldNumber = 6

Field Value

Type	Description
int

JoinedAtMsFieldNumber

Field number for the "joined_at_ms" field.

Declaration

public const int JoinedAtMsFieldNumber = 17

Field Value

Type	Description
int

KindDetailsFieldNumber

Field number for the "kind_details" field.

Declaration

public const int KindDetailsFieldNumber = 18

Field Value

Type	Description
int

KindFieldNumber

Field number for the "kind" field.

Declaration

public const int KindFieldNumber = 14

Field Value

Type	Description
int

MetadataFieldNumber

Field number for the "metadata" field.

Declaration

public const int MetadataFieldNumber = 5

Field Value

Type	Description
int

NameFieldNumber

Field number for the "name" field.

Declaration

public const int NameFieldNumber = 9

Field Value

Type	Description
int

PermissionFieldNumber

Field number for the "permission" field.

Declaration

public const int PermissionFieldNumber = 11

Field Value

Type	Description
int

RegionFieldNumber

Field number for the "region" field.

Declaration

public const int RegionFieldNumber = 12

Field Value

Type	Description
int

SidFieldNumber

Field number for the "sid" field.

Declaration

public const int SidFieldNumber = 1

Field Value

Type	Description
int

StateFieldNumber

Field number for the "state" field.

Declaration

public const int StateFieldNumber = 3

Field Value

Type	Description
int

TracksFieldNumber

Field number for the "tracks" field.

Declaration

public const int TracksFieldNumber = 4

Field Value

Type	Description
int

VersionFieldNumber

Field number for the "version" field.

Declaration

public const int VersionFieldNumber = 10

Field Value

Type	Description
int

Properties

Attributes

Declaration

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

Property Value

Type	Description
MapField<string, string>

Capabilities

capabilities the participant's client advertises, mirrored from ClientInfo. Lets other participants perform client-side feature detection.

Declaration

public RepeatedField<ClientInfo.Types.Capability> Capabilities { get; }

Property Value

Type	Description
RepeatedField<ClientInfo.Types.Capability>

ClientProtocol

protocol version used for client feature compatibility

Declaration

public int ClientProtocol { get; set; }

Property Value

Type	Description
int

DataTracks

Declaration

public RepeatedField<DataTrackInfo> DataTracks { get; }

Property Value

Type	Description
RepeatedField<DataTrackInfo>

Descriptor

Declaration

public static MessageDescriptor Descriptor { get; }

Property Value

Type	Description
MessageDescriptor

DisconnectReason

Declaration

public DisconnectReason DisconnectReason { get; set; }

Property Value

Type	Description
DisconnectReason

Identity

Declaration

public string Identity { get; set; }

Property Value

Type	Description
string

IsPublisher

indicates the participant has an active publisher connection and can publish to the server

Declaration

public bool IsPublisher { get; set; }

Property Value

Type	Description
bool

JoinedAt

timestamp when participant joined room, in seconds

Declaration

public long JoinedAt { get; set; }

Property Value

Type	Description
long

JoinedAtMs

timestamp when participant joined room, in milliseconds

Declaration

public long JoinedAtMs { get; set; }

Property Value

Type	Description
long

Kind

Declaration

public ParticipantInfo.Types.Kind Kind { get; set; }

Property Value

Type	Description
ParticipantInfo.Types.Kind

KindDetails

Declaration

public RepeatedField<ParticipantInfo.Types.KindDetail> KindDetails { get; }

Property Value

Type	Description
RepeatedField<ParticipantInfo.Types.KindDetail>

Metadata

Declaration

public string Metadata { get; set; }

Property Value

Type	Description
string

Name

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

Parser

Declaration

public static MessageParser<ParticipantInfo> Parser { get; }

Property Value

Type	Description
MessageParser<ParticipantInfo>

Permission

Declaration

public ParticipantPermission Permission { get; set; }

Property Value

Type	Description
ParticipantPermission

Region

Declaration

public string Region { get; set; }

Property Value

Type	Description
string

Sid

Declaration

public string Sid { get; set; }

Property Value

Type	Description
string

State

Declaration

public ParticipantInfo.Types.State State { get; set; }

Property Value

Type	Description
ParticipantInfo.Types.State

Tracks

Declaration

public RepeatedField<TrackInfo> Tracks { get; }

Property Value

Type	Description
RepeatedField<TrackInfo>

Version

Declaration

public uint Version { get; set; }

Property Value

Type	Description
uint

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

Returns

Type	Description
ParticipantInfo	A deep clone of this object.

Equals(ParticipantInfo)

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

Declaration

public bool Equals(ParticipantInfo other)

Parameters

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

Merges the given message into this one.

Declaration

public void MergeFrom(ParticipantInfo other)

Parameters

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