Class ClientInfo

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

details about the client

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

Inheritance

object

ClientInfo

Implements

IMessage<ClientInfo>

IEquatable<ClientInfo>

IDeepCloneable<ClientInfo>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ClientInfo()

public ClientInfo()

ClientInfo(ClientInfo)

public ClientInfo(ClientInfo other)

Parameters

other ClientInfo

Fields

AddressFieldNumber

Field number for the "address" field.

public const int AddressFieldNumber = 9

Field Value

int

BrowserFieldNumber

Field number for the "browser" field.

public const int BrowserFieldNumber = 7

Field Value

int

BrowserVersionFieldNumber

Field number for the "browser_version" field.

public const int BrowserVersionFieldNumber = 8

Field Value

int

CapabilitiesFieldNumber

Field number for the "capabilities" field.

public const int CapabilitiesFieldNumber = 13

Field Value

int

ClientProtocolFieldNumber

Field number for the "client_protocol" field.

public const int ClientProtocolFieldNumber = 12

Field Value

int

DeviceModelFieldNumber

Field number for the "device_model" field.

public const int DeviceModelFieldNumber = 6

Field Value

int

NetworkFieldNumber

Field number for the "network" field.

public const int NetworkFieldNumber = 10

Field Value

int

OsFieldNumber

Field number for the "os" field.

public const int OsFieldNumber = 4

Field Value

int

OsVersionFieldNumber

Field number for the "os_version" field.

public const int OsVersionFieldNumber = 5

Field Value

int

OtherSdksFieldNumber

Field number for the "other_sdks" field.

public const int OtherSdksFieldNumber = 11

Field Value

int

ProtocolFieldNumber

Field number for the "protocol" field.

public const int ProtocolFieldNumber = 3

Field Value

int

SdkFieldNumber

Field number for the "sdk" field.

public const int SdkFieldNumber = 1

Field Value

int

VersionFieldNumber

Field number for the "version" field.

public const int VersionFieldNumber = 2

Field Value

int

Properties

Address

public string Address { get; set; }

Property Value

string

Browser

public string Browser { get; set; }

Property Value

string

BrowserVersion

public string BrowserVersion { get; set; }

Property Value

string

Capabilities

capabilities the client advertises. Populated automatically by each SDK; not a user-configurable setting.

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

Property Value

RepeatedField<ClientInfo.Types.Capability>

ClientProtocol

client protocol version

public int ClientProtocol { get; set; }

Property Value

int

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

DeviceModel

public string DeviceModel { get; set; }

Property Value

string

Network

wifi, wired, cellular, vpn, empty if not known

public string Network { get; set; }

Property Value

string

Os

public string Os { get; set; }

Property Value

string

OsVersion

public string OsVersion { get; set; }

Property Value

string

OtherSdks

comma separated list of additional LiveKit SDKs in use of this client, with versions e.g. "components-js:1.2.3,track-processors-js:1.2.3"

public string OtherSdks { get; set; }

Property Value

string

Parser

public static MessageParser<ClientInfo> Parser { get; }

Property Value

MessageParser<ClientInfo>

Protocol

public int Protocol { get; set; }

Property Value

int

Sdk

public ClientInfo.Types.SDK Sdk { get; set; }

Property Value

ClientInfo.Types.SDK

Version

public string Version { get; set; }

Property Value

string

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

Returns

ClientInfo

A deep clone of this object.

Equals(ClientInfo)

public bool Equals(ClientInfo other)

Parameters

other ClientInfo

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

Merges the given message into this one.

public void MergeFrom(ClientInfo other)

Parameters

other ClientInfo

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.