Documentation

AnalyticsStat extends Message
in package

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

Table of Contents

Properties

$analytics_key  : mixed
Generated from protobuf field <code>string analytics_key = 1;</code>
$id  : mixed
unique id for this stat
$kind  : mixed
Generated from protobuf field <code>.livekit.StreamType kind = 2;</code>
$median_score  : mixed
Generated from protobuf field <code>float median_score = 13;</code>
$mime  : mixed
Generated from protobuf field <code>string mime = 11;</code>
$min_score  : mixed
Generated from protobuf field <code>float min_score = 12;</code>
$node  : mixed
Generated from protobuf field <code>string node = 4;</code>
$participant_id  : mixed
Generated from protobuf field <code>string participant_id = 7;</code>
$room_id  : mixed
Generated from protobuf field <code>string room_id = 5;</code>
$room_name  : mixed
Generated from protobuf field <code>string room_name = 6;</code>
$score  : mixed
average score
$time_stamp  : mixed
Generated from protobuf field <code>.google.protobuf.Timestamp time_stamp = 3;</code>
$track_id  : mixed
Generated from protobuf field <code>string track_id = 8;</code>
$streams  : mixed
Generated from protobuf field <code>repeated .livekit.AnalyticsStream streams = 10;</code>

Methods

__construct()  : mixed
Constructor.
clearTimeStamp()  : mixed
getAnalyticsKey()  : string
Generated from protobuf field <code>string analytics_key = 1;</code>
getId()  : string
unique id for this stat
getKind()  : int
Generated from protobuf field <code>.livekit.StreamType kind = 2;</code>
getMedianScore()  : float
Generated from protobuf field <code>float median_score = 13;</code>
getMime()  : string
Generated from protobuf field <code>string mime = 11;</code>
getMinScore()  : float
Generated from protobuf field <code>float min_score = 12;</code>
getNode()  : string
Generated from protobuf field <code>string node = 4;</code>
getParticipantId()  : string
Generated from protobuf field <code>string participant_id = 7;</code>
getRoomId()  : string
Generated from protobuf field <code>string room_id = 5;</code>
getRoomName()  : string
Generated from protobuf field <code>string room_name = 6;</code>
getScore()  : float
average score
getStreams()  : RepeatedField<string|int, AnalyticsStream>
Generated from protobuf field <code>repeated .livekit.AnalyticsStream streams = 10;</code>
getTimeStamp()  : Timestamp|null
Generated from protobuf field <code>.google.protobuf.Timestamp time_stamp = 3;</code>
getTrackId()  : string
Generated from protobuf field <code>string track_id = 8;</code>
hasTimeStamp()  : mixed
setAnalyticsKey()  : $this
Generated from protobuf field <code>string analytics_key = 1;</code>
setId()  : $this
unique id for this stat
setKind()  : $this
Generated from protobuf field <code>.livekit.StreamType kind = 2;</code>
setMedianScore()  : $this
Generated from protobuf field <code>float median_score = 13;</code>
setMime()  : $this
Generated from protobuf field <code>string mime = 11;</code>
setMinScore()  : $this
Generated from protobuf field <code>float min_score = 12;</code>
setNode()  : $this
Generated from protobuf field <code>string node = 4;</code>
setParticipantId()  : $this
Generated from protobuf field <code>string participant_id = 7;</code>
setRoomId()  : $this
Generated from protobuf field <code>string room_id = 5;</code>
setRoomName()  : $this
Generated from protobuf field <code>string room_name = 6;</code>
setScore()  : $this
average score
setStreams()  : $this
Generated from protobuf field <code>repeated .livekit.AnalyticsStream streams = 10;</code>
setTimeStamp()  : $this
Generated from protobuf field <code>.google.protobuf.Timestamp time_stamp = 3;</code>
setTrackId()  : $this
Generated from protobuf field <code>string track_id = 8;</code>

Properties

$analytics_key

Generated from protobuf field <code>string analytics_key = 1;</code>

protected mixed $analytics_key = ''

$id

unique id for this stat

protected mixed $id = ''

Generated from protobuf field string id = 14;

$kind

Generated from protobuf field <code>.livekit.StreamType kind = 2;</code>

protected mixed $kind = 0

$median_score

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

protected mixed $median_score = 0.0

$mime

Generated from protobuf field <code>string mime = 11;</code>

protected mixed $mime = ''

$min_score

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

protected mixed $min_score = 0.0

$node

Generated from protobuf field <code>string node = 4;</code>

protected mixed $node = ''

$participant_id

Generated from protobuf field <code>string participant_id = 7;</code>

protected mixed $participant_id = ''

$room_id

Generated from protobuf field <code>string room_id = 5;</code>

protected mixed $room_id = ''

$room_name

Generated from protobuf field <code>string room_name = 6;</code>

protected mixed $room_name = ''

$score

average score

protected mixed $score = 0.0

Generated from protobuf field float score = 9;

$time_stamp

Generated from protobuf field <code>.google.protobuf.Timestamp time_stamp = 3;</code>

protected mixed $time_stamp = null

$track_id

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

protected mixed $track_id = ''

$streams

Generated from protobuf field <code>repeated .livekit.AnalyticsStream streams = 10;</code>

private mixed $streams

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 string $id
      unique id for this stat
@type string $analytics_key
@type int $kind
@type \Google\Protobuf\Timestamp $time_stamp
@type string $node
@type string $room_id
@type string $room_name
@type string $participant_id
@type string $track_id
@type float $score
      average score
@type \Livekit\AnalyticsStream[] $streams
@type string $mime
@type float $min_score
@type float $median_score

}

getAnalyticsKey()

Generated from protobuf field <code>string analytics_key = 1;</code>

public getAnalyticsKey() : string
Return values
string

getId()

unique id for this stat

public getId() : string

Generated from protobuf field string id = 14;

Return values
string

getKind()

Generated from protobuf field <code>.livekit.StreamType kind = 2;</code>

public getKind() : int
Return values
int

getMedianScore()

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

public getMedianScore() : float
Return values
float

getMime()

Generated from protobuf field <code>string mime = 11;</code>

public getMime() : string
Return values
string

getMinScore()

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

public getMinScore() : float
Return values
float

getNode()

Generated from protobuf field <code>string node = 4;</code>

public getNode() : string
Return values
string

getParticipantId()

Generated from protobuf field <code>string participant_id = 7;</code>

public getParticipantId() : string
Return values
string

getRoomId()

Generated from protobuf field <code>string room_id = 5;</code>

public getRoomId() : string
Return values
string

getRoomName()

Generated from protobuf field <code>string room_name = 6;</code>

public getRoomName() : string
Return values
string

getScore()

average score

public getScore() : float

Generated from protobuf field float score = 9;

Return values
float

getStreams()

Generated from protobuf field <code>repeated .livekit.AnalyticsStream streams = 10;</code>

public getStreams() : RepeatedField<string|int, AnalyticsStream>
Return values
RepeatedField<string|int, AnalyticsStream>

getTimeStamp()

Generated from protobuf field <code>.google.protobuf.Timestamp time_stamp = 3;</code>

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

getTrackId()

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

public getTrackId() : string
Return values
string

setAnalyticsKey()

Generated from protobuf field <code>string analytics_key = 1;</code>

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

setId()

unique id for this stat

public setId(string $var) : $this

Generated from protobuf field string id = 14;

Parameters
$var : string
Return values
$this

setKind()

Generated from protobuf field <code>.livekit.StreamType kind = 2;</code>

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

setMedianScore()

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

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

setMime()

Generated from protobuf field <code>string mime = 11;</code>

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

setMinScore()

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

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

setNode()

Generated from protobuf field <code>string node = 4;</code>

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

setParticipantId()

Generated from protobuf field <code>string participant_id = 7;</code>

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

setRoomId()

Generated from protobuf field <code>string room_id = 5;</code>

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

setRoomName()

Generated from protobuf field <code>string room_name = 6;</code>

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

setScore()

average score

public setScore(float $var) : $this

Generated from protobuf field float score = 9;

Parameters
$var : float
Return values
$this

setStreams()

Generated from protobuf field <code>repeated .livekit.AnalyticsStream streams = 10;</code>

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

setTimeStamp()

Generated from protobuf field <code>.google.protobuf.Timestamp time_stamp = 3;</code>

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

setTrackId()

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

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results