payload(3)

💖 payload(3) — Library Functions Manual 💖

okay bestie, sit down, hydrate, because we're doing RTP payload lore today. this is the payload page from the ccRTP Library Functions Manual, and honestly? it's giving foundational. it's giving "everything else is built on top of me." let's go 🦋

---

✨ NAME ✨

payload — Payload types and formats. periodt.

---

🌸 SYNOPSIS 🌸

💅 Classes

• class PayloadFormat — the base payload format class, aka the mother of all payload formats. everything else is her daughter.
• class StaticPayloadFormat — Static payload format objects. the fixed, pre-agreed-upon girlies.
• class DynamicPayloadFormat — Dynamic payload format objects. the negotiate-it-later ones. main character energy, honestly.

🎀 Typedefs

• typedef uint8 PayloadType — RTP payload type numeric identifier. one little number, huge responsibilities.

🧚 Enumerations

• enum StaticPayloadType — all the RTP static payload types (default bindings) defined in the AVP profile, in one glorious enum:

enum StaticPayloadType { sptPCMU = 0, firstStaticPayloadType = sptPCMU,
    sptG726_32 = 2, sptGSM, sptG723, sptDVI4_8000, sptDVI4_16000,
    sptLPC, sptPCMA, sptG722, sptL16_DUAL, sptL16_MONO, sptQCELP, sptMPA
    = 14, sptG728, sptDVI4_11025, sptDVI4_22050, sptG729,
    lastStaticAudioPayloadType = sptG729, sptCELB = 25, sptJPEG, sptNV =
    28, sptH261 = 31, sptMPV, sptMP2T, sptH263, lastStaticPayloadType =
    sptH263 }

🍓 Variables

• const PayloadType ptINVALID = 128 — the predefined value for invalid or uninitialized payload type variables. she's the "nobody's home" flag. 🏠💀

---

💜 Detailed Description 💜

no extra lore dropped here, bestie — the real details are living their best lives in the sections right below. keep scrolling. ⬇️

---

🌈 Typedef Documentation 🌈

⭐ PayloadType

RTP payload type numeric identifier.

so at the RTP level, a payload format gets identified by a 7 bit number. that's it, that's the whole ID card. and this number is binded to a payload format through non-RTP means — think SIP, SAP, application specific rules, etc. basically the RTP layer doesn't decide who's who, somebody else does the matchmaking. 💌

---

👑 Enumeration Type Documentation 👑

🦋 enum StaticPayloadType

RTP static payload types (default bindings) defined in the AVP profile. these are the pre-arranged seats — everybody already knows who sits where.

Enumerator

• sptPCMU — ITU-T G.711. mu-law audio 8 Khz (RFC 1890)
• firstStaticPayloadType — no description on file, she just marks the beginning. the opening act. ✨
• sptG726_32 — ITU-T G.726. ADPCM audio (RFC 1890)
• sptGSM — GSM audio (RFC 1890)
• sptG723 — ITU-T G.723. MP-MLQ ACELP audio (RFC 1890)
• sptDVI4_8000 — Modified IMA ADPCM audio 8Khz (RFC 1890)
• sptDVI4_16000 — Modified IMA ADPCM audio 16Khz (RFC 1890)
• sptLPC — LPC audio (RFC 1890)
• sptPCMA — ITU-T G.711 A-law audio 8 Khz (RFC 1890)
• sptG722 — Audio (RFCs 1890, 3047)
• sptL16_DUAL — Linear uncompressed dual audio (RFC 1890)
• sptL16_MONO — Linear uncompressed mono audio (RFC 1890)
• sptQCELP — Audio at 8000 hz.
• sptMPA — MPEG Audio elem. stream (RFCs 1890, 2250)
• sptG728 — ITU-T G.728. LD-CELP audio.
• sptDVI4_11025 — DVI audio at 11025 hz (by Joseph Di Pol)
• sptDVI4_22050 — DVI audio at 22050 hz (by Joseph Di Pol)
• sptG729 — ITU-T G.729. CS-ACELP audio.
• lastStaticAudioPayloadType — no description, she's the closing bracket for the audio girlies. 🎧
• sptCELB — Sun's propietary video (RFCs 1890, 2029)
• sptJPEG — JPEG (ISO 10918) video (RFCs 1890, 2435)
• sptNV — Ron Frederick's nv audio (RFC 1890)
• sptH261 — ITU-T H.261 video (RFCs 1890, 2032)
• sptMPV — MPEG Video elem. stream (RFCs 1890, 2250)
• sptMP2T — MPEG 2 Transport stream (RFCs 1890, 2250)
• sptH263 — ITU-T H.263 video (RFCs 2190, 2429)
• lastStaticPayloadType — no description, just the final curtain call. 🎬

---

🫶 Variable Documentation 🫶

💖 const PayloadType ptINVALID = 128

Predefined value for invalid or uninitialized payload type variables.

tl;dr: if your payload type variable is sitting at 128, she has not been assigned yet, or something went wrong. either way, not a valid payload type. don't build on her. 🚫

---

📝 Author 📝

Generated automatically by Doxygen for ccRTP from the source code.

not me getting emotional over auto-generated docs 😭 Doxygen really said "I'll handle the paperwork, you go be iconic."

---

aaaaand that's the whole page, bestie 💅 footer says ccRTP and payload(3), courtesy of Doxygen doing its little generation thing. go forth and identify your payloads correctly. no cap. 🎀💖✨