Documentation

EventMetric extends Message
in package

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

Table of Contents

Properties

$end_timestamp_ms  : mixed
end time of event based on a monotonic clock (in milliseconds), if needed
$label  : mixed
Generated from protobuf field <code>uint32 label = 1;</code>
$metadata  : mixed
Generated from protobuf field <code>string metadata = 8;</code>
$normalized_end_timestamp  : mixed
Generated from protobuf field <code>optional .google.protobuf.Timestamp normalized_end_timestamp = 7;</code>
$normalized_start_timestamp  : mixed
Generated from protobuf field <code>.google.protobuf.Timestamp normalized_start_timestamp = 6;</code>
$participant_identity  : mixed
index into `str_data`
$rid  : mixed
index into 'str_data'
$start_timestamp_ms  : mixed
start time of event based on a monotonic clock (in milliseconds)
$track_sid  : mixed
index into `str_data`

Methods

__construct()  : mixed
Constructor.
clearEndTimestampMs()  : mixed
clearNormalizedEndTimestamp()  : mixed
clearNormalizedStartTimestamp()  : mixed
getEndTimestampMs()  : int|string
end time of event based on a monotonic clock (in milliseconds), if needed
getLabel()  : int
Generated from protobuf field <code>uint32 label = 1;</code>
getMetadata()  : string
Generated from protobuf field <code>string metadata = 8;</code>
getNormalizedEndTimestamp()  : Timestamp|null
Generated from protobuf field <code>optional .google.protobuf.Timestamp normalized_end_timestamp = 7;</code>
getNormalizedStartTimestamp()  : Timestamp|null
Generated from protobuf field <code>.google.protobuf.Timestamp normalized_start_timestamp = 6;</code>
getParticipantIdentity()  : int
index into `str_data`
getRid()  : int
index into 'str_data'
getStartTimestampMs()  : int|string
start time of event based on a monotonic clock (in milliseconds)
getTrackSid()  : int
index into `str_data`
hasEndTimestampMs()  : mixed
hasNormalizedEndTimestamp()  : mixed
hasNormalizedStartTimestamp()  : mixed
setEndTimestampMs()  : $this
end time of event based on a monotonic clock (in milliseconds), if needed
setLabel()  : $this
Generated from protobuf field <code>uint32 label = 1;</code>
setMetadata()  : $this
Generated from protobuf field <code>string metadata = 8;</code>
setNormalizedEndTimestamp()  : $this
Generated from protobuf field <code>optional .google.protobuf.Timestamp normalized_end_timestamp = 7;</code>
setNormalizedStartTimestamp()  : $this
Generated from protobuf field <code>.google.protobuf.Timestamp normalized_start_timestamp = 6;</code>
setParticipantIdentity()  : $this
index into `str_data`
setRid()  : $this
index into 'str_data'
setStartTimestampMs()  : $this
start time of event based on a monotonic clock (in milliseconds)
setTrackSid()  : $this
index into `str_data`

Properties

$end_timestamp_ms

end time of event based on a monotonic clock (in milliseconds), if needed

protected mixed $end_timestamp_ms = null

Generated from protobuf field optional int64 end_timestamp_ms = 5;

$label

Generated from protobuf field <code>uint32 label = 1;</code>

protected mixed $label = 0

$metadata

Generated from protobuf field <code>string metadata = 8;</code>

protected mixed $metadata = ''

$normalized_end_timestamp

Generated from protobuf field <code>optional .google.protobuf.Timestamp normalized_end_timestamp = 7;</code>

protected mixed $normalized_end_timestamp = null

$normalized_start_timestamp

Generated from protobuf field <code>.google.protobuf.Timestamp normalized_start_timestamp = 6;</code>

protected mixed $normalized_start_timestamp = null

$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 = 9;

$start_timestamp_ms

start time of event based on a monotonic clock (in milliseconds)

protected mixed $start_timestamp_ms = 0

Generated from protobuf field int64 start_timestamp_ms = 4;

$track_sid

index into `str_data`

protected mixed $track_sid = 0

Generated from protobuf field uint32 track_sid = 3;

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
@type int $participant_identity
      index into `str_data`
@type int $track_sid
      index into `str_data`
@type int|string $start_timestamp_ms
      start time of event based on a monotonic clock (in milliseconds)
@type int|string $end_timestamp_ms
      end time of event based on a monotonic clock (in milliseconds), if needed
@type \Google\Protobuf\Timestamp $normalized_start_timestamp
@type \Google\Protobuf\Timestamp $normalized_end_timestamp
@type string $metadata
@type int $rid
      index into 'str_data'

}

clearEndTimestampMs()

public clearEndTimestampMs() : mixed

clearNormalizedEndTimestamp()

public clearNormalizedEndTimestamp() : mixed

clearNormalizedStartTimestamp()

public clearNormalizedStartTimestamp() : mixed

getEndTimestampMs()

end time of event based on a monotonic clock (in milliseconds), if needed

public getEndTimestampMs() : int|string

Generated from protobuf field optional int64 end_timestamp_ms = 5;

Return values
int|string

getLabel()

Generated from protobuf field <code>uint32 label = 1;</code>

public getLabel() : int
Return values
int

getMetadata()

Generated from protobuf field <code>string metadata = 8;</code>

public getMetadata() : string
Return values
string

getNormalizedEndTimestamp()

Generated from protobuf field <code>optional .google.protobuf.Timestamp normalized_end_timestamp = 7;</code>

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

getNormalizedStartTimestamp()

Generated from protobuf field <code>.google.protobuf.Timestamp normalized_start_timestamp = 6;</code>

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

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 = 9;

Return values
int

getStartTimestampMs()

start time of event based on a monotonic clock (in milliseconds)

public getStartTimestampMs() : int|string

Generated from protobuf field int64 start_timestamp_ms = 4;

Return values
int|string

getTrackSid()

index into `str_data`

public getTrackSid() : int

Generated from protobuf field uint32 track_sid = 3;

Return values
int

hasEndTimestampMs()

public hasEndTimestampMs() : mixed

hasNormalizedEndTimestamp()

public hasNormalizedEndTimestamp() : mixed

hasNormalizedStartTimestamp()

public hasNormalizedStartTimestamp() : mixed

setEndTimestampMs()

end time of event based on a monotonic clock (in milliseconds), if needed

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

Generated from protobuf field optional int64 end_timestamp_ms = 5;

Parameters
$var : int|string
Return values
$this

setLabel()

Generated from protobuf field <code>uint32 label = 1;</code>

public setLabel(int $var) : $this
Parameters
$var : int
Return values
$this

setMetadata()

Generated from protobuf field <code>string metadata = 8;</code>

public setMetadata(string $var) : $this
Parameters
$var : string
Return values
$this

setNormalizedEndTimestamp()

Generated from protobuf field <code>optional .google.protobuf.Timestamp normalized_end_timestamp = 7;</code>

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

setNormalizedStartTimestamp()

Generated from protobuf field <code>.google.protobuf.Timestamp normalized_start_timestamp = 6;</code>

public setNormalizedStartTimestamp(Timestamp $var) : $this
Parameters
$var : Timestamp
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 = 9;

Parameters
$var : int
Return values
$this

setStartTimestampMs()

start time of event based on a monotonic clock (in milliseconds)

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

Generated from protobuf field int64 start_timestamp_ms = 4;

Parameters
$var : int|string
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