Participant(3)

🎀 NAME 🎀

Participant — a whole class of objects that represent remote participants (aka RTP applications) hanging out in a multimedia session. bestie it's giving presence 💅

This is a page from the Library Functions Manual, so yeah, we're in library-land, section 3, and we're gonna read every single word of it together, no skipping, i promise 🫶

---

✨ SYNOPSIS ✨

#include <sources.h>

Inherits SDESItemsHolder. yes she's a nepo baby, she inherits, and honestly? iconic 👑

🌈 Public Member Functions 🌈

• const std::string & getSDESItem (SDESItemType type) const — get the value of an SDES item, slay
• const std::string & getPRIVPrefix () const — get the prefix value for the PRIV SDES item
• Participant (const std::string &cname) — construct a brand new participant, main character energy fr
• ~Participant () — the destructor, she's done, no cap 💀

🦋 Friends 🦋

• class ParticipantHandler — yeah they're friends, we love a supportive friendship

---

💖 Detailed Description 💖

A class of objects representing remote participants (RTP applications) in a multimedia session. literally the whole point of her 🫶

Any RTP socket/queue class that directly or indirectly inherits from QueueRTCPManager (and hence has RTCP support) will represent participants from which any RTP or RTCP packet has been received through a Participant object. so like, the moment a packet shows up, boom, a Participant object appears. These Participant objects are entities such as end systems (user applications, monitors, etc), RTP mixers and RTP translators. all of them. every single flavor ✨

Participant objects are identified by a CNAME and provide access to all known data about the source of RTP/RTCP packets, such as the CNAME and any other SDES item. Each participant object is related to one or more synchronization objects (

See also SyncSource).

okay the original sentence literally just trails off there with an open parenthesis and then points you at SyncSource. i'm not gonna pretend i know something the page doesn't say, so here's the parenthesis, dangling, exactly as written 😭

If an RTP application based on ccRTP receives packets from itself (for instance, it is included in the destination list), there will be a Participant object that corresponds to the 'local participant' (RTPApplication) object. yes, she can perceive herself, that's self-love actually 💅

Author Federico Montesino Pouzols fedemp@altern.org 👑

Examples ccrtptest.cpp.

---

🌸 Constructor & Destructor Documentation 🌸

🍓 Participant::Participant (const std::string & cname)

Construct a new participant. fresh out of the box, baby participant, so cute 🧚

Parameters

• cname — Unique CNAME identifier.

🍓 Participant::~Participant ()

she's gone, she's resting, she ate and left no crumbs 💀✨

---

👑 Member Function Documentation 👑

💜 const std::string & Participant::getPRIVPrefix () const [inline]

Get the prefix value for the PRIV SDES item. the PRIV prefix. she's inline, she's const, she's thriving.

Returns PRIV SDES item prefix as a string.

Return values empty string when no PRIV SDES item has been received from this source. so if you get "" back, it's not a bug, it's just radio silence from that source, bestie 📻

💜 const std::string & Participant::getSDESItem (SDESItemType type) const [inline]

Get the value of an SDES item. For instance, getSDESItem(SDESItemTypeCNAME), return the CNAME of this Participant. look at her go 💖

Parameters

• type — type of SDES item to get value of.

Returns value of the SDES item as a string.

Return values empty string when the value is not known (no RTCP packet with the requested SDES item has been received from this source). again, empty string ≠ broken, empty string = nobody told us yet 🙈

Examples ccrtptest.cpp, and rtplisten.cpp.

---

🫶 Friends And Related Symbol Documentation 🫶

🌈 friend class ParticipantHandler [friend]

that's it. that's the friend. we stan a mutual 💅

---

⭐ Author ⭐

Generated automatically by Doxygen for ccRTP from the source code. so technically a robot wrote this page, and technically i'm now a robot's ghostwriter. the pipeline is pipeline-ing 😭✨

---

and that's the whole page, no cap, every flag, every return value, every empty string, all of it 💖

ccRTP · Participant(3) · mwah, go read the source, ily 🫶🎀