OpalMediaStatistics Class Reference

#include <mediasession.h>

Inheritance diagram for OpalMediaStatistics:

Collaboration diagram for OpalMediaStatistics:

Data Structures
struct	UpdateInfo

Public Member Functions
	OpalMediaStatistics ()
	OpalMediaStatistics (const OpalMediaStatistics &other)
OpalMediaStatistics &	operator= (const OpalMediaStatistics &other)
virtual void	PrintOn (ostream &strm) const
void	PreUpdate ()
OpalMediaStatistics &	Update (const OpalMediaStream &stream)
bool	IsValid () const
unsigned	GetRateInt (int64_t current, int64_t previous) const
unsigned	GetBitRate () const
unsigned	GetPacketRate () const
unsigned	GetLossRate () const
PString	GetRateStr (int64_t total, const char *units="", unsigned significantFigures=0) const
PString	GetRateStr (int64_t current, int64_t previous, const char *units="", unsigned significantFigures=0) const
PString	GetAverageBitRate (const char *units="", unsigned significantFigures=0) const
PString	GetCurrentBitRate (const char *units="", unsigned significantFigures=0) const
PString	GetAveragePacketRate (const char *units="", unsigned significantFigures=0) const
PString	GetCurrentPacketRate (const char *units="", unsigned significantFigures=0) const
PString	GetPacketLossRate (const char *units="", unsigned significantFigures=0) const
PString	GetCPU () const
unsigned	GetFrameRate () const
PString	GetAverageFrameRate (const char *units="", unsigned significantFigures=0) const
PString	GetCurrentFrameRate (const char *units="", unsigned significantFigures=0) const
P_DEPRECATED PString	GetRate (int64_t current, int64_t previous, const char *units="", unsigned significantFigures=0) const
Public Member Functions inherited from OpalCodecStatistics
	OpalCodecStatistics ()
Public Member Functions inherited from OpalNetworkStatistics
	OpalNetworkStatistics ()
Public Member Functions inherited from OpalVideoStatistics
	OpalVideoStatistics ()
void	IncrementFrames (bool key)
void	IncrementUpdateCount (bool full)
Public Member Functions inherited from OpalFaxStatistics
	OpalFaxStatistics ()

Data Fields
struct OpalMediaStatistics::UpdateInfo	m_updateInfo
OpalFaxStatistics &	m_fax
Data Fields inherited from OpalCodecStatistics
OpalMediaType	m_mediaType
PString	m_mediaFormat
uint32_t	m_SSRC
int	m_payloadType
PThreadIdentifier	m_threadIdentifier
Data Fields inherited from OpalNetworkStatistics
PString	m_transportName
OpalTransportAddress	m_localAddress
OpalTransportAddress	m_remoteAddress
PTime	m_startTime
uint64_t	m_totalBytes
unsigned	m_totalPackets
unsigned	m_controlPacketsIn
unsigned	m_controlPacketsOut
int	m_NACKs
uint32_t	m_rtxSSRC
int	m_rtxPackets
int	m_rtxDuplicates
int	m_FEC
int	m_unrecovered
int	m_packetsLost
int	m_maxConsecutiveLost
int	m_packetsOutOfOrder
int	m_lateOutOfOrder
int	m_packetsTooLate
int	m_packetOverruns
int	m_minimumPacketTime
int	m_averagePacketTime
int	m_maximumPacketTime
int	m_averageJitter
int	m_maximumJitter
int	m_jitterBufferDelay
int	m_roundTripTime
int	m_lastPacketRTP
PTime	m_lastPacketAbsTime
PTime	m_lastPacketNetTime
PTime	m_lastReportTime
unsigned	m_targetBitRate
float	m_targetFrameRate
Data Fields inherited from OpalVideoStatistics
unsigned	m_totalFrames
unsigned	m_keyFrames
unsigned	m_droppedFrames
PTime	m_lastKeyFrameTime
unsigned	m_fullUpdateRequests
unsigned	m_pictureLossRequests
PTime	m_lastUpdateRequestTime
PTimeInterval	m_updateResponseTime
unsigned	m_frameWidth
unsigned	m_frameHeight
unsigned	m_tsto
int	m_videoQuality
Data Fields inherited from OpalFaxStatistics
int	m_result
char	m_phase
int	m_bitRate
FaxCompression	m_compression
bool	m_errorCorrection
int	m_txPages
int	m_rxPages
int	m_totalPages
int	m_imageSize
int	m_resolutionX
int	m_resolutionY
int	m_pageWidth
int	m_pageHeight
int	m_badRows
int	m_mostBadRows
int	m_errorCorrectionRetries
PString	m_stationId
PString	m_errorText

Additional Inherited Members
Public Types inherited from OpalFaxStatistics
enum	{ FaxNotStarted = -2, FaxInProgress = -1, FaxSuccessful = 0, FaxErrorBase = 1 }
enum	FaxCompression { FaxCompressionUnknown, FaxCompressionT4_1d, FaxCompressionT4_2d, FaxCompressionT6 }

Detailed Description

This class carries statistics on the media stream.

Constructor & Destructor Documentation

OpalMediaStatistics::OpalMediaStatistics

(

)

OpalMediaStatistics::OpalMediaStatistics

(

const OpalMediaStatistics &

other

)

Member Function Documentation

PString OpalMediaStatistics::GetAverageBitRate ( const char *  units = "", unsigned  significantFigures = 0  ) const

inline

References GetRateStr(), and OpalNetworkStatistics::m_totalBytes.

PString OpalMediaStatistics::GetAverageFrameRate	(	const char *	units = "",
		unsigned	significantFigures = 0
	)		const

PString OpalMediaStatistics::GetAveragePacketRate ( const char *  units = "", unsigned  significantFigures = 0  ) const

inline

References GetRateStr(), and OpalNetworkStatistics::m_totalPackets.

unsigned OpalMediaStatistics::GetBitRate ( ) const

inline

References GetRateInt(), OpalMediaStatistics::UpdateInfo::m_previousBytes, OpalNetworkStatistics::m_totalBytes, and m_updateInfo.

PString OpalMediaStatistics::GetCPU

(

)

const

PString OpalMediaStatistics::GetCurrentBitRate ( const char *  units = "", unsigned  significantFigures = 0  ) const

inline

References GetRateStr(), OpalMediaStatistics::UpdateInfo::m_previousBytes, OpalNetworkStatistics::m_totalBytes, and m_updateInfo.

PString OpalMediaStatistics::GetCurrentFrameRate	(	const char *	units = "",
		unsigned	significantFigures = 0
	)		const

PString OpalMediaStatistics::GetCurrentPacketRate ( const char *  units = "", unsigned  significantFigures = 0  ) const

inline

References GetRateStr(), OpalMediaStatistics::UpdateInfo::m_previousPackets, OpalNetworkStatistics::m_totalPackets, and m_updateInfo.

unsigned OpalMediaStatistics::GetFrameRate ( ) const

inline

References GetRateInt(), OpalMediaStatistics::UpdateInfo::m_previousFrames, OpalVideoStatistics::m_totalFrames, and m_updateInfo.

unsigned OpalMediaStatistics::GetLossRate ( ) const

inline

References GetRateInt(), OpalNetworkStatistics::m_packetsLost, OpalMediaStatistics::UpdateInfo::m_previousLost, and m_updateInfo.

PString OpalMediaStatistics::GetPacketLossRate ( const char *  units = "", unsigned  significantFigures = 0  ) const

inline

References GetRateStr(), OpalNetworkStatistics::m_packetsLost, OpalMediaStatistics::UpdateInfo::m_previousLost, and m_updateInfo.

unsigned OpalMediaStatistics::GetPacketRate ( ) const

inline

References GetRateInt(), OpalMediaStatistics::UpdateInfo::m_previousPackets, OpalNetworkStatistics::m_totalPackets, and m_updateInfo.

P_DEPRECATED PString OpalMediaStatistics::GetRate ( int64_t  current, int64_t  previous, const char *  units = "", unsigned  significantFigures = 0  ) const

inline

References GetRateStr().

unsigned OpalMediaStatistics::GetRateInt	(	int64_t	current,
		int64_t	previous
	)		const

Referenced by GetBitRate(), GetFrameRate(), GetLossRate(), and GetPacketRate().

PString OpalMediaStatistics::GetRateStr	(	int64_t	total,
		const char *	units = "",
		unsigned	significantFigures = 0
	)		const

Referenced by GetAverageBitRate(), GetAveragePacketRate(), GetCurrentBitRate(), GetCurrentPacketRate(), GetPacketLossRate(), and GetRate().

PString OpalMediaStatistics::GetRateStr	(	int64_t	current,
		int64_t	previous,
		const char *	units = "",
		unsigned	significantFigures = 0
	)		const

bool OpalMediaStatistics::IsValid

(

)

const

OpalMediaStatistics& OpalMediaStatistics::operator=

(

const OpalMediaStatistics &

other

)

void OpalMediaStatistics::PreUpdate

(

)

virtual void OpalMediaStatistics::PrintOn ( ostream &  strm ) const

virtual

OpalMediaStatistics& OpalMediaStatistics::Update

(

const OpalMediaStream &

stream

)

Field Documentation

OpalFaxStatistics& OpalMediaStatistics::m_fax

struct OpalMediaStatistics::UpdateInfo OpalMediaStatistics::m_updateInfo

Referenced by GetBitRate(), GetCurrentBitRate(), GetCurrentPacketRate(), GetFrameRate(), GetLossRate(), GetPacketLossRate(), and GetPacketRate().

---

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

• mediasession.h