RTPQueueBase(3)

📦
version 2.0.9 · 4 versions
, in debian trixie, ubuntu noble, ubuntu questing

🌸 RTPQueueBase(3) 🌸

okay bestie, welcome to the Library Functions Manual 💖 this one's page RTPQueueBase(3) and it's giving foundational base class energy — literally the blueprint other RTP queue classes inherit from. let's get into it ✨

💅 NAME 💅

RTPQueueBase — a virtual base class for RTP queue hierarchies.

like, the mom of the whole queue family tree 🫶

✨ SYNOPSIS ✨

#include <queuebase.h>

Inherited by IncomingDataQueueBase [virtual], and OutgoingDataQueueBase [virtual].

🌈 Public Member Functions 🌈

  • bool setPayloadFormat (const PayloadFormat &pf) — sets the payload format in use, for timing and payload type identification purposes.
  • uint32 getLocalSSRC () const
  • uint32 getCurrentRTPClockRate () const — grabs the clock rate in RTP clock units (like, 8000 units per second for PCMU, or 90000 units per second for MP2T, iykyk).
  • PayloadType getCurrentPayloadType () const
  • timeval getInitialTime () const

🎀 Protected Member Functions 🎀

  • RTPQueueBase (uint32 *ssrc=NULL)
  • void setLocalSSRC (uint32 ssrc)
  • uint32 getLocalSSRCNetwork () const
  • virtual ~RTPQueueBase ()
  • virtual size_t dispatchBYE (const std::string &) — a plugin point for posting of BYE messages, periodt.
  • virtual void renewLocalSSRC ()

🦋 Detailed Description 🦋

A virtual base class for RTP queue hierarchies. no cap, that's the whole vibe — everything else builds on top of her 💜

👑 Author

Federico Montesino Pouzols fedemp@altern.org

🌸 Constructor & Destructor Documentation 🌸

💖 RTPQueueBase::RTPQueueBase (uint32 * ssrc = NULL) [protected]

Parameters

  • ssrc — if it's not null, this is the local SSRC identifier for this session. (if it is null, she just vibes without one 💅)

💖 virtual RTPQueueBase::~RTPQueueBase () [inline], [protected], [virtual]

the destructor, being all three of those things at once. main character energy honestly 😭

✨ Member Function Documentation ✨

🌈 virtual size_t RTPQueueBase::dispatchBYE (const std::string &) [inline], [protected], [virtual]

A plugin point for posting of BYE messages. so like, when someone dips out of the session, this is where the goodbye goes 🫶

Parameters

  • reason to leave the RTP session.

Returns

number of octets sent.

Reimplemented in QueueRTCPManager, TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >, TRTPSessionBase< DualRTPUDPIPv4Channel, DualRTPUDPIPv4Channel, AVPQueue >, and SingleThreadRTPSession< RTPDataChannel, RTCPChannel, ServiceQueue >.

🌈 PayloadType RTPQueueBase::getCurrentPayloadType () const [inline]

she's just here, serving const correctness 💅

🌈 uint32 RTPQueueBase::getCurrentRTPClockRate () const [inline]

Get the clock rate in RTP clock units (for instance, 8000 units per second for PCMU, or 90000 units per second for MP2T). This value depends on what payload format has been selected using setPayloadFormat().

Returns

clock rate in RTP clock units.

Examples

ccrtptest.cpp, rtphello.cpp, and rtpsend.cpp.

🌈 timeval RTPQueueBase::getInitialTime () const [inline]

no extra deets on this one, she's lowkey mysterious 🙈

🌈 uint32 RTPQueueBase::getLocalSSRC () const [inline]

Examples

rtphello.cpp, rtplisten.cpp, and rtpsend.cpp.

🌈 uint32 RTPQueueBase::getLocalSSRCNetwork () const [inline], [protected]

protected and inline, living her best hidden life ✨

🌈 virtual void RTPQueueBase::renewLocalSSRC () [inline], [protected], [virtual]

Reimplemented in RTPDataQueue, and IncomingDataQueue.

🌈 void RTPQueueBase::setLocalSSRC (uint32 ssrc) [inline], [protected]

sets the local SSRC. short and sweet, iconic honestly 🎀

🌈 bool RTPQueueBase::setPayloadFormat (const PayloadFormat & pf) [inline]

Set the payload format in use, for timing and payload type identification purposes.

Parameters

  • pf — payload format to use from now on.

Returns

whether the payload format has been successfully set.

Examples

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

bestie this is the one everybody calls, look at that example list — she's booked and busy 🔥

💜 Author 💜

Generated automatically by Doxygen for ccRTP from the source code.

and that's the whole page, bestie!! 🎀 this lil manual page lives under the ccRTP name in the Library Functions Manual, and she's officially RTPQueueBase(3) — go forth and inherit responsibly 💖✨🦋

📦 where this page comes from