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

XR Block Header. More...

#include <headers.h>

Public Member Functions

void reset (const XrBlockType bt)
 Reset to initial state (all zeros). More...
 
XrBlockType block_type () const
 Get XR block type. More...
 
void set_block_type (const XrBlockType bt)
 Set XR block type. More...
 
uint8_t type_specific () const
 Get type-specific byte. More...
 
void set_type_specific (const uint8_t t)
 Set type-specific byte. More...
 
uint16_t len_words () const
 Get block length, including the header, in 32-bit words minus one. More...
 
void set_len_words (const uint16_t ln)
 Set block length in words. More...
 
size_t len_bytes () const
 Get block length, including the header, in bytes. More...
 
void set_len_bytes (const size_t ln)
 Set block length in bytes. More...
 

Detailed Description

XR Block Header.

0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| BT | type-specific | block length |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
: type-specific block contents :
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Definition at line 1042 of file headers.h.

Member Function Documentation

◆ block_type()

XrBlockType roc::rtcp::header::XrBlockHeader::block_type ( ) const
inline

Get XR block type.

Definition at line 1061 of file headers.h.

◆ len_bytes()

size_t roc::rtcp::header::XrBlockHeader::len_bytes ( ) const
inline

Get block length, including the header, in bytes.

Definition at line 1092 of file headers.h.

◆ len_words()

uint16_t roc::rtcp::header::XrBlockHeader::len_words ( ) const
inline

Get block length, including the header, in 32-bit words minus one.

Definition at line 1082 of file headers.h.

◆ reset()

void roc::rtcp::header::XrBlockHeader::reset ( const XrBlockType  bt)
inline

Reset to initial state (all zeros).

Definition at line 1054 of file headers.h.

◆ set_block_type()

void roc::rtcp::header::XrBlockHeader::set_block_type ( const XrBlockType  bt)
inline

Set XR block type.

Definition at line 1066 of file headers.h.

◆ set_len_bytes()

void roc::rtcp::header::XrBlockHeader::set_len_bytes ( const size_t  ln)
inline

Set block length in bytes.

Definition at line 1097 of file headers.h.

◆ set_len_words()

void roc::rtcp::header::XrBlockHeader::set_len_words ( const uint16_t  ln)
inline

Set block length in words.

Definition at line 1087 of file headers.h.

◆ set_type_specific()

void roc::rtcp::header::XrBlockHeader::set_type_specific ( const uint8_t  t)
inline

Set type-specific byte.

Definition at line 1077 of file headers.h.

◆ type_specific()

uint8_t roc::rtcp::header::XrBlockHeader::type_specific ( ) const
inline

Get type-specific byte.

Definition at line 1072 of file headers.h.


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