A class of objects representing remote participants (RTP applications) in a multimedia session.
More...
#include <sources.h>
Inheritance diagram for Participant:
Collaboration diagram for Participant:
Public Member Functions
Get the value of an SDES item.
More...
Get the prefix value for the PRIV SDES item.
More...
Construct a new participant.
More...
Private Member Functions
Set the value of a SDES item.
More...
Set prefix value for the PRIV SDES item.
More...
Friends
Detailed Description
A class of objects representing remote participants (RTP applications) in a multimedia session.
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. These Participant objects are entities such as end systems (user applications, monitors, etc), RTP mixers and RTP translators.
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).
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.
- Author
- Federico Montesino Pouzols fedem.nosp@m.p@al.nosp@m.tern..nosp@m.org
- Todo:
- implement reference counting from sources, so that when a source is destroyed, we know if the Participant should be destroyed.
Definition at line 124 of file sources.h.
Constructor & Destructor Documentation
Participant::Participant
(
const std::string &
cname )
Construct a new participant.
- Parameters
-
cname Unique CNAME identifier.
Definition at line 118 of file source.cpp.
Participant::~Participant
(
)
Member Function Documentation
const std::string & SDESItemsHolder::getItem
(
SDESItemType
type )
const
const std::string& Participant::getPRIVPrefix
(
)
const
inline
Get the prefix value for the PRIV SDES item.
- Returns
- PRIV SDES item prefix as a string.
- Return values
-
empty string when no PRIV SDES item has been received from this source.
Definition at line 151 of file sources.h.
const std::string& Participant::getSDESItem
(
SDESItemType
type )
const
Get the value of an SDES item.
For instance, getSDESItem(SDESItemTypeCNAME), return the CNAME of this Participant.
- 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).
Definition at line 140 of file sources.h.
const std::string &
val
)
inherited
void SDESItemsHolder::setPRIVPrefix
(
const std::string &
val )
inlineinherited
void Participant::setPRIVPrefix
(
const std::string
val )
inlineprivate
Set prefix value for the PRIV SDES item.
Definition at line 177 of file sources.h.
const std::string &
val
)
inlineprivate
Set the value of a SDES item.
Definition at line 170 of file sources.h.
Friends And Related Function Documentation
The documentation for this class was generated from the following files: