Class DataTrackSubscriptionOptions

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

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

Inheritance

object

DataTrackSubscriptionOptions

Implements

IMessage<DataTrackSubscriptionOptions>

IEquatable<DataTrackSubscriptionOptions>

IDeepCloneable<DataTrackSubscriptionOptions>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

DataTrackSubscriptionOptions()

public DataTrackSubscriptionOptions()

DataTrackSubscriptionOptions(DataTrackSubscriptionOptions)

public DataTrackSubscriptionOptions(DataTrackSubscriptionOptions other)

Parameters

other DataTrackSubscriptionOptions

Fields

TargetFpsFieldNumber

Field number for the "target_fps" field.

public const int TargetFpsFieldNumber = 1

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

HasTargetFps

Gets whether the "target_fps" field is set

public bool HasTargetFps { get; }

Property Value

bool

Parser

public static MessageParser<DataTrackSubscriptionOptions> Parser { get; }

Property Value

MessageParser<DataTrackSubscriptionOptions>

TargetFps

Rate in frames per second (FPS) the subscriber wants to receive frames at. If omitted, the subscriber defaults to the publisher's fps

public uint TargetFps { 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.

ClearTargetFps()

Clears the value of the "target_fps" field

public void ClearTargetFps()

Clone()

Creates a deep clone of this object.

public DataTrackSubscriptionOptions Clone()

Returns

DataTrackSubscriptionOptions

A deep clone of this object.

Equals(DataTrackSubscriptionOptions)

public bool Equals(DataTrackSubscriptionOptions other)

Parameters

other DataTrackSubscriptionOptions

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

Merges the given message into this one.

public void MergeFrom(DataTrackSubscriptionOptions other)

Parameters

other DataTrackSubscriptionOptions

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.