Documentation

TimeSeriesMetric extends Message
in package

Generated from protobuf message <code>livekit.TimeSeriesMetric</code>

Table of Contents

Properties

$label  : mixed
Metric name e.g "speech_probablity". The string value is not directly stored in the message, but referenced by index in the `str_data` field of `MetricsBatch`
$participant_identity  : mixed
index into `str_data`
$rid  : mixed
index into 'str_data'
$track_sid  : mixed
index into `str_data`
$samples  : mixed
Generated from protobuf field <code>repeated .livekit.MetricSample samples = 4;</code>

Methods

__construct()  : mixed
Constructor.
getLabel()  : int
Metric name e.g "speech_probablity". The string value is not directly stored in the message, but referenced by index in the `str_data` field of `MetricsBatch`
getParticipantIdentity()  : int
index into `str_data`
getRid()  : int
index into 'str_data'
getSamples()  : RepeatedField<string|int, MetricSample>
Generated from protobuf field <code>repeated .livekit.MetricSample samples = 4;</code>
getTrackSid()  : int
index into `str_data`
setLabel()  : $this
Metric name e.g "speech_probablity". The string value is not directly stored in the message, but referenced by index in the `str_data` field of `MetricsBatch`
setParticipantIdentity()  : $this
index into `str_data`
setRid()  : $this
index into 'str_data'
setSamples()  : $this
Generated from protobuf field <code>repeated .livekit.MetricSample samples = 4;</code>
setTrackSid()  : $this
index into `str_data`

Properties

$label

Metric name e.g "speech_probablity". The string value is not directly stored in the message, but referenced by index in the `str_data` field of `MetricsBatch`

protected mixed $label = 0

Generated from protobuf field uint32 label = 1;

$participant_identity

index into `str_data`

protected mixed $participant_identity = 0

Generated from protobuf field uint32 participant_identity = 2;

$rid

index into 'str_data'

protected mixed $rid = 0

Generated from protobuf field uint32 rid = 5;

$track_sid

index into `str_data`

protected mixed $track_sid = 0

Generated from protobuf field uint32 track_sid = 3;

$samples

Generated from protobuf field <code>repeated .livekit.MetricSample samples = 4;</code>

private mixed $samples

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

{ Optional. Data for populating the Message object.

@type int $label
      Metric name e.g "speech_probablity". The string value is not directly stored in the message, but referenced by index
      in the `str_data` field of `MetricsBatch`
@type int $participant_identity
      index into `str_data`
@type int $track_sid
      index into `str_data`
@type \Livekit\MetricSample[] $samples
@type int $rid
      index into 'str_data'

}

getLabel()

Metric name e.g "speech_probablity". The string value is not directly stored in the message, but referenced by index in the `str_data` field of `MetricsBatch`

public getLabel() : int

Generated from protobuf field uint32 label = 1;

Return values
int

getParticipantIdentity()

index into `str_data`

public getParticipantIdentity() : int

Generated from protobuf field uint32 participant_identity = 2;

Return values
int

getRid()

index into 'str_data'

public getRid() : int

Generated from protobuf field uint32 rid = 5;

Return values
int

getSamples()

Generated from protobuf field <code>repeated .livekit.MetricSample samples = 4;</code>

public getSamples() : RepeatedField<string|int, MetricSample>
Return values
RepeatedField<string|int, MetricSample>

getTrackSid()

index into `str_data`

public getTrackSid() : int

Generated from protobuf field uint32 track_sid = 3;

Return values
int

setLabel()

Metric name e.g "speech_probablity". The string value is not directly stored in the message, but referenced by index in the `str_data` field of `MetricsBatch`

public setLabel(int $var) : $this

Generated from protobuf field uint32 label = 1;

Parameters
$var : int
Return values
$this

setParticipantIdentity()

index into `str_data`

public setParticipantIdentity(int $var) : $this

Generated from protobuf field uint32 participant_identity = 2;

Parameters
$var : int
Return values
$this

setRid()

index into 'str_data'

public setRid(int $var) : $this

Generated from protobuf field uint32 rid = 5;

Parameters
$var : int
Return values
$this

setSamples()

Generated from protobuf field <code>repeated .livekit.MetricSample samples = 4;</code>

public setSamples(array<string|int, MetricSample> $var) : $this
Parameters
$var : array<string|int, MetricSample>
Return values
$this

setTrackSid()

index into `str_data`

public setTrackSid(int $var) : $this

Generated from protobuf field uint32 track_sid = 3;

Parameters
$var : int
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results