Class UpdateTrackSettings

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

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

Inheritance

object

UpdateTrackSettings

Implements

IMessage<UpdateTrackSettings>

IEquatable<UpdateTrackSettings>

IDeepCloneable<UpdateTrackSettings>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

UpdateTrackSettings()

public UpdateTrackSettings()

UpdateTrackSettings(UpdateTrackSettings)

public UpdateTrackSettings(UpdateTrackSettings other)

Parameters

other UpdateTrackSettings

Fields

DisabledFieldNumber

Field number for the "disabled" field.

public const int DisabledFieldNumber = 3

Field Value

int

FpsFieldNumber

Field number for the "fps" field.

public const int FpsFieldNumber = 7

Field Value

int

HeightFieldNumber

Field number for the "height" field.

public const int HeightFieldNumber = 6

Field Value

int

PriorityFieldNumber

Field number for the "priority" field.

public const int PriorityFieldNumber = 8

Field Value

int

QualityFieldNumber

Field number for the "quality" field.

public const int QualityFieldNumber = 4

Field Value

int

TrackSidsFieldNumber

Field number for the "track_sids" field.

public const int TrackSidsFieldNumber = 1

Field Value

int

WidthFieldNumber

Field number for the "width" field.

public const int WidthFieldNumber = 5

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Disabled

when true, the track is placed in a paused state, with no new data returned

public bool Disabled { get; set; }

Property Value

bool

Fps

public uint Fps { get; set; }

Property Value

uint

Height

for video, height to receive

public uint Height { get; set; }

Property Value

uint

Parser

public static MessageParser<UpdateTrackSettings> Parser { get; }

Property Value

MessageParser<UpdateTrackSettings>

Priority

subscription priority. 1 being the highest (0 is unset) when unset, server sill assign priority based on the order of subscription server will use priority in the following ways:

1. when subscribed tracks exceed per-participant subscription limit, server will pause the lowest priority tracks
2. when the network is congested, server will assign available bandwidth to higher priority tracks first. lowest priority tracks can be paused

public uint Priority { get; set; }

Property Value

uint

Quality

deprecated in favor of width & height

public VideoQuality Quality { get; set; }

Property Value

VideoQuality

TrackSids

public RepeatedField<string> TrackSids { get; }

Property Value

RepeatedField<string>

Width

for video, width to receive

public uint Width { 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 UpdateTrackSettings Clone()

Returns

UpdateTrackSettings

A deep clone of this object.

Equals(UpdateTrackSettings)

public bool Equals(UpdateTrackSettings other)

Parameters

other UpdateTrackSettings

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

Merges the given message into this one.

public void MergeFrom(UpdateTrackSettings other)

Parameters

other UpdateTrackSettings

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.