Class MetricsRecordingHeader

Inheritance

object

MetricsRecordingHeader

Implements

IMessage<MetricsRecordingHeader>

IEquatable<MetricsRecordingHeader>

IDeepCloneable<MetricsRecordingHeader>

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

Constructors

MetricsRecordingHeader()

Declaration

public MetricsRecordingHeader()

MetricsRecordingHeader(MetricsRecordingHeader)

Declaration

public MetricsRecordingHeader(MetricsRecordingHeader other)

Parameters

Type	Name	Description
MetricsRecordingHeader	other

Fields

DurationFieldNumber

Field number for the "duration" field.

Declaration

public const int DurationFieldNumber = 3

Field Value

Type	Description
int

JobIdFieldNumber

Field number for the "job_id" field.

Declaration

public const int JobIdFieldNumber = 8

Field Value

Type	Description
int

RedactionEnabledFieldNumber

Field number for the "redaction_enabled" field.

Declaration

public const int RedactionEnabledFieldNumber = 10

Field Value

Type	Description
int

RoomIdFieldNumber

Field number for the "room_id" field.

Declaration

public const int RoomIdFieldNumber = 1

Field Value

Type	Description
int

RoomNameFieldNumber

Field number for the "room_name" field.

Declaration

public const int RoomNameFieldNumber = 6

Field Value

Type	Description
int

RoomStartTimeFieldNumber

Field number for the "room_start_time" field.

Declaration

public const int RoomStartTimeFieldNumber = 7

Field Value

Type	Description
int

RoomTagsFieldNumber

Field number for the "room_tags" field.

Declaration

public const int RoomTagsFieldNumber = 5

Field Value

Type	Description
int

SessionSummaryFieldNumber

Field number for the "session_summary" field.

Declaration

public const int SessionSummaryFieldNumber = 11

Field Value

Type	Description
int

SimulatedFieldNumber

Field number for the "simulated" field.

Declaration

public const int SimulatedFieldNumber = 9

Field Value

Type	Description
int

StartTimeFieldNumber

Field number for the "start_time" field.

Declaration

public const int StartTimeFieldNumber = 4

Field Value

Type	Description
int

Properties

Descriptor

Declaration

public static MessageDescriptor Descriptor { get; }

Property Value

Type	Description
MessageDescriptor

Duration

milliseconds

Declaration

public ulong Duration { get; set; }

Property Value

Type	Description
ulong

JobId

Declaration

public string JobId { get; set; }

Property Value

Type	Description
string

Parser

Declaration

public static MessageParser<MetricsRecordingHeader> Parser { get; }

Property Value

Type	Description
MessageParser<MetricsRecordingHeader>

RedactionEnabled

force PII redaction on for this session (only ever enables, never disables)

Declaration

public bool RedactionEnabled { get; set; }

Property Value

Type	Description
bool

RoomId

Declaration

public string RoomId { get; set; }

Property Value

Type	Description
string

RoomName

Declaration

public string RoomName { get; set; }

Property Value

Type	Description
string

RoomStartTime

Declaration

public Timestamp RoomStartTime { get; set; }

Property Value

Type	Description
Timestamp

RoomTags

Declaration

public MapField<string, string> RoomTags { get; }

Property Value

Type	Description
MapField<string, string>

SessionSummary

JSON object of session facts for agent evals, at most 16 KiB. Its schema is evalschema/session-summary.schema.json in livekit/cloud-protocol. The collector stores it without reading individual keys.

Declaration

public string SessionSummary { get; set; }

Property Value

Type	Description
string

Simulated

session is a simulation; the collector skips PII redaction for it unless redaction_enabled is set

Declaration

public bool Simulated { get; set; }

Property Value

Type	Description
bool

StartTime

Declaration

public Timestamp StartTime { get; set; }

Property Value

Type	Description
Timestamp

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

Returns

Type	Description
MetricsRecordingHeader	A deep clone of this object.

Equals(MetricsRecordingHeader)

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

Declaration

public bool Equals(MetricsRecordingHeader other)

Parameters

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

Merges the given message into this one.

Declaration

public void MergeFrom(MetricsRecordingHeader other)

Parameters

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