Bayonne2 / Common C++ 2 Framework: AppDataUnit Class Reference

A class of objects representing data transmitted over RTP packets. Tipically, this object will apply to received data. Data blocks received via RTP connections as well as its related objects (source, etc), are accessed through the methods of this class.

Author: Federico Montesino Pouzols fedem.nosp@m.p@al.nosp@m.tern..nosp@m.org

Definition at line 71 of file queuebase.h.

Constructor & Destructor Documentation

AppDataUnit::AppDataUnit ( const IncomingRTPPkt & packet,

const SyncSource & src

)

AppDataUnit::~AppDataUnit ( )

inline

Definition at line 76 of file queuebase.h.

AppDataUnit::AppDataUnit ( const AppDataUnit & src )

Parameters: src the AppDataUnit object being copied

Member Function Documentation

uint8 AppDataUnit::getContributorsCount ( ) const

inline

Get the number of contributing sources in the CSRC list.

Definition at line 145 of file queuebase.h.

const uint32* AppDataUnit::getContributorsID ( ) const

inline

Get the array of 32-bit CSRC identifiers.

Returns: NULL if (getContributorsCount() == 0)

Definition at line 154 of file queuebase.h.

const uint8* const AppDataUnit::getData ( ) const

inline

Get data as it is received in RTP packets (i.e.

for multi-octet encodings, octets are in network order.

Returns: Raw pointer to data block.

Definition at line 108 of file queuebase.h.

uint16 AppDataUnit::getSeqNum ( ) const

inline

Get data unit sequence number.

Definition at line 138 of file queuebase.h.

size_t AppDataUnit::getSize ( void ) const

inline

Returns: length of data in octets

Definition at line 115 of file queuebase.h.

const SyncSource& AppDataUnit::getSource ( ) const

inline

Returns: Source that sent this data

Definition at line 122 of file queuebase.h.

PayloadType AppDataUnit::getType ( ) const

inline

Returns: type of this data

Definition at line 97 of file queuebase.h.

bool AppDataUnit::isMarked ( ) const

inline

Is this data unit marked?.

Returns: true if marked.

Definition at line 131 of file queuebase.h.

AppDataUnit& AppDataUnit::operator= ( const AppDataUnit & source )

Assignment operator.

Parameters: source the AppDataUnit object being assigned

Returns: the result of the assignment

Field Documentation

Pointer<const IncomingRTPPkt> AppDataUnit::datablock

private

Definition at line 158 of file queuebase.h.

const SyncSource* AppDataUnit::source

private

Definition at line 159 of file queuebase.h.

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

queuebase.h

Generated on Dec 21, 2017 for commoncpp2-1.8.1, ccrtp-1.7.2, libzrtpcpp-2.3.4, ccscript3-1.1.7, ccaudio2-1.0.0 and bayonne2-2.3.2 (after installation in /usr/local/) by doxygen 1.8.6