AppDataUnit(3)

πŸ“¦
version 2.0.9 Β· 4 versions
, in debian trixie, ubuntu noble, ubuntu questing

✨ NAME ✨

AppDataUnit β€” Interface (envelope) to data received over RTP packets.


πŸŽ€ SYNOPSIS πŸŽ€

#include <queuebase.h>

πŸ’… Public Member Functions πŸ’…

  • AppDataUnit (const IncomingRTPPkt &packet, const SyncSource &src)
  • ~AppDataUnit ()
  • AppDataUnit (const AppDataUnit &src)
  • AppDataUnit & operator= (const AppDataUnit &source) β€” Assignment operator.
  • PayloadType getType () 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.

πŸ“– Detailed Description πŸ“–

Interface (envelope) to data received over RTP packets.

A class of objects representing data transmitted over RTP packets. Tipically (their spelling, not mine πŸ’…), 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.org

πŸ¦‹ Examples πŸ¦‹

audiorx.cpp, ccrtptest.cpp, rtpduphello.cpp, rtphello.cpp, and rtplisten.cpp.


🧚 Constructor & Destructor Documentation 🧚

AppDataUnit::AppDataUnit (const IncomingRTPPkt & packet, const SyncSource & src)

(that's the constructor bestie, no extra tea here πŸ«–)

AppDataUnit::~AppDataUnit () [inline]

(and that's the destructor, inline, doing its little cleanup era ✨)

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.

const uint32 * AppDataUnit::getContributorsID () const [inline]

Get the array of 32-bit CSRC identifiers.

Returns

  • NULL if (getContributorsCount() == 0)

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.

Examples

  • audiorx.cpp, rtpduphello.cpp, and rtphello.cpp.

uint16 AppDataUnit::getSeqNum () const [inline]

Get data unit sequence number.

size_t AppDataUnit::getSize () const [inline]

Returns

  • length of data in octets

Examples

  • audiorx.cpp, and rtplisten.cpp.

const SyncSource & AppDataUnit::getSource () const [inline]

Returns

  • Source that sent this data

Examples

  • rtplisten.cpp.

PayloadType AppDataUnit::getType () const [inline]

Returns

  • type of this data

Examples

  • rtplisten.cpp.

bool AppDataUnit::isMarked () const [inline]

Is this data unit marked?.

Returns

  • true if marked.

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

Assignment operator.

Parameters

  • source β€” the AppDataUnit object being assigned

Returns

  • the result of the assignment

πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for ccRTP from the source code.


okay so that's the whole page, every flag and every method accounted for, no cap πŸ’– this cutie lives in the ccRTP source, page AppDataUnit(3), and yeah, it was auto-generated by Doxygen for ccRTP from the source code β€” go read the source if you want the real lore, ily, bye bestie πŸŽ€βœ¨πŸ¦‹
πŸ“¦ where this page comes from