Documentation

MetricSample extends Message
in package

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

Table of Contents

Properties

$normalized_timestamp  : mixed
Generated from protobuf field <code>.google.protobuf.Timestamp normalized_timestamp = 2;</code>
$timestamp_ms  : mixed
time of metric based on a monotonic clock (in milliseconds)
$value  : mixed
Generated from protobuf field <code>float value = 3;</code>

Methods

__construct()  : mixed
Constructor.
clearNormalizedTimestamp()  : mixed
getNormalizedTimestamp()  : Timestamp|null
Generated from protobuf field <code>.google.protobuf.Timestamp normalized_timestamp = 2;</code>
getTimestampMs()  : int|string
time of metric based on a monotonic clock (in milliseconds)
getValue()  : float
Generated from protobuf field <code>float value = 3;</code>
hasNormalizedTimestamp()  : mixed
setNormalizedTimestamp()  : $this
Generated from protobuf field <code>.google.protobuf.Timestamp normalized_timestamp = 2;</code>
setTimestampMs()  : $this
time of metric based on a monotonic clock (in milliseconds)
setValue()  : $this
Generated from protobuf field <code>float value = 3;</code>

Properties

$normalized_timestamp

Generated from protobuf field <code>.google.protobuf.Timestamp normalized_timestamp = 2;</code>

protected mixed $normalized_timestamp = null

$timestamp_ms

time of metric based on a monotonic clock (in milliseconds)

protected mixed $timestamp_ms = 0

Generated from protobuf field int64 timestamp_ms = 1;

$value

Generated from protobuf field <code>float value = 3;</code>

protected mixed $value = 0.0

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|string $timestamp_ms
      time of metric based on a monotonic clock (in milliseconds)
@type \Google\Protobuf\Timestamp $normalized_timestamp
@type float $value

}

clearNormalizedTimestamp()

public clearNormalizedTimestamp() : mixed

getNormalizedTimestamp()

Generated from protobuf field <code>.google.protobuf.Timestamp normalized_timestamp = 2;</code>

public getNormalizedTimestamp() : Timestamp|null
Return values
Timestamp|null

getTimestampMs()

time of metric based on a monotonic clock (in milliseconds)

public getTimestampMs() : int|string

Generated from protobuf field int64 timestamp_ms = 1;

Return values
int|string

getValue()

Generated from protobuf field <code>float value = 3;</code>

public getValue() : float
Return values
float

hasNormalizedTimestamp()

public hasNormalizedTimestamp() : mixed

setNormalizedTimestamp()

Generated from protobuf field <code>.google.protobuf.Timestamp normalized_timestamp = 2;</code>

public setNormalizedTimestamp(Timestamp $var) : $this
Parameters
$var : Timestamp
Return values
$this

setTimestampMs()

time of metric based on a monotonic clock (in milliseconds)

public setTimestampMs(int|string $var) : $this

Generated from protobuf field int64 timestamp_ms = 1;

Parameters
$var : int|string
Return values
$this

setValue()

Generated from protobuf field <code>float value = 3;</code>

public setValue(float $var) : $this
Parameters
$var : float
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results