millicast::RtsViewerStats Class Reference

viewer level RTS statistics. Combines information from different areas to provide useful information to debug viewer performance. More...

#include <rts_stats.h>

Public Types
enum class	Level { FULL , SIMPLIFIED }

Public Member Functions
	RtsViewerStats ()=default
virtual std::string	to_json (Level level) const =0
	get a json string of the viewer statistics. the keys are the same as the fields in this class and
virtual	~RtsViewerStats ()=default

Public Attributes
std::string	cluster_id
std::string	stream_view_id
std::string	subscriber_id
std::string	stream_id
int64_t	timestamp
std::optional< double >	total_round_trip_time
std::optional< double >	current_round_trip_time
std::vector< std::shared_ptr< const RtsTrackStats > >	track_stats

Protected Member Functions
	RtsViewerStats (const RtsViewerStats &) noexcept=default
	RtsViewerStats (RtsViewerStats &&) noexcept=default
RtsViewerStats &	operator= (RtsViewerStats &&) noexcept=default
RtsViewerStats &	operator= (const RtsViewerStats &) noexcept=default

Detailed Description

viewer level RTS statistics. Combines information from different areas to provide useful information to debug viewer performance.

Member Enumeration Documentation

Level

enum class millicast::RtsViewerStats::Level

strong

The level of verbosity on the stats object.

Enumerator
FULL
SIMPLIFIED

Constructor & Destructor Documentation

RtsViewerStats() [1/3]

millicast::RtsViewerStats::RtsViewerStats ( )

default

~RtsViewerStats()

virtual millicast::RtsViewerStats::~RtsViewerStats ( )

virtualdefault

RtsViewerStats() [2/3]

millicast::RtsViewerStats::RtsViewerStats ( const RtsViewerStats & )

protecteddefaultnoexcept

RtsViewerStats() [3/3]

millicast::RtsViewerStats::RtsViewerStats ( RtsViewerStats && )

protecteddefaultnoexcept

Member Function Documentation

operator=() [1/2]

RtsViewerStats & millicast::RtsViewerStats::operator= ( const RtsViewerStats & )

protecteddefaultnoexcept

operator=() [2/2]

RtsViewerStats & millicast::RtsViewerStats::operator= ( RtsViewerStats && )

protecteddefaultnoexcept

to_json()

virtual std::string millicast::RtsViewerStats::to_json ( Level level ) const

nodiscardpure virtual

get a json string of the viewer statistics. the keys are the same as the fields in this class and

See also

RtsTrackStats but in camelCase rather than snake_case.

Parameters

level

The verbosity level of the json object.

Returns

a json string

Member Data Documentation

cluster_id

std::string millicast::RtsViewerStats::cluster_id

current_round_trip_time

std::optional<double> millicast::RtsViewerStats::current_round_trip_time

stream_id

std::string millicast::RtsViewerStats::stream_id

stream_view_id

std::string millicast::RtsViewerStats::stream_view_id

subscriber_id

std::string millicast::RtsViewerStats::subscriber_id

timestamp

int64_t millicast::RtsViewerStats::timestamp

total_round_trip_time

std::optional<double> millicast::RtsViewerStats::total_round_trip_time

track_stats

std::vector<std::shared_ptr<const RtsTrackStats> > millicast::RtsViewerStats::track_stats

---

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

• api/millicast-sdk/rts_stats.h