Class PublishDataTrackRequest

Inheritance

object

PublishDataTrackRequest

Implements

IMessage<PublishDataTrackRequest>

IEquatable<PublishDataTrackRequest>

IDeepCloneable<PublishDataTrackRequest>

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

Constructors

PublishDataTrackRequest()

Declaration

public PublishDataTrackRequest()

PublishDataTrackRequest(PublishDataTrackRequest)

Declaration

public PublishDataTrackRequest(PublishDataTrackRequest other)

Parameters

Type	Name	Description
PublishDataTrackRequest	other

Fields

EncryptionFieldNumber

Field number for the "encryption" field.

Declaration

public const int EncryptionFieldNumber = 3

Field Value

Type	Description
int

FrameEncodingFieldNumber

Field number for the "frame_encoding" field.

Declaration

public const int FrameEncodingFieldNumber = 4

Field Value

Type	Description
int

NameFieldNumber

Field number for the "name" field.

Declaration

public const int NameFieldNumber = 2

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 = 5

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 frame 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. This must be non-empty and no longer than 256 characters.

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

Parser

Declaration

public static MessageParser<PublishDataTrackRequest> Parser { get; }

Property Value

Type	Description
MessageParser<PublishDataTrackRequest>

PubHandle

Client-assigned, 16-bit identifier that will be attached to packets sent by the publisher. This must be non-zero and unique for each data track published 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. If set, the associated schema must be stored with StoreDataBlobRequest.

Declaration

public DataTrackSchemaId Schema { get; set; }

Property Value

Type	Description
DataTrackSchemaId

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

Returns

Type	Description
PublishDataTrackRequest	A deep clone of this object.

Equals(PublishDataTrackRequest)

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

Declaration

public bool Equals(PublishDataTrackRequest other)

Parameters

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

Merges the given message into this one.

Declaration

public void MergeFrom(PublishDataTrackRequest other)

Parameters

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