logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

AppDataUnit - Interface (envelope) to data received over RTP packets.

Author

       Generated automatically by Doxygen for ccRTP from the source code.

                                                      ccRTP                                       AppDataUnit(3)

Constructor & Destructor Documentation

AppDataUnit::AppDataUnit(constIncomingRTPPkt&packet,constSyncSource&src)AppDataUnit::~AppDataUnit()[inline]AppDataUnit::AppDataUnit(constAppDataUnit&src)Parameterssrc the AppDataUnit object being copied

Detailed Description

       Interface (envelope) to data received over RTP packets.

       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 fedemp@altern.orgExamplesaudiorx.cpp, ccrtptest.cpp, rtpduphello.cpp, rtphello.cpp, and rtplisten.cpp.

Member Function Documentation

uint8AppDataUnit::getContributorsCount()const[inline]
       Get the number of contributing sources in the CSRC list.

   constuint32*AppDataUnit::getContributorsID()const[inline]
       Get the array of 32-bit CSRC identifiers.

       Returns
           NULL if (getContributorsCount() == 0)

   constuint8*constAppDataUnit::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.

       Examplesaudiorx.cpp, rtpduphello.cpp, and rtphello.cpp.

   uint16AppDataUnit::getSeqNum()const[inline]
       Get data unit sequence number.

   size_tAppDataUnit::getSize()const[inline]Returns
           length of data in octets

       Examplesaudiorx.cpp, and rtplisten.cpp.

   constSyncSource&AppDataUnit::getSource()const[inline]Returns
           Source that sent this data

       Examplesrtplisten.cpp.

   PayloadTypeAppDataUnit::getType()const[inline]Returns
           type of this data

       Examplesrtplisten.cpp.

   boolAppDataUnit::isMarked()const[inline]
       Is this data unit marked?.

       Returns
           true if marked.

   AppDataUnit&AppDataUnit::operator=(constAppDataUnit&source)
       Assignment operator.

       Parameterssource the AppDataUnit object being assigned

       Returns
           the result of the assignment

Name

       AppDataUnit - Interface (envelope) to data received over RTP packets.

Synopsis

       #include <queuebase.h>

   PublicMemberFunctionsAppDataUnit (const IncomingRTPPkt &packet, const SyncSource &src)
       ~AppDataUnit ()
       AppDataUnit (const AppDataUnit &src)
       AppDataUnit & operator= (const AppDataUnit &source)
           Assignment operator.
       PayloadTypegetType () const
       const uint8 *const getData () const
           Get data as it is received in RTP packets (i.e.
       size_t getSize () const
       const SyncSource & getSource () const
       bool isMarked () const
           Is this data unit marked?.
       uint16 getSeqNum () const
           Get data unit sequence number.
       uint8 getContributorsCount () const
           Get the number of contributing sources in the CSRC list.
       const uint32 * getContributorsID () const
           Get the array of 32-bit CSRC identifiers.

See Also