PayloadFormat(3)

💖 PayloadFormat(3) — the base payload format class, bestie 💖

okay so before we even start: this is a Library Functions Manual page, section 3, and it lives in the ccRTP world. It's giving "foundation energy" — literally the base class everybody else builds on. 🫶

---

✨ NAME ✨

PayloadFormat — the base payload format class. that's it. that's the whole name. iconic. 👑

---

🌸 SYNOPSIS 🌸

#include <formats.h>

Inherited by DynamicPayloadFormat, and StaticPayloadFormat.

so like… you never really use her directly, you use her daughters. classic mother figure behavior. 💅

🌈 Public Member Functions

• PayloadType getPayloadType () const — grab the payload type numeric identifier that gets carried in RTP packets.
• uint32 getRTPClockRate () const — grab the RTP clock rate for this payload format.

🔒 Protected Member Functions

• PayloadFormat () — bestie, PayloadFormat must not be used but as base class. do not instantiate her, she is a concept. 😭
• virtual ~PayloadFormat () — same deal, PayloadFormat must not be used but as base class.
• void setPayloadType (PayloadType pt) — set the payload type numeric identifier carried in RTP packets.
• void setRTPClockRate (uint32 rate) — set the RTP clock rate.

🎀 Static Protected Attributes

• static const uint32 defaultRTPClockRate

---

👑 Detailed Description 👑

Base payload format class. periodt.

The properties of a payload format that, as an RTP stack, ccRTP takes into account are the payload type (numeric identifier) and the RTP clock rate. those two things, that's the whole vibe check. ✨

This is a base class for both StaticPayloadFormat and DynamicPayloadFormat. so she's the mom, they're the main characters. 🌟

Author

Federico Montesino Pouzols fedemp@altern.org — thank you for your service king 🫡

---

🛠️ Constructor & Destructor Documentation 🛠️

PayloadFormat::PayloadFormat () [inline], [protected]

PayloadFormat must not be used but as base class. fr fr. don't try it. 🙈

virtual PayloadFormat::~PayloadFormat () [inline], [protected], [virtual]

PayloadFormat must not be used but as base class. same warning, same energy, she said what she said. 💀

---

🧚 Member Function Documentation 🧚

PayloadType PayloadFormat::getPayloadType () const [inline]

Get payload type numeric identifier carried in RTP packets.

Returns

payload type numeric identifier. 🎯

---

uint32 PayloadFormat::getRTPClockRate () const [inline]

Get RTP clock rate for this payload format. ⏰

lowkey important: note this method provides the RTP clock rate (for the timestamp in RTP data packets headers), which is not necessarily the same as the codec clock rate. do not confuse them bestie, they are different girls. 😤

Returns

RTP clock rate in Hz.

---

void PayloadFormat::setPayloadType (PayloadType pt) [inline], [protected]

Set payload type numeric identifier carried in RTP packets.

Parameters

• pt — payload type number.

---

void PayloadFormat::setRTPClockRate (uint32 rate) [inline], [protected]

Set RTP clock rate.

Parameters

• rate — RTP clock rate in Hz.

---

📦 Member Data Documentation 📦

const uint32 PayloadFormat::defaultRTPClockRate [static], [protected]

that's the one and only static protected attribute in the building. 💜

---

🦋 Author 🦋

Generated automatically by Doxygen for ccRTP from the source code.

---

okay bestie that's the whole page, you ate that reading it 💅✨ this was the PayloadFormat(3) page from ccRTP, manual section 3 — and that lil doxygen-generated sign-off is the version/source situation, no date stamped on this one, we love an undated icon. mwah. 🎀💖🌈🫶