<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>ccRTP: Participant Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ccRTP
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="class_participant-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Participant Class Reference<div class="ingroups"><a class="el" href="group__sources.html">Participants and synchronization sources.</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A class of objects representing remote participants (RTP applications) in a multimedia session.
<a href="class_participant.html#details">More...</a></p>
<p><code>#include <<a class="el" href="sources_8h_source.html">sources.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Participant:</div>
<div class="dyncontent">
<div class="center">
<img src="class_participant.png" usemap="#Participant_map" alt=""/>
<map id="Participant_map" name="Participant_map">
<area href="class_s_d_e_s_items_holder.html" title="Holds the SDES items and related information from a participant in an RTP application. " alt="SDESItemsHolder" shape="rect" coords="0,0,111,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a09080be78b19740b978800a1ec51bc3e"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_participant.html#a09080be78b19740b978800a1ec51bc3e">getSDESItem</a> (<a class="el" href="group__rtcppacket.html#gaf6d38e5ccbbcdf2a24ebbd4fc5b4eeac">SDESItemType</a> type) const </td></tr>
<tr class="memdesc:a09080be78b19740b978800a1ec51bc3e"><td class="mdescLeft"> </td><td class="mdescRight">Get the value of an SDES item. <a href="#a09080be78b19740b978800a1ec51bc3e">More...</a><br /></td></tr>
<tr class="separator:a09080be78b19740b978800a1ec51bc3e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e0f43f97faa6466378859b0ea6cd256"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_participant.html#a5e0f43f97faa6466378859b0ea6cd256">getPRIVPrefix</a> () const </td></tr>
<tr class="memdesc:a5e0f43f97faa6466378859b0ea6cd256"><td class="mdescLeft"> </td><td class="mdescRight">Get the prefix value for the PRIV SDES item. <a href="#a5e0f43f97faa6466378859b0ea6cd256">More...</a><br /></td></tr>
<tr class="separator:a5e0f43f97faa6466378859b0ea6cd256"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a38ef89322981d3c50d7f2ea356089633"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_participant.html#a38ef89322981d3c50d7f2ea356089633">Participant</a> (const std::string &cname)</td></tr>
<tr class="memdesc:a38ef89322981d3c50d7f2ea356089633"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new participant. <a href="#a38ef89322981d3c50d7f2ea356089633">More...</a><br /></td></tr>
<tr class="separator:a38ef89322981d3c50d7f2ea356089633"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb8c8a103cf97d1bacbd5e3621041522"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_participant.html#afb8c8a103cf97d1bacbd5e3621041522">~Participant</a> ()</td></tr>
<tr class="separator:afb8c8a103cf97d1bacbd5e3621041522"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ac5f576c6041abd2767b03df2263aa432"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_participant.html#ac5f576c6041abd2767b03df2263aa432">ParticipantHandler</a></td></tr>
<tr class="separator:ac5f576c6041abd2767b03df2263aa432"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class of objects representing remote participants (RTP applications) in a multimedia session. </p>
<p>Any RTP socket/queue class that directly or indirectly inherits from <a class="el" href="class_queue_r_t_c_p_manager.html" title="Adds generic management of RTCP functions to an RTP data queue. ">QueueRTCPManager</a> (and hence has RTCP support) will represent participants from which any RTP or RTCP packet has been received through a <a class="el" href="class_participant.html" title="A class of objects representing remote participants (RTP applications) in a multimedia session...">Participant</a> object. These <a class="el" href="class_participant.html" title="A class of objects representing remote participants (RTP applications) in a multimedia session...">Participant</a> objects are entities such as end systems (user applications, monitors, etc), RTP mixers and RTP translators.</p>
<p><a class="el" href="class_participant.html" title="A class of objects representing remote participants (RTP applications) in a multimedia session...">Participant</a> 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 (</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="class_sync_source.html" title="Synchronization source in an RTP session. ">SyncSource</a>).</dd></dl>
<p>If an RTP application based on ccRTP receives packets from itself (for instance, it is included in the destination list), there will be a <a class="el" href="class_participant.html" title="A class of objects representing remote participants (RTP applications) in a multimedia session...">Participant</a> object that corresponds to the "local participant" (<a class="el" href="class_r_t_p_application.html" title="An RTP application, holding identifying RTCP SDES item values. ">RTPApplication</a>) object.</p>
<dl class="section author"><dt>Author</dt><dd>Federico Montesino Pouzols <a href="#" onclick="location.href='mai'+'lto:'+'fed'+'em'+'p@a'+'lt'+'ern'+'.o'+'rg'; return false;">fedem<span style="display: none;">.nosp@m.</span>p@al<span style="display: none;">.nosp@m.</span>tern.<span style="display: none;">.nosp@m.</span>org</a></dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="ccrtptest_8cpp-example.html#_a17">ccrtptest.cpp</a>.</dd>
</dl></div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a38ef89322981d3c50d7f2ea356089633"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Participant::Participant </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>cname</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a new participant. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cname</td><td>Unique CNAME identifier. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="afb8c8a103cf97d1bacbd5e3621041522"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Participant::~Participant </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a5e0f43f97faa6466378859b0ea6cd256"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string& Participant::getPRIVPrefix </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the prefix value for the PRIV SDES item. </p>
<dl class="section return"><dt>Returns</dt><dd>PRIV SDES item prefix as a string. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">empty</td><td>string when no PRIV SDES item has been received from this source. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a09080be78b19740b978800a1ec51bc3e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string& Participant::getSDESItem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__rtcppacket.html#gaf6d38e5ccbbcdf2a24ebbd4fc5b4eeac">SDESItemType</a> </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the value of an SDES item. </p>
<p>For instance, getSDESItem(SDESItemTypeCNAME), return the CNAME of this <a class="el" href="class_participant.html" title="A class of objects representing remote participants (RTP applications) in a multimedia session...">Participant</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>type of SDES item to get value of.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>value of the SDES item as a string. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">empty</td><td>string when the value is not known (no RTCP packet with the requested SDES item has been received from this source). </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="ccrtptest_8cpp-example.html#a19">ccrtptest.cpp</a>, and <a class="el" href="rtplisten_8cpp-example.html#a17">rtplisten.cpp</a>.</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="ac5f576c6041abd2767b03df2263aa432"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="class_participant_handler.html">ParticipantHandler</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="sources_8h_source.html">sources.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Feb 8 2015 08:32:24 for ccRTP by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
a2fa4fed774700990ee58705b206cf50
>
files
>
88
