Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
Public Member Functions | List of all members
roc::rtcp::header::XrMeasurementInfoBlock Class Reference

XR Measurement Info Report Block. More...

#include <headers.h>

Public Member Functions

void reset ()
 Reset to initial state (all zeros). More...
 
const XrBlockHeader & header () const
 Get common block header. More...
 
XrBlockHeader & header ()
 Get common block header. More...
 
packet::stream_source_t ssrc () const
 Get SSRC of source being reported. More...
 
void set_ssrc (const packet::stream_source_t ssrc)
 Set SSRC of source being reported. More...
 
packet::seqnum_t first_seq () const
 Get seqnum of first ever received packet. More...
 
void set_first_seq (const packet::seqnum_t x)
 Set seqnum of first ever received packet. More...
 
packet::ext_seqnum_t interval_first_seq () const
 Get extended seqnum of first packet in interval. More...
 
void set_interval_first_seq (const packet::ext_seqnum_t x)
 Set extended seqnum of first packet in interval. More...
 
packet::ext_seqnum_t interval_last_seq () const
 Get extended seqnum of last packet in interval. More...
 
void set_interval_last_seq (const packet::ext_seqnum_t x)
 Set extended seqnum of last packet in interval. More...
 
packet::ntp_timestamp_t interval_duration () const
 Get measurement interval duration. Applicable to MetricFlag_IntervalDuration reports. More...
 
void set_interval_duration (const packet::ntp_timestamp_t x)
 Set measurement interval duration. Stores only the middle 32 bits out of 64 in the NTP timestamp. More...
 
packet::ntp_timestamp_t cum_duration () const
 Get measurement cumulative duration. Applicable to MetricFlag_CumulativeDuration reports. More...
 
void set_cum_duration (const packet::ntp_timestamp_t t)
 Set measurement cumulative duration. More...
 

Detailed Description

XR Measurement Info Report Block.

Defines measurement interval associated with other metrics blocks, in particular XrDelayMetricsBlock.

RFC 6776 4.1: "Report Block Structure"

0 1 2 3
0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| BT=14 | Reserved | block length = 7 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| SSRC of stream source |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Reserved | first sequence number |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| extended first sequence number of interval |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| extended last sequence number |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Measurement Duration (Interval) |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Measurement Duration (Cumulative) - Seconds (bit 0-31) |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Measurement Duration (Cumulative) - Fraction (bit 0-31) |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Definition at line 1373 of file headers.h.

Member Function Documentation

◆ cum_duration()

packet::ntp_timestamp_t roc::rtcp::header::XrMeasurementInfoBlock::cum_duration ( ) const
inline

Get measurement cumulative duration. Applicable to MetricFlag_CumulativeDuration reports.

Definition at line 1465 of file headers.h.

◆ first_seq()

packet::seqnum_t roc::rtcp::header::XrMeasurementInfoBlock::first_seq ( ) const
inline

Get seqnum of first ever received packet.

Definition at line 1422 of file headers.h.

◆ header() [1/2]

XrBlockHeader& roc::rtcp::header::XrMeasurementInfoBlock::header ( )
inline

Get common block header.

Definition at line 1407 of file headers.h.

◆ header() [2/2]

const XrBlockHeader& roc::rtcp::header::XrMeasurementInfoBlock::header ( ) const
inline

Get common block header.

Definition at line 1402 of file headers.h.

◆ interval_duration()

packet::ntp_timestamp_t roc::rtcp::header::XrMeasurementInfoBlock::interval_duration ( ) const
inline

Get measurement interval duration. Applicable to MetricFlag_IntervalDuration reports.

Definition at line 1453 of file headers.h.

◆ interval_first_seq()

packet::ext_seqnum_t roc::rtcp::header::XrMeasurementInfoBlock::interval_first_seq ( ) const
inline

Get extended seqnum of first packet in interval.

Definition at line 1432 of file headers.h.

◆ interval_last_seq()

packet::ext_seqnum_t roc::rtcp::header::XrMeasurementInfoBlock::interval_last_seq ( ) const
inline

Get extended seqnum of last packet in interval.

Definition at line 1442 of file headers.h.

◆ reset()

void roc::rtcp::header::XrMeasurementInfoBlock::reset ( )
inline

Reset to initial state (all zeros).

Definition at line 1391 of file headers.h.

◆ set_cum_duration()

void roc::rtcp::header::XrMeasurementInfoBlock::set_cum_duration ( const packet::ntp_timestamp_t  t)
inline

Set measurement cumulative duration.

Definition at line 1470 of file headers.h.

◆ set_first_seq()

void roc::rtcp::header::XrMeasurementInfoBlock::set_first_seq ( const packet::seqnum_t  x)
inline

Set seqnum of first ever received packet.

Definition at line 1427 of file headers.h.

◆ set_interval_duration()

void roc::rtcp::header::XrMeasurementInfoBlock::set_interval_duration ( const packet::ntp_timestamp_t  x)
inline

Set measurement interval duration. Stores only the middle 32 bits out of 64 in the NTP timestamp.

Definition at line 1459 of file headers.h.

◆ set_interval_first_seq()

void roc::rtcp::header::XrMeasurementInfoBlock::set_interval_first_seq ( const packet::ext_seqnum_t  x)
inline

Set extended seqnum of first packet in interval.

Definition at line 1437 of file headers.h.

◆ set_interval_last_seq()

void roc::rtcp::header::XrMeasurementInfoBlock::set_interval_last_seq ( const packet::ext_seqnum_t  x)
inline

Set extended seqnum of last packet in interval.

Definition at line 1447 of file headers.h.

◆ set_ssrc()

void roc::rtcp::header::XrMeasurementInfoBlock::set_ssrc ( const packet::stream_source_t  ssrc)
inline

Set SSRC of source being reported.

Definition at line 1417 of file headers.h.

◆ ssrc()

packet::stream_source_t roc::rtcp::header::XrMeasurementInfoBlock::ssrc ( ) const
inline

Get SSRC of source being reported.

Definition at line 1412 of file headers.h.

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