Class DataTrackInfo
Inherited Members
Namespace: LiveKit.Proto
Assembly: Uniform.LiveKit.Protocol.dll
Syntax
public sealed class DataTrackInfo : IMessage<DataTrackInfo>, IEquatable<DataTrackInfo>, IDeepCloneable<DataTrackInfo>, IBufferMessage, IMessage
Constructors
DataTrackInfo()
Declaration
public DataTrackInfo()
DataTrackInfo(DataTrackInfo)
Declaration
public DataTrackInfo(DataTrackInfo other)
Parameters
| Type | Name | Description |
|---|---|---|
| DataTrackInfo | other |
Fields
EncryptionFieldNumber
Field number for the "encryption" field.
Declaration
public const int EncryptionFieldNumber = 4
Field Value
| Type | Description |
|---|---|
| int |
FrameEncodingFieldNumber
Field number for the "frame_encoding" field.
Declaration
public const int FrameEncodingFieldNumber = 5
Field Value
| Type | Description |
|---|---|
| int |
NameFieldNumber
Field number for the "name" field.
Declaration
public const int NameFieldNumber = 3
Field Value
| Type | Description |
|---|---|
| int |
PubHandleFieldNumber
Field number for the "pub_handle" field.
Declaration
public const int PubHandleFieldNumber = 1
Field Value
| Type | Description |
|---|---|
| int |
SchemaFieldNumber
Field number for the "schema" field.
Declaration
public const int SchemaFieldNumber = 6
Field Value
| Type | Description |
|---|---|
| int |
SidFieldNumber
Field number for the "sid" field.
Declaration
public const int SidFieldNumber = 2
Field Value
| Type | Description |
|---|---|
| int |
Properties
Descriptor
Declaration
public static MessageDescriptor Descriptor { get; }
Property Value
| Type | Description |
|---|---|
| MessageDescriptor |
Encryption
Method used for end-to-end encryption (E2EE) on packet payloads.
Declaration
public Encryption.Types.Type Encryption { get; set; }
Property Value
| Type | Description |
|---|---|
| Encryption.Types.Type |
FrameEncoding
Encoding for frame payloads on this track. If unspecified, the track is untyped.
Declaration
public DataTrackFrameEncoding FrameEncoding { get; set; }
Property Value
| Type | Description |
|---|---|
| DataTrackFrameEncoding |
Name
Human-readable identifier (e.g., geoLocation, servoPosition.x, etc.), unique per publisher.
Declaration
public string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Parser
Declaration
public static MessageParser<DataTrackInfo> Parser { get; }
Property Value
| Type | Description |
|---|---|
| MessageParser<DataTrackInfo> |
PubHandle
Client-assigned, 16-bit identifier that will be attached to packets sent by the publisher.
Declaration
public uint PubHandle { get; set; }
Property Value
| Type | Description |
|---|---|
| uint |
Schema
ID of the schema used by frames on this track if the track is typed.
Declaration
public DataTrackSchemaId Schema { get; set; }
Property Value
| Type | Description |
|---|---|
| DataTrackSchemaId |
Sid
Server-assigned track identifier.
Declaration
public string Sid { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
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 DataTrackInfo Clone()
Returns
| Type | Description |
|---|---|
| DataTrackInfo | A deep clone of this object. |
Equals(DataTrackInfo)
Indicates whether the current object is equal to another object of the same type.
Declaration
public bool Equals(DataTrackInfo other)
Parameters
| Type | Name | Description |
|---|---|---|
| DataTrackInfo | other | An object to compare with this object. |
Returns
| Type | Description |
|---|---|
| bool | true if the current object is equal to the |
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
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(DataTrackInfo)
Merges the given message into this one.
Declaration
public void MergeFrom(DataTrackInfo other)
Parameters
| Type | Name | Description |
|---|---|---|
| DataTrackInfo | 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
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. |