Class UpdateTrackSettings

Inheritance

object

UpdateTrackSettings

Implements

IMessage<UpdateTrackSettings>

IEquatable<UpdateTrackSettings>

IDeepCloneable<UpdateTrackSettings>

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

Constructors

UpdateTrackSettings()

Declaration

public UpdateTrackSettings()

UpdateTrackSettings(UpdateTrackSettings)

Declaration

public UpdateTrackSettings(UpdateTrackSettings other)

Parameters

Type	Name	Description
UpdateTrackSettings	other

Fields

DisabledFieldNumber

Field number for the "disabled" field.

Declaration

public const int DisabledFieldNumber = 3

Field Value

Type	Description
int

FpsFieldNumber

Field number for the "fps" field.

Declaration

public const int FpsFieldNumber = 7

Field Value

Type	Description
int

HeightFieldNumber

Field number for the "height" field.

Declaration

public const int HeightFieldNumber = 6

Field Value

Type	Description
int

PriorityFieldNumber

Field number for the "priority" field.

Declaration

public const int PriorityFieldNumber = 8

Field Value

Type	Description
int

QualityFieldNumber

Field number for the "quality" field.

Declaration

public const int QualityFieldNumber = 4

Field Value

Type	Description
int

TrackSidsFieldNumber

Field number for the "track_sids" field.

Declaration

public const int TrackSidsFieldNumber = 1

Field Value

Type	Description
int

WidthFieldNumber

Field number for the "width" field.

Declaration

public const int WidthFieldNumber = 5

Field Value

Type	Description
int

Properties

Descriptor

Declaration

public static MessageDescriptor Descriptor { get; }

Property Value

Type	Description
MessageDescriptor

Disabled

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

Declaration

public bool Disabled { get; set; }

Property Value

Type	Description
bool

Fps

Declaration

public uint Fps { get; set; }

Property Value

Type	Description
uint

Height

for video, height to receive

Declaration

public uint Height { get; set; }

Property Value

Type	Description
uint

Parser

Declaration

public static MessageParser<UpdateTrackSettings> Parser { get; }

Property Value

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

Declaration

public uint Priority { get; set; }

Property Value

Type	Description
uint

Quality

deprecated in favor of width & height

Declaration

public VideoQuality Quality { get; set; }

Property Value

Type	Description
VideoQuality

TrackSids

Declaration

public RepeatedField<string> TrackSids { get; }

Property Value

Type	Description
RepeatedField<string>

Width

for video, width to receive

Declaration

public uint Width { get; set; }

Property Value

Type	Description
uint

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

Returns

Type	Description
UpdateTrackSettings	A deep clone of this object.

Equals(UpdateTrackSettings)

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

Declaration

public bool Equals(UpdateTrackSettings other)

Parameters

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

Merges the given message into this one.

Declaration

public void MergeFrom(UpdateTrackSettings other)

Parameters

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