Shaka Player Embedded
Classes | Public Member Functions | List of all members
shaka::Stats Class Referencefinal
Public Types » JavaScript Externs

#include <stats.h>

Classes

class  Impl
 

Public Member Functions

 Stats ()
 
 Stats (js::Stats &&internal)
 
 Stats (const Stats &)
 
 Stats (Stats &&)
 
 ~Stats ()
 
Stats & operator= (const Stats &)
 
Stats & operator= (Stats &&)
 
double width () const
 
double height () const
 
double stream_bandwidth () const
 
double decoded_frames () const
 
double dropped_frames () const
 
double estimated_bandwidth () const
 
double load_latency () const
 
double play_time () const
 
double buffering_time () const
 
const std::vector< shaka::TrackChoice > & switch_history () const
 
const std::vector< shaka::StateChange > & state_history () const
 
js::Stats GetInternal () const
 

Detailed Description

Contains statistics and information about the current state of the player. This is meant for applications that want to log quality-of-experience (QoE) or other stats. These values will reset when load() is called again.

Definition at line 125 of file stats.h.

Constructor & Destructor Documentation

§ Stats() [1/4]

shaka::Stats::Stats ( )

Definition at line 154 of file stats.cc.

§ Stats() [2/4]

shaka::Stats::Stats ( js::Stats &&  internal)

Definition at line 155 of file stats.cc.

§ Stats() [3/4]

shaka::Stats::Stats ( const Stats &  )
default

§ Stats() [4/4]

shaka::Stats::Stats ( Stats &&  )
default

§ ~Stats()

shaka::Stats::~Stats ( )

Definition at line 158 of file stats.cc.

Member Function Documentation

§ buffering_time()

double shaka::Stats::buffering_time ( ) const

The total time spent in a buffering state in seconds.

Definition at line 195 of file stats.cc.

§ decoded_frames()

double shaka::Stats::decoded_frames ( ) const

The total number of frames decoded by the Player. This may be NaN if this is not supported by the browser.

Definition at line 175 of file stats.cc.

§ dropped_frames()

double shaka::Stats::dropped_frames ( ) const

The total number of frames dropped by the Player. This may be NaN if this is not supported by the browser.

Definition at line 179 of file stats.cc.

§ estimated_bandwidth()

double shaka::Stats::estimated_bandwidth ( ) const

The current estimated network bandwidth (in bit/sec).

Definition at line 183 of file stats.cc.

§ GetInternal()

js::Stats shaka::Stats::GetInternal ( ) const

INTERNAL USE ONLY: Get the internal representation of this object.

Definition at line 208 of file stats.cc.

§ height()

double shaka::Stats::height ( ) const

The height of the current video track.

Definition at line 167 of file stats.cc.

§ load_latency()

double shaka::Stats::load_latency ( ) const

This is the number of seconds it took for the video element to have enough data to begin playback. This is measured from the time load() is called to the time the 'loadeddata' event is fired by the media element.

Definition at line 187 of file stats.cc.

§ operator=() [1/2]

Stats & shaka::Stats::operator= ( const Stats &  )
default

§ operator=() [2/2]

Stats & shaka::Stats::operator= ( Stats &&  )
default

§ play_time()

double shaka::Stats::play_time ( ) const

The total time spent in a playing state in seconds.

Definition at line 191 of file stats.cc.

§ state_history()

const std::vector< shaka::StateChange > & shaka::Stats::state_history ( ) const

A history of the state changes.

Definition at line 203 of file stats.cc.

§ stream_bandwidth()

double shaka::Stats::stream_bandwidth ( ) const

The bandwidth required for the current streams (total, in bit/sec).

Definition at line 171 of file stats.cc.

§ switch_history()

const std::vector< shaka::TrackChoice > & shaka::Stats::switch_history ( ) const

A history of the stream changes.

Definition at line 199 of file stats.cc.

§ width()

double shaka::Stats::width ( ) const

The width of the current video track.

Definition at line 163 of file stats.cc.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.13