Class MetricsBatch

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

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

Inheritance

object

MetricsBatch

Implements

IMessage<MetricsBatch>

IEquatable<MetricsBatch>

IDeepCloneable<MetricsBatch>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

MetricsBatch()

public MetricsBatch()

MetricsBatch(MetricsBatch)

public MetricsBatch(MetricsBatch other)

Parameters

other MetricsBatch

Fields

EventsFieldNumber

Field number for the "events" field.

public const int EventsFieldNumber = 5

Field Value

int

NormalizedTimestampFieldNumber

Field number for the "normalized_timestamp" field.

public const int NormalizedTimestampFieldNumber = 2

Field Value

int

StrDataFieldNumber

Field number for the "str_data" field.

public const int StrDataFieldNumber = 3

Field Value

int

TimeSeriesFieldNumber

Field number for the "time_series" field.

public const int TimeSeriesFieldNumber = 4

Field Value

int

TimestampMsFieldNumber

Field number for the "timestamp_ms" field.

public const int TimestampMsFieldNumber = 1

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Events

public RepeatedField<EventMetric> Events { get; }

Property Value

RepeatedField<EventMetric>

NormalizedTimestamp

public Timestamp NormalizedTimestamp { get; set; }

Property Value

Timestamp

Parser

public static MessageParser<MetricsBatch> Parser { get; }

Property Value

MessageParser<MetricsBatch>

StrData

To avoid repeating string values, we store them in a separate list and reference them by index This is useful for storing participant identities, track names, etc. There is also a predefined list of labels that can be used to reference common metrics. They have reserved indices from 0 to (METRIC_LABEL_PREDEFINED_MAX_VALUE - 1). Indexes pointing at str_data should start from METRIC_LABEL_PREDEFINED_MAX_VALUE, such that str_data[0] == index of METRIC_LABEL_PREDEFINED_MAX_VALUE.

public RepeatedField<string> StrData { get; }

Property Value

RepeatedField<string>

TimeSeries

public RepeatedField<TimeSeriesMetric> TimeSeries { get; }

Property Value

RepeatedField<TimeSeriesMetric>

TimestampMs

time at which this batch is sent based on a monotonic clock (millisecond resolution)

public long TimestampMs { get; set; }

Property Value

long

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

Returns

MetricsBatch

A deep clone of this object.

Equals(MetricsBatch)

public bool Equals(MetricsBatch other)

Parameters

other MetricsBatch

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

Merges the given message into this one.

public void MergeFrom(MetricsBatch other)

Parameters

other MetricsBatch

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.