You.i Engine
CYIAbstractVideoPlayer::Statistics Struct Reference

Detailed Description

A source of statistical metadata from a player.

See also
CYIAbstractVideoPlayer::GetStatistics

#include <player/YiAbstractVideoPlayer.h>

Public Member Functions

 Statistics ()
 
 Statistics (const Statistics &other)
 
Statisticsoperator= (const Statistics &other)
 
bool operator== (const Statistics &other) const
 
bool operator!= (const Statistics &other) const
 

Public Attributes

bool bIsLive
 
float fBitrateKbps
 
float fDefaultBitrateKbps
 
float fBufferLengthMs
 
float fMinimumBufferLengthMs
 
float fFramesPerSecond
 

Constructor & Destructor Documentation

CYIAbstractVideoPlayer::Statistics::Statistics ( )

Creates an empty player Statistics object. Unavailable or unapplicable non-boolean variables will be set to -1.0f by default.

CYIAbstractVideoPlayer::Statistics::Statistics ( const Statistics other)

Member Function Documentation

bool CYIAbstractVideoPlayer::Statistics::operator!= ( const Statistics other) const
Statistics& CYIAbstractVideoPlayer::Statistics::operator= ( const Statistics other)
bool CYIAbstractVideoPlayer::Statistics::operator== ( const Statistics other) const

Member Data Documentation

bool CYIAbstractVideoPlayer::Statistics::bIsLive

Determine if the player's video feed is live or not, assuming there is a feed available.

float CYIAbstractVideoPlayer::Statistics::fBitrateKbps

The current video feed's bitrate.

Note
The value will be -1.0f if it is not available.
float CYIAbstractVideoPlayer::Statistics::fBufferLengthMs

The number of milliseconds-worth of data present in the video buffer.

Note
The value will be -1.0f if it is not available.
float CYIAbstractVideoPlayer::Statistics::fDefaultBitrateKbps

The default bitrate to report for the content.

Note
The value will be -1.0f if it is not available
float CYIAbstractVideoPlayer::Statistics::fFramesPerSecond

The currently rendered frame rate, in frames per second.

Note
The value will be -1.0f if it is not available.
float CYIAbstractVideoPlayer::Statistics::fMinimumBufferLengthMs

The minimum buffer length threshold (in milliseconds) for the video to keep playing.

Note
The values will be -1.0f if it is not available.

The documentation for this struct was generated from the following file: