Class PublishDataTrackRequest

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

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

Inheritance

object

PublishDataTrackRequest

Implements

IMessage<PublishDataTrackRequest>

IEquatable<PublishDataTrackRequest>

IDeepCloneable<PublishDataTrackRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PublishDataTrackRequest()

public PublishDataTrackRequest()

PublishDataTrackRequest(PublishDataTrackRequest)

public PublishDataTrackRequest(PublishDataTrackRequest other)

Parameters

other PublishDataTrackRequest

Fields

EncryptionFieldNumber

Field number for the "encryption" field.

public const int EncryptionFieldNumber = 3

Field Value

int

NameFieldNumber

Field number for the "name" field.

public const int NameFieldNumber = 2

Field Value

int

PubHandleFieldNumber

Field number for the "pub_handle" field.

public const int PubHandleFieldNumber = 1

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Encryption

Method used for end-to-end encryption (E2EE) on frame payloads.

public Encryption.Types.Type Encryption { get; set; }

Property Value

Encryption.Types.Type

Name

Human-readable identifier (e.g., geoLocation, servoPosition.x, etc.), unique per publisher. This must be non-empty and no longer than 256 characters.

public string Name { get; set; }

Property Value

string

Parser

public static MessageParser<PublishDataTrackRequest> Parser { get; }

Property Value

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.

public uint PubHandle { get; set; }

Property Value

uint

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

Returns

PublishDataTrackRequest

A deep clone of this object.

Equals(PublishDataTrackRequest)

public bool Equals(PublishDataTrackRequest other)

Parameters

other PublishDataTrackRequest

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

Merges the given message into this one.

public void MergeFrom(PublishDataTrackRequest other)

Parameters

other PublishDataTrackRequest

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.