Documentation

MetricLabel
in package

index from [0: MAX_LABEL_PREDEFINED_MAX_VALUE) are for predefined labels (`MetricLabel`)

Protobuf type livekit.MetricLabel

Table of Contents

Constants

AGENTS_LLM_TTFT  = 0
time to first token from LLM
AGENTS_STT_TTFT  = 1
time to final transcription
AGENTS_TTS_TTFB  = 2
time to first byte
CLIENT_AUDIO_SUBSCRIBER_CONCEALED_SAMPLES  = 7
number of concealed (synthesized) audio samples
CLIENT_AUDIO_SUBSCRIBER_CONCEALMENT_EVENTS  = 9
number of concealment events
CLIENT_AUDIO_SUBSCRIBER_INTERRUPTION_COUNT  = 10
number of interruptions
CLIENT_AUDIO_SUBSCRIBER_SILENT_CONCEALED_SAMPLES  = 8
number of silent concealed samples
CLIENT_AUDIO_SUBSCRIBER_TOTAL_INTERRUPTION_DURATION  = 11
total duration of interruptions
CLIENT_SUBSCRIBER_JITTER_BUFFER_DELAY  = 12
total time spent in jitter buffer
CLIENT_SUBSCRIBER_JITTER_BUFFER_EMITTED_COUNT  = 13
total time spent in jitter buffer
CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_BANDWIDTH  = 14
total duration spent in bandwidth quality limitation
CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_CPU  = 15
total duration spent in cpu quality limitation
CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_OTHER  = 16
total duration spent in other quality limitation
CLIENT_VIDEO_SUBSCRIBER_FREEZE_COUNT  = 3
Number of video freezes
CLIENT_VIDEO_SUBSCRIBER_PAUSE_COUNT  = 5
number of video pauses
CLIENT_VIDEO_SUBSCRIBER_TOTAL_FREEZE_DURATION  = 4
total duration of freezes
CLIENT_VIDEO_SUBSCRIBER_TOTAL_PAUSES_DURATION  = 6
total duration of pauses
METRIC_LABEL_PREDEFINED_MAX_VALUE  = 4096
Generated from protobuf enum <code>METRIC_LABEL_PREDEFINED_MAX_VALUE = 4096;</code>
PUBLISHER_RTT  = 17
Publisher RTT (participant -> server)
SERVER_MESH_RTT  = 18
RTT between publisher node and subscriber node (could involve intermedia node(s))
SUBSCRIBER_RTT  = 19
Subscribe RTT (server -> participant)

Properties

$valueToName  : mixed

Methods

name()  : mixed
value()  : mixed

Constants

AGENTS_LLM_TTFT

time to first token from LLM

public mixed AGENTS_LLM_TTFT = 0

Generated from protobuf enum AGENTS_LLM_TTFT = 0;

AGENTS_STT_TTFT

time to final transcription

public mixed AGENTS_STT_TTFT = 1

Generated from protobuf enum AGENTS_STT_TTFT = 1;

AGENTS_TTS_TTFB

time to first byte

public mixed AGENTS_TTS_TTFB = 2

Generated from protobuf enum AGENTS_TTS_TTFB = 2;

CLIENT_AUDIO_SUBSCRIBER_CONCEALED_SAMPLES

number of concealed (synthesized) audio samples

public mixed CLIENT_AUDIO_SUBSCRIBER_CONCEALED_SAMPLES = 7

Generated from protobuf enum CLIENT_AUDIO_SUBSCRIBER_CONCEALED_SAMPLES = 7;

CLIENT_AUDIO_SUBSCRIBER_CONCEALMENT_EVENTS

number of concealment events

public mixed CLIENT_AUDIO_SUBSCRIBER_CONCEALMENT_EVENTS = 9

Generated from protobuf enum CLIENT_AUDIO_SUBSCRIBER_CONCEALMENT_EVENTS = 9;

CLIENT_AUDIO_SUBSCRIBER_INTERRUPTION_COUNT

number of interruptions

public mixed CLIENT_AUDIO_SUBSCRIBER_INTERRUPTION_COUNT = 10

Generated from protobuf enum CLIENT_AUDIO_SUBSCRIBER_INTERRUPTION_COUNT = 10;

CLIENT_AUDIO_SUBSCRIBER_SILENT_CONCEALED_SAMPLES

number of silent concealed samples

public mixed CLIENT_AUDIO_SUBSCRIBER_SILENT_CONCEALED_SAMPLES = 8

Generated from protobuf enum CLIENT_AUDIO_SUBSCRIBER_SILENT_CONCEALED_SAMPLES = 8;

CLIENT_AUDIO_SUBSCRIBER_TOTAL_INTERRUPTION_DURATION

total duration of interruptions

public mixed CLIENT_AUDIO_SUBSCRIBER_TOTAL_INTERRUPTION_DURATION = 11

Generated from protobuf enum CLIENT_AUDIO_SUBSCRIBER_TOTAL_INTERRUPTION_DURATION = 11;

CLIENT_SUBSCRIBER_JITTER_BUFFER_DELAY

total time spent in jitter buffer

public mixed CLIENT_SUBSCRIBER_JITTER_BUFFER_DELAY = 12

Generated from protobuf enum CLIENT_SUBSCRIBER_JITTER_BUFFER_DELAY = 12;

CLIENT_SUBSCRIBER_JITTER_BUFFER_EMITTED_COUNT

total time spent in jitter buffer

public mixed CLIENT_SUBSCRIBER_JITTER_BUFFER_EMITTED_COUNT = 13

Generated from protobuf enum CLIENT_SUBSCRIBER_JITTER_BUFFER_EMITTED_COUNT = 13;

CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_BANDWIDTH

total duration spent in bandwidth quality limitation

public mixed CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_BANDWIDTH = 14

Generated from protobuf enum CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_BANDWIDTH = 14;

CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_CPU

total duration spent in cpu quality limitation

public mixed CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_CPU = 15

Generated from protobuf enum CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_CPU = 15;

CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_OTHER

total duration spent in other quality limitation

public mixed CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_OTHER = 16

Generated from protobuf enum CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_OTHER = 16;

CLIENT_VIDEO_SUBSCRIBER_FREEZE_COUNT

Number of video freezes

public mixed CLIENT_VIDEO_SUBSCRIBER_FREEZE_COUNT = 3

Generated from protobuf enum CLIENT_VIDEO_SUBSCRIBER_FREEZE_COUNT = 3;

CLIENT_VIDEO_SUBSCRIBER_PAUSE_COUNT

number of video pauses

public mixed CLIENT_VIDEO_SUBSCRIBER_PAUSE_COUNT = 5

Generated from protobuf enum CLIENT_VIDEO_SUBSCRIBER_PAUSE_COUNT = 5;

CLIENT_VIDEO_SUBSCRIBER_TOTAL_FREEZE_DURATION

total duration of freezes

public mixed CLIENT_VIDEO_SUBSCRIBER_TOTAL_FREEZE_DURATION = 4

Generated from protobuf enum CLIENT_VIDEO_SUBSCRIBER_TOTAL_FREEZE_DURATION = 4;

CLIENT_VIDEO_SUBSCRIBER_TOTAL_PAUSES_DURATION

total duration of pauses

public mixed CLIENT_VIDEO_SUBSCRIBER_TOTAL_PAUSES_DURATION = 6

Generated from protobuf enum CLIENT_VIDEO_SUBSCRIBER_TOTAL_PAUSES_DURATION = 6;

METRIC_LABEL_PREDEFINED_MAX_VALUE

Generated from protobuf enum <code>METRIC_LABEL_PREDEFINED_MAX_VALUE = 4096;</code>

public mixed METRIC_LABEL_PREDEFINED_MAX_VALUE = 4096

PUBLISHER_RTT

Publisher RTT (participant -> server)

public mixed PUBLISHER_RTT = 17

Generated from protobuf enum PUBLISHER_RTT = 17;

SERVER_MESH_RTT

RTT between publisher node and subscriber node (could involve intermedia node(s))

public mixed SERVER_MESH_RTT = 18

Generated from protobuf enum SERVER_MESH_RTT = 18;

SUBSCRIBER_RTT

Subscribe RTT (server -> participant)

public mixed SUBSCRIBER_RTT = 19

Generated from protobuf enum SUBSCRIBER_RTT = 19;

Properties

$valueToName

private static mixed $valueToName = [self::AGENTS_LLM_TTFT => 'AGENTS_LLM_TTFT', self::AGENTS_STT_TTFT => 'AGENTS_STT_TTFT', self::AGENTS_TTS_TTFB => 'AGENTS_TTS_TTFB', self::CLIENT_VIDEO_SUBSCRIBER_FREEZE_COUNT => 'CLIENT_VIDEO_SUBSCRIBER_FREEZE_COUNT', self::CLIENT_VIDEO_SUBSCRIBER_TOTAL_FREEZE_DURATION => 'CLIENT_VIDEO_SUBSCRIBER_TOTAL_FREEZE_DURATION', self::CLIENT_VIDEO_SUBSCRIBER_PAUSE_COUNT => 'CLIENT_VIDEO_SUBSCRIBER_PAUSE_COUNT', self::CLIENT_VIDEO_SUBSCRIBER_TOTAL_PAUSES_DURATION => 'CLIENT_VIDEO_SUBSCRIBER_TOTAL_PAUSES_DURATION', self::CLIENT_AUDIO_SUBSCRIBER_CONCEALED_SAMPLES => 'CLIENT_AUDIO_SUBSCRIBER_CONCEALED_SAMPLES', self::CLIENT_AUDIO_SUBSCRIBER_SILENT_CONCEALED_SAMPLES => 'CLIENT_AUDIO_SUBSCRIBER_SILENT_CONCEALED_SAMPLES', self::CLIENT_AUDIO_SUBSCRIBER_CONCEALMENT_EVENTS => 'CLIENT_AUDIO_SUBSCRIBER_CONCEALMENT_EVENTS', self::CLIENT_AUDIO_SUBSCRIBER_INTERRUPTION_COUNT => 'CLIENT_AUDIO_SUBSCRIBER_INTERRUPTION_COUNT', self::CLIENT_AUDIO_SUBSCRIBER_TOTAL_INTERRUPTION_DURATION => 'CLIENT_AUDIO_SUBSCRIBER_TOTAL_INTERRUPTION_DURATION', self::CLIENT_SUBSCRIBER_JITTER_BUFFER_DELAY => 'CLIENT_SUBSCRIBER_JITTER_BUFFER_DELAY', self::CLIENT_SUBSCRIBER_JITTER_BUFFER_EMITTED_COUNT => 'CLIENT_SUBSCRIBER_JITTER_BUFFER_EMITTED_COUNT', self::CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_BANDWIDTH => 'CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_BANDWIDTH', self::CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_CPU => 'CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_CPU', self::CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_OTHER => 'CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_OTHER', self::PUBLISHER_RTT => 'PUBLISHER_RTT', self::SERVER_MESH_RTT => 'SERVER_MESH_RTT', self::SUBSCRIBER_RTT => 'SUBSCRIBER_RTT', self::METRIC_LABEL_PREDEFINED_MAX_VALUE => 'METRIC_LABEL_PREDEFINED_MAX_VALUE']

Methods

name()

public static name(mixed $value) : mixed
Parameters
$value : mixed

value()

public static value(mixed $name) : mixed
Parameters
$name : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results