Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
roc::rtcp::RttEstimator Class Reference

Round-trip time estimator. Created inside rtcp::Reporter for each RTP stream. Continously computes RTT and clock offset based on LSR/DLSR or LRR/DLRR timestamps. More...

#include <rtt_estimator.h>

Public Member Functions

 RttEstimator (const RttConfig &config)
 Initialize. More...
 
bool has_metrics () const
 Check whether metrics are already available. More...
 
const RttMetricsmetrics () const
 Get estimated metrics. More...
 
void update (core::nanoseconds_t local_report_ts, core::nanoseconds_t remote_report_ts, core::nanoseconds_t remote_reply_ts, core::nanoseconds_t local_reply_ts)
 Update metrics with new data. Parameters: More...
 

Detailed Description

Round-trip time estimator. Created inside rtcp::Reporter for each RTP stream. Continously computes RTT and clock offset based on LSR/DLSR or LRR/DLRR timestamps.

Definition at line 51 of file rtt_estimator.h.

Constructor & Destructor Documentation

◆ RttEstimator()

roc::rtcp::RttEstimator::RttEstimator ( const RttConfig config)

Initialize.

Member Function Documentation

◆ has_metrics()

bool roc::rtcp::RttEstimator::has_metrics ( ) const

Check whether metrics are already available.

◆ metrics()

const RttMetrics& roc::rtcp::RttEstimator::metrics ( ) const

Get estimated metrics.

◆ update()

void roc::rtcp::RttEstimator::update ( core::nanoseconds_t  local_report_ts,
core::nanoseconds_t  remote_report_ts,
core::nanoseconds_t  remote_reply_ts,
core::nanoseconds_t  local_reply_ts 
)

Update metrics with new data. Parameters:

  • local_report_ts - local unix time when we've sent report
  • remote_report_ts - remote unix time when they've received our report
  • remote_reply_ts - remote unix time when they've send reply report
  • local_reply_ts - local unix time when we've received their reply

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