Class DataTrackSubscriptionOptions

Inheritance

object

DataTrackSubscriptionOptions

Implements

IMessage<DataTrackSubscriptionOptions>

IEquatable<DataTrackSubscriptionOptions>

IDeepCloneable<DataTrackSubscriptionOptions>

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

Constructors

DataTrackSubscriptionOptions()

Declaration

public DataTrackSubscriptionOptions()

DataTrackSubscriptionOptions(DataTrackSubscriptionOptions)

Declaration

public DataTrackSubscriptionOptions(DataTrackSubscriptionOptions other)

Parameters

Type	Name	Description
DataTrackSubscriptionOptions	other

Fields

TargetFpsFieldNumber

Field number for the "target_fps" field.

Declaration

public const int TargetFpsFieldNumber = 1

Field Value

Type	Description
int

Properties

Descriptor

Declaration

public static MessageDescriptor Descriptor { get; }

Property Value

Type	Description
MessageDescriptor

HasTargetFps

Gets whether the "target_fps" field is set

Declaration

public bool HasTargetFps { get; }

Property Value

Type	Description
bool

Parser

Declaration

public static MessageParser<DataTrackSubscriptionOptions> Parser { get; }

Property Value

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

Declaration

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

ClearTargetFps()

Clears the value of the "target_fps" field

Declaration

public void ClearTargetFps()

Clone()

Creates a deep clone of this object.

Declaration

public DataTrackSubscriptionOptions Clone()

Returns

Type	Description
DataTrackSubscriptionOptions	A deep clone of this object.

Equals(DataTrackSubscriptionOptions)

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

Declaration

public bool Equals(DataTrackSubscriptionOptions other)

Parameters

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

Merges the given message into this one.

Declaration

public void MergeFrom(DataTrackSubscriptionOptions other)

Parameters

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