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

SDES item header. More...

#include <headers.h>

Public Member Functions

void reset ()
 Reset to initial state (all zeros). More...
 
SdesItemType type () const
 Get item type. More...
 
void set_type (const SdesItemType t)
 Set type. More...
 
size_t text_len () const
 Get item text length. More...
 
void set_text_len (const size_t ln)
 Set item text length. More...
 
const uint8_t * text () const
 Get pointer to item text. The text is NOT zero-terminated. More...
 
uint8_t * text ()
 Get pointer to item text. The text is NOT zero-terminated. More...
 

Static Public Attributes

static const size_t MaxTextLen = 255
 Get maximum allowed item text length. More...
 

Detailed Description

SDES item header.

Part of SDES packet.

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
+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+
| Type | Length | Text in UTF-8 ...
+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+

Definition at line 734 of file headers.h.

Member Function Documentation

◆ reset()

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

Reset to initial state (all zeros).

Definition at line 748 of file headers.h.

◆ set_text_len()

void roc::rtcp::header::SdesItemHeader::set_text_len ( const size_t  ln)
inline

Set item text length.

Definition at line 768 of file headers.h.

◆ set_type()

void roc::rtcp::header::SdesItemHeader::set_type ( const SdesItemType  t)
inline

Set type.

Definition at line 758 of file headers.h.

◆ text() [1/2]

uint8_t* roc::rtcp::header::SdesItemHeader::text ( )
inline

Get pointer to item text. The text is NOT zero-terminated.

Definition at line 781 of file headers.h.

◆ text() [2/2]

const uint8_t* roc::rtcp::header::SdesItemHeader::text ( ) const
inline

Get pointer to item text. The text is NOT zero-terminated.

Definition at line 775 of file headers.h.

◆ text_len()

size_t roc::rtcp::header::SdesItemHeader::text_len ( ) const
inline

Get item text length.

Definition at line 763 of file headers.h.

◆ type()

SdesItemType roc::rtcp::header::SdesItemHeader::type ( ) const
inline

Get item type.

Definition at line 753 of file headers.h.

Member Data Documentation

◆ MaxTextLen

const size_t roc::rtcp::header::SdesItemHeader::MaxTextLen = 255
static

Get maximum allowed item text length.

Definition at line 741 of file headers.h.


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