Documentation

NodeStatsRate extends Message
in package

rates of different node stats (per second)

Generated from protobuf message livekit.NodeStatsRate

Table of Contents

Properties

$bytes_in  : mixed
Generated from protobuf field <code>float bytes_in = 8;</code>
$bytes_out  : mixed
Generated from protobuf field <code>float bytes_out = 9;</code>
$cpu_load  : mixed
time weighted averages across stats windows forming part of a rate measurement interval
$duration  : mixed
Generated from protobuf field <code>int64 duration = 3;</code>
$ended_at  : mixed
Generated from protobuf field <code>int64 ended_at = 2;</code>
$memory_load  : mixed
Generated from protobuf field <code>float memory_load = 21;</code>
$memory_total  : mixed
Generated from protobuf field <code>float memory_total = 23;</code>
$memory_used  : mixed
Generated from protobuf field <code>float memory_used = 22;</code>
$nack_total  : mixed
Generated from protobuf field <code>float nack_total = 12;</code>
$packets_in  : mixed
Generated from protobuf field <code>float packets_in = 10;</code>
$packets_out  : mixed
Generated from protobuf field <code>float packets_out = 11;</code>
$participant_rtc_canceled  : mixed
Generated from protobuf field <code>float participant_rtc_canceled = 26;</code>
$participant_rtc_connected  : mixed
Generated from protobuf field <code>float participant_rtc_connected = 18;</code>
$participant_rtc_init  : mixed
Generated from protobuf field <code>float participant_rtc_init = 19;</code>
$participant_signal_connected  : mixed
Generated from protobuf field <code>float participant_signal_connected = 17;</code>
$retransmit_bytes_out  : mixed
Generated from protobuf field <code>float retransmit_bytes_out = 15;</code>
$retransmit_packets_out  : mixed
Generated from protobuf field <code>float retransmit_packets_out = 16;</code>
$started_at  : mixed
Generated from protobuf field <code>int64 started_at = 1;</code>
$sys_packets_dropped  : mixed
Generated from protobuf field <code>float sys_packets_dropped = 14;</code>
$sys_packets_out  : mixed
Generated from protobuf field <code>float sys_packets_out = 13;</code>
$track_publish_attempts  : mixed
Generated from protobuf field <code>float track_publish_attempts = 4;</code>
$track_publish_cancels  : mixed
Generated from protobuf field <code>float track_publish_cancels = 24;</code>
$track_publish_success  : mixed
Generated from protobuf field <code>float track_publish_success = 5;</code>
$track_subscribe_attempts  : mixed
Generated from protobuf field <code>float track_subscribe_attempts = 6;</code>
$track_subscribe_cancels  : mixed
Generated from protobuf field <code>float track_subscribe_cancels = 25;</code>
$track_subscribe_success  : mixed
Generated from protobuf field <code>float track_subscribe_success = 7;</code>

Methods

__construct()  : mixed
Constructor.
getBytesIn()  : float
Generated from protobuf field <code>float bytes_in = 8;</code>
getBytesOut()  : float
Generated from protobuf field <code>float bytes_out = 9;</code>
getCpuLoad()  : float
time weighted averages across stats windows forming part of a rate measurement interval
getDuration()  : int|string
Generated from protobuf field <code>int64 duration = 3;</code>
getEndedAt()  : int|string
Generated from protobuf field <code>int64 ended_at = 2;</code>
getMemoryLoad()  : float
Generated from protobuf field <code>float memory_load = 21;</code>
getMemoryTotal()  : float
Generated from protobuf field <code>float memory_total = 23;</code>
getMemoryUsed()  : float
Generated from protobuf field <code>float memory_used = 22;</code>
getNackTotal()  : float
Generated from protobuf field <code>float nack_total = 12;</code>
getPacketsIn()  : float
Generated from protobuf field <code>float packets_in = 10;</code>
getPacketsOut()  : float
Generated from protobuf field <code>float packets_out = 11;</code>
getParticipantRtcCanceled()  : float
Generated from protobuf field <code>float participant_rtc_canceled = 26;</code>
getParticipantRtcConnected()  : float
Generated from protobuf field <code>float participant_rtc_connected = 18;</code>
getParticipantRtcInit()  : float
Generated from protobuf field <code>float participant_rtc_init = 19;</code>
getParticipantSignalConnected()  : float
Generated from protobuf field <code>float participant_signal_connected = 17;</code>
getRetransmitBytesOut()  : float
Generated from protobuf field <code>float retransmit_bytes_out = 15;</code>
getRetransmitPacketsOut()  : float
Generated from protobuf field <code>float retransmit_packets_out = 16;</code>
getStartedAt()  : int|string
Generated from protobuf field <code>int64 started_at = 1;</code>
getSysPacketsDropped()  : float
Generated from protobuf field <code>float sys_packets_dropped = 14;</code>
getSysPacketsOut()  : float
Generated from protobuf field <code>float sys_packets_out = 13;</code>
getTrackPublishAttempts()  : float
Generated from protobuf field <code>float track_publish_attempts = 4;</code>
getTrackPublishCancels()  : float
Generated from protobuf field <code>float track_publish_cancels = 24;</code>
getTrackPublishSuccess()  : float
Generated from protobuf field <code>float track_publish_success = 5;</code>
getTrackSubscribeAttempts()  : float
Generated from protobuf field <code>float track_subscribe_attempts = 6;</code>
getTrackSubscribeCancels()  : float
Generated from protobuf field <code>float track_subscribe_cancels = 25;</code>
getTrackSubscribeSuccess()  : float
Generated from protobuf field <code>float track_subscribe_success = 7;</code>
setBytesIn()  : $this
Generated from protobuf field <code>float bytes_in = 8;</code>
setBytesOut()  : $this
Generated from protobuf field <code>float bytes_out = 9;</code>
setCpuLoad()  : $this
time weighted averages across stats windows forming part of a rate measurement interval
setDuration()  : $this
Generated from protobuf field <code>int64 duration = 3;</code>
setEndedAt()  : $this
Generated from protobuf field <code>int64 ended_at = 2;</code>
setMemoryLoad()  : $this
Generated from protobuf field <code>float memory_load = 21;</code>
setMemoryTotal()  : $this
Generated from protobuf field <code>float memory_total = 23;</code>
setMemoryUsed()  : $this
Generated from protobuf field <code>float memory_used = 22;</code>
setNackTotal()  : $this
Generated from protobuf field <code>float nack_total = 12;</code>
setPacketsIn()  : $this
Generated from protobuf field <code>float packets_in = 10;</code>
setPacketsOut()  : $this
Generated from protobuf field <code>float packets_out = 11;</code>
setParticipantRtcCanceled()  : $this
Generated from protobuf field <code>float participant_rtc_canceled = 26;</code>
setParticipantRtcConnected()  : $this
Generated from protobuf field <code>float participant_rtc_connected = 18;</code>
setParticipantRtcInit()  : $this
Generated from protobuf field <code>float participant_rtc_init = 19;</code>
setParticipantSignalConnected()  : $this
Generated from protobuf field <code>float participant_signal_connected = 17;</code>
setRetransmitBytesOut()  : $this
Generated from protobuf field <code>float retransmit_bytes_out = 15;</code>
setRetransmitPacketsOut()  : $this
Generated from protobuf field <code>float retransmit_packets_out = 16;</code>
setStartedAt()  : $this
Generated from protobuf field <code>int64 started_at = 1;</code>
setSysPacketsDropped()  : $this
Generated from protobuf field <code>float sys_packets_dropped = 14;</code>
setSysPacketsOut()  : $this
Generated from protobuf field <code>float sys_packets_out = 13;</code>
setTrackPublishAttempts()  : $this
Generated from protobuf field <code>float track_publish_attempts = 4;</code>
setTrackPublishCancels()  : $this
Generated from protobuf field <code>float track_publish_cancels = 24;</code>
setTrackPublishSuccess()  : $this
Generated from protobuf field <code>float track_publish_success = 5;</code>
setTrackSubscribeAttempts()  : $this
Generated from protobuf field <code>float track_subscribe_attempts = 6;</code>
setTrackSubscribeCancels()  : $this
Generated from protobuf field <code>float track_subscribe_cancels = 25;</code>
setTrackSubscribeSuccess()  : $this
Generated from protobuf field <code>float track_subscribe_success = 7;</code>

Properties

$bytes_in

Generated from protobuf field <code>float bytes_in = 8;</code>

protected mixed $bytes_in = 0.0

$bytes_out

Generated from protobuf field <code>float bytes_out = 9;</code>

protected mixed $bytes_out = 0.0

$cpu_load

time weighted averages across stats windows forming part of a rate measurement interval

protected mixed $cpu_load = 0.0

Generated from protobuf field float cpu_load = 20;

$duration

Generated from protobuf field <code>int64 duration = 3;</code>

protected mixed $duration = 0

$ended_at

Generated from protobuf field <code>int64 ended_at = 2;</code>

protected mixed $ended_at = 0

$memory_load

Generated from protobuf field <code>float memory_load = 21;</code>

protected mixed $memory_load = 0.0

$memory_total

Generated from protobuf field <code>float memory_total = 23;</code>

protected mixed $memory_total = 0.0

$memory_used

Generated from protobuf field <code>float memory_used = 22;</code>

protected mixed $memory_used = 0.0

$nack_total

Generated from protobuf field <code>float nack_total = 12;</code>

protected mixed $nack_total = 0.0

$packets_in

Generated from protobuf field <code>float packets_in = 10;</code>

protected mixed $packets_in = 0.0

$packets_out

Generated from protobuf field <code>float packets_out = 11;</code>

protected mixed $packets_out = 0.0

$participant_rtc_canceled

Generated from protobuf field <code>float participant_rtc_canceled = 26;</code>

protected mixed $participant_rtc_canceled = 0.0

$participant_rtc_connected

Generated from protobuf field <code>float participant_rtc_connected = 18;</code>

protected mixed $participant_rtc_connected = 0.0

$participant_rtc_init

Generated from protobuf field <code>float participant_rtc_init = 19;</code>

protected mixed $participant_rtc_init = 0.0

$participant_signal_connected

Generated from protobuf field <code>float participant_signal_connected = 17;</code>

protected mixed $participant_signal_connected = 0.0

$retransmit_bytes_out

Generated from protobuf field <code>float retransmit_bytes_out = 15;</code>

protected mixed $retransmit_bytes_out = 0.0

$retransmit_packets_out

Generated from protobuf field <code>float retransmit_packets_out = 16;</code>

protected mixed $retransmit_packets_out = 0.0

$started_at

Generated from protobuf field <code>int64 started_at = 1;</code>

protected mixed $started_at = 0

$sys_packets_dropped

Generated from protobuf field <code>float sys_packets_dropped = 14;</code>

protected mixed $sys_packets_dropped = 0.0

$sys_packets_out

Generated from protobuf field <code>float sys_packets_out = 13;</code>

protected mixed $sys_packets_out = 0.0

$track_publish_attempts

Generated from protobuf field <code>float track_publish_attempts = 4;</code>

protected mixed $track_publish_attempts = 0.0

$track_publish_cancels

Generated from protobuf field <code>float track_publish_cancels = 24;</code>

protected mixed $track_publish_cancels = 0.0

$track_publish_success

Generated from protobuf field <code>float track_publish_success = 5;</code>

protected mixed $track_publish_success = 0.0

$track_subscribe_attempts

Generated from protobuf field <code>float track_subscribe_attempts = 6;</code>

protected mixed $track_subscribe_attempts = 0.0

$track_subscribe_cancels

Generated from protobuf field <code>float track_subscribe_cancels = 25;</code>

protected mixed $track_subscribe_cancels = 0.0

$track_subscribe_success

Generated from protobuf field <code>float track_subscribe_success = 7;</code>

protected mixed $track_subscribe_success = 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 $started_at
@type int|string $ended_at
@type int|string $duration
@type float $track_publish_attempts
@type float $track_publish_success
@type float $track_publish_cancels
@type float $track_subscribe_attempts
@type float $track_subscribe_success
@type float $track_subscribe_cancels
@type float $bytes_in
@type float $bytes_out
@type float $packets_in
@type float $packets_out
@type float $nack_total
@type float $sys_packets_out
@type float $sys_packets_dropped
@type float $retransmit_bytes_out
@type float $retransmit_packets_out
@type float $participant_signal_connected
@type float $participant_rtc_connected
@type float $participant_rtc_init
@type float $participant_rtc_canceled
@type float $cpu_load
      time weighted averages across stats windows forming part of a rate measurement interval
@type float $memory_load
@type float $memory_used
@type float $memory_total

}

getBytesIn()

Generated from protobuf field <code>float bytes_in = 8;</code>

public getBytesIn() : float
Return values
float

getBytesOut()

Generated from protobuf field <code>float bytes_out = 9;</code>

public getBytesOut() : float
Return values
float

getCpuLoad()

time weighted averages across stats windows forming part of a rate measurement interval

public getCpuLoad() : float

Generated from protobuf field float cpu_load = 20;

Return values
float

getDuration()

Generated from protobuf field <code>int64 duration = 3;</code>

public getDuration() : int|string
Return values
int|string

getEndedAt()

Generated from protobuf field <code>int64 ended_at = 2;</code>

public getEndedAt() : int|string
Return values
int|string

getMemoryLoad()

Generated from protobuf field <code>float memory_load = 21;</code>

public getMemoryLoad() : float
Return values
float

getMemoryTotal()

Generated from protobuf field <code>float memory_total = 23;</code>

public getMemoryTotal() : float
Return values
float

getMemoryUsed()

Generated from protobuf field <code>float memory_used = 22;</code>

public getMemoryUsed() : float
Return values
float

getNackTotal()

Generated from protobuf field <code>float nack_total = 12;</code>

public getNackTotal() : float
Return values
float

getPacketsIn()

Generated from protobuf field <code>float packets_in = 10;</code>

public getPacketsIn() : float
Return values
float

getPacketsOut()

Generated from protobuf field <code>float packets_out = 11;</code>

public getPacketsOut() : float
Return values
float

getParticipantRtcCanceled()

Generated from protobuf field <code>float participant_rtc_canceled = 26;</code>

public getParticipantRtcCanceled() : float
Return values
float

getParticipantRtcConnected()

Generated from protobuf field <code>float participant_rtc_connected = 18;</code>

public getParticipantRtcConnected() : float
Return values
float

getParticipantRtcInit()

Generated from protobuf field <code>float participant_rtc_init = 19;</code>

public getParticipantRtcInit() : float
Return values
float

getParticipantSignalConnected()

Generated from protobuf field <code>float participant_signal_connected = 17;</code>

public getParticipantSignalConnected() : float
Return values
float

getRetransmitBytesOut()

Generated from protobuf field <code>float retransmit_bytes_out = 15;</code>

public getRetransmitBytesOut() : float
Return values
float

getRetransmitPacketsOut()

Generated from protobuf field <code>float retransmit_packets_out = 16;</code>

public getRetransmitPacketsOut() : float
Return values
float

getStartedAt()

Generated from protobuf field <code>int64 started_at = 1;</code>

public getStartedAt() : int|string
Return values
int|string

getSysPacketsDropped()

Generated from protobuf field <code>float sys_packets_dropped = 14;</code>

public getSysPacketsDropped() : float
Return values
float

getSysPacketsOut()

Generated from protobuf field <code>float sys_packets_out = 13;</code>

public getSysPacketsOut() : float
Return values
float

getTrackPublishAttempts()

Generated from protobuf field <code>float track_publish_attempts = 4;</code>

public getTrackPublishAttempts() : float
Return values
float

getTrackPublishCancels()

Generated from protobuf field <code>float track_publish_cancels = 24;</code>

public getTrackPublishCancels() : float
Return values
float

getTrackPublishSuccess()

Generated from protobuf field <code>float track_publish_success = 5;</code>

public getTrackPublishSuccess() : float
Return values
float

getTrackSubscribeAttempts()

Generated from protobuf field <code>float track_subscribe_attempts = 6;</code>

public getTrackSubscribeAttempts() : float
Return values
float

getTrackSubscribeCancels()

Generated from protobuf field <code>float track_subscribe_cancels = 25;</code>

public getTrackSubscribeCancels() : float
Return values
float

getTrackSubscribeSuccess()

Generated from protobuf field <code>float track_subscribe_success = 7;</code>

public getTrackSubscribeSuccess() : float
Return values
float

setBytesIn()

Generated from protobuf field <code>float bytes_in = 8;</code>

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

setBytesOut()

Generated from protobuf field <code>float bytes_out = 9;</code>

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

setCpuLoad()

time weighted averages across stats windows forming part of a rate measurement interval

public setCpuLoad(float $var) : $this

Generated from protobuf field float cpu_load = 20;

Parameters
$var : float
Return values
$this

setDuration()

Generated from protobuf field <code>int64 duration = 3;</code>

public setDuration(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setEndedAt()

Generated from protobuf field <code>int64 ended_at = 2;</code>

public setEndedAt(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setMemoryLoad()

Generated from protobuf field <code>float memory_load = 21;</code>

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

setMemoryTotal()

Generated from protobuf field <code>float memory_total = 23;</code>

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

setMemoryUsed()

Generated from protobuf field <code>float memory_used = 22;</code>

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

setNackTotal()

Generated from protobuf field <code>float nack_total = 12;</code>

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

setPacketsIn()

Generated from protobuf field <code>float packets_in = 10;</code>

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

setPacketsOut()

Generated from protobuf field <code>float packets_out = 11;</code>

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

setParticipantRtcCanceled()

Generated from protobuf field <code>float participant_rtc_canceled = 26;</code>

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

setParticipantRtcConnected()

Generated from protobuf field <code>float participant_rtc_connected = 18;</code>

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

setParticipantRtcInit()

Generated from protobuf field <code>float participant_rtc_init = 19;</code>

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

setParticipantSignalConnected()

Generated from protobuf field <code>float participant_signal_connected = 17;</code>

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

setRetransmitBytesOut()

Generated from protobuf field <code>float retransmit_bytes_out = 15;</code>

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

setRetransmitPacketsOut()

Generated from protobuf field <code>float retransmit_packets_out = 16;</code>

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

setStartedAt()

Generated from protobuf field <code>int64 started_at = 1;</code>

public setStartedAt(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setSysPacketsDropped()

Generated from protobuf field <code>float sys_packets_dropped = 14;</code>

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

setSysPacketsOut()

Generated from protobuf field <code>float sys_packets_out = 13;</code>

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

setTrackPublishAttempts()

Generated from protobuf field <code>float track_publish_attempts = 4;</code>

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

setTrackPublishCancels()

Generated from protobuf field <code>float track_publish_cancels = 24;</code>

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

setTrackPublishSuccess()

Generated from protobuf field <code>float track_publish_success = 5;</code>

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

setTrackSubscribeAttempts()

Generated from protobuf field <code>float track_subscribe_attempts = 6;</code>

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

setTrackSubscribeCancels()

Generated from protobuf field <code>float track_subscribe_cancels = 25;</code>

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

setTrackSubscribeSuccess()

Generated from protobuf field <code>float track_subscribe_success = 7;</code>

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results