Class UpdateTrackSettings

Namespace

Livekit.Server.Sdk.Dotnet

Assembly

LivekitApi.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.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

UpdateTrackSettings()

public UpdateTrackSettings()

UpdateTrackSettings(UpdateTrackSettings)

public UpdateTrackSettings(UpdateTrackSettings other)

Parameters

other UpdateTrackSettings

Properties

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

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