Detailed Description

A source of statistical metadata from a player.

Note: 1 kbit/s = 1000 bit/s

See also: CYIAbstractVideoPlayer::GetStatistics

#include <player/YiAbstractVideoPlayer.h>

Public Member Functions
	Statistics ()

bool	operator== (const Statistics &other) const

bool	operator!= (const Statistics &other) const

Public Attributes
bool	isLive

float	totalBitrateKbps

float	videoBitrateKbps

float	audioBitrateKbps

float	defaultTotalBitrateKbps

float	defaultVideoBitrateKbps

float	defaultAudioBitrateKbps

float	bufferLengthMs

float	minimumBufferLengthMs

float	renderedFramesPerSecond

float	encodedFramesPerSecond

Constructor & Destructor Documentation

◆ Statistics()

CYIAbstractVideoPlayer::Statistics::Statistics ( )

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

Member Function Documentation

◆ operator!=()

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

◆ operator==()

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

Member Data Documentation

◆ audioBitrateKbps

float CYIAbstractVideoPlayer::Statistics::audioBitrateKbps

The current audio feed's bitrate.

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

◆ bufferLengthMs

float CYIAbstractVideoPlayer::Statistics::bufferLengthMs

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

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

◆ defaultAudioBitrateKbps

float CYIAbstractVideoPlayer::Statistics::defaultAudioBitrateKbps

The default video bitrate to report for the content.

Note: The value will be -1.0f if it is not available

◆ defaultTotalBitrateKbps

float CYIAbstractVideoPlayer::Statistics::defaultTotalBitrateKbps

The default total bitrate to report for the content.

Note: The value will be -1.0f if it is not available

◆ defaultVideoBitrateKbps

float CYIAbstractVideoPlayer::Statistics::defaultVideoBitrateKbps

The default video bitrate to report for the content.

Note: The value will be -1.0f if it is not available

◆ encodedFramesPerSecond

float CYIAbstractVideoPlayer::Statistics::encodedFramesPerSecond

The frame rate the video is encoded at, in frames per second.

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

◆ isLive

bool CYIAbstractVideoPlayer::Statistics::isLive

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

◆ minimumBufferLengthMs

float CYIAbstractVideoPlayer::Statistics::minimumBufferLengthMs

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.

◆ renderedFramesPerSecond

float CYIAbstractVideoPlayer::Statistics::renderedFramesPerSecond

The currently rendered frame rate, in frames per second.

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

◆ totalBitrateKbps

float CYIAbstractVideoPlayer::Statistics::totalBitrateKbps

The total bitrate of the current stream.

Note: The value will be -1.0f if it is not available

◆ videoBitrateKbps

float CYIAbstractVideoPlayer::Statistics::videoBitrateKbps

The current video feed's bitrate.

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

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

player/YiAbstractVideoPlayer.h