<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ccRTP: AppDataUnit Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="tabs">
<ul>
<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>
<div class="contents">
<h1>AppDataUnit Class Reference<br>
<small>
[<a class="el" href="group__queuebase.html">Base classes for RTP queues.</a>]</small>
</h1><!-- doxytag: class="AppDataUnit" -->Interface (envelope) to data received over RTP packets.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="queuebase_8h_source.html">queuebase.h</a>></code>
<p>
<p>
<a href="class_app_data_unit-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#e0462a601ae93b31209a63096037e4e4">AppDataUnit</a> (const <a class="el" href="class_incoming_r_t_p_pkt.html">IncomingRTPPkt</a> &packet, const <a class="el" href="class_sync_source.html">SyncSource</a> &src)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#dccd733b4cb1f844ac1d305b3cf8a1fe">~AppDataUnit</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#a7e2a24afa4bc13f1eacea65569043cb">AppDataUnit</a> (const <a class="el" href="class_app_data_unit.html">AppDataUnit</a> &src)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_app_data_unit.html">AppDataUnit</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#f8fa1122581e6e660abbe417c2a5cba5">operator=</a> (const <a class="el" href="class_app_data_unit.html">AppDataUnit</a> &source)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#f8fa1122581e6e660abbe417c2a5cba5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__payload.html#g0eee230c7ab57e31bb4e438a72354993">PayloadType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#49592f6dd8c651597f78cf58f13464ab">getType</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const uint8 *const </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#be15787e1cc84dd03b0769a5546d7a38">getData</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get data as it is received in RTP packets (i.e. <a href="#be15787e1cc84dd03b0769a5546d7a38"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#f41ffb3a12208e4ec9f6aa1b1180eedd">getSize</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="class_sync_source.html">SyncSource</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#be3507d58bdbd17c57846f3679d5f2d1">getSource</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#b906839553a219662ac3313f756bf3ca">isMarked</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Is this data unit marked?. <a href="#b906839553a219662ac3313f756bf3ca"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint16 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#7dcc3be7075451c19f68bb9536f64cd0">getSeqNum</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get data unit sequence number. <a href="#7dcc3be7075451c19f68bb9536f64cd0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint8 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#245c3e9693e2064bce8522099da28b4a">getContributorsCount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of contributing sources in the CSRC list. <a href="#245c3e9693e2064bce8522099da28b4a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const uint32 * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#ebeebfd00b3b8d8d98ac001a9d286f3f">getContributorsID</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the array of 32-bit CSRC identifiers. <a href="#ebeebfd00b3b8d8d98ac001a9d286f3f"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Interface (envelope) to data received over RTP packets.
<p>
A class of objects representing data transmitted over RTP packets. Tipically, this object will apply to received data. Data blocks received via RTP connections as well as its related objects (source, etc), are accessed through the methods of this class.<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd>Federico Montesino Pouzols <<a href="mailto:fedemp@altern.org">fedemp@altern.org</a>> </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="audiorx_8cpp-example.html#_a4">audiorx.cpp</a>, <a class="el" href="ccrtptest_8cpp-example.html#_a3">ccrtptest.cpp</a>, <a class="el" href="rtpduphello_8cpp-example.html#_a3">rtpduphello.cpp</a>, <a class="el" href="rtphello_8cpp-example.html#_a6">rtphello.cpp</a>, and <a class="el" href="rtplisten_8cpp-example.html#_a8">rtplisten.cpp</a>.</dl><hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="e0462a601ae93b31209a63096037e4e4"></a><!-- doxytag: member="AppDataUnit::AppDataUnit" ref="e0462a601ae93b31209a63096037e4e4" args="(const IncomingRTPPkt &packet, const SyncSource &src)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AppDataUnit::AppDataUnit </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_incoming_r_t_p_pkt.html">IncomingRTPPkt</a> & </td>
<td class="paramname"> <em>packet</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_sync_source.html">SyncSource</a> & </td>
<td class="paramname"> <em>src</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="dccd733b4cb1f844ac1d305b3cf8a1fe"></a><!-- doxytag: member="AppDataUnit::~AppDataUnit" ref="dccd733b4cb1f844ac1d305b3cf8a1fe" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AppDataUnit::~AppDataUnit </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="a7e2a24afa4bc13f1eacea65569043cb"></a><!-- doxytag: member="AppDataUnit::AppDataUnit" ref="a7e2a24afa4bc13f1eacea65569043cb" args="(const AppDataUnit &src)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AppDataUnit::AppDataUnit </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_app_data_unit.html">AppDataUnit</a> & </td>
<td class="paramname"> <em>src</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>the <a class="el" href="class_app_data_unit.html" title="Interface (envelope) to data received over RTP packets.">AppDataUnit</a> object being copied </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="245c3e9693e2064bce8522099da28b4a"></a><!-- doxytag: member="AppDataUnit::getContributorsCount" ref="245c3e9693e2064bce8522099da28b4a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8 AppDataUnit::getContributorsCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of contributing sources in the CSRC list.
<p>
</div>
</div><p>
<a class="anchor" name="ebeebfd00b3b8d8d98ac001a9d286f3f"></a><!-- doxytag: member="AppDataUnit::getContributorsID" ref="ebeebfd00b3b8d8d98ac001a9d286f3f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint32* AppDataUnit::getContributorsID </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the array of 32-bit CSRC identifiers.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>NULL if (<a class="el" href="class_app_data_unit.html#245c3e9693e2064bce8522099da28b4a" title="Get the number of contributing sources in the CSRC list.">getContributorsCount()</a> == 0) </dd></dl>
</div>
</div><p>
<a class="anchor" name="be15787e1cc84dd03b0769a5546d7a38"></a><!-- doxytag: member="AppDataUnit::getData" ref="be15787e1cc84dd03b0769a5546d7a38" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint8* const AppDataUnit::getData </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get data as it is received in RTP packets (i.e.
<p>
for multi-octet encodings, octets are in network order.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Raw pointer to data block. </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="audiorx_8cpp-example.html#a5">audiorx.cpp</a>, <a class="el" href="ccrtptest_8cpp-example.html#a4">ccrtptest.cpp</a>, <a class="el" href="rtpduphello_8cpp-example.html#a4">rtpduphello.cpp</a>, and <a class="el" href="rtphello_8cpp-example.html#a7">rtphello.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="7dcc3be7075451c19f68bb9536f64cd0"></a><!-- doxytag: member="AppDataUnit::getSeqNum" ref="7dcc3be7075451c19f68bb9536f64cd0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16 AppDataUnit::getSeqNum </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get data unit sequence number.
<p>
</div>
</div><p>
<a class="anchor" name="f41ffb3a12208e4ec9f6aa1b1180eedd"></a><!-- doxytag: member="AppDataUnit::getSize" ref="f41ffb3a12208e4ec9f6aa1b1180eedd" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t AppDataUnit::getSize </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>length of data in octets </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="audiorx_8cpp-example.html#a6">audiorx.cpp</a>, and <a class="el" href="rtplisten_8cpp-example.html#a9">rtplisten.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="be3507d58bdbd17c57846f3679d5f2d1"></a><!-- doxytag: member="AppDataUnit::getSource" ref="be3507d58bdbd17c57846f3679d5f2d1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="class_sync_source.html">SyncSource</a>& AppDataUnit::getSource </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Source that sent this data </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="rtplisten_8cpp-example.html#a11">rtplisten.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="49592f6dd8c651597f78cf58f13464ab"></a><!-- doxytag: member="AppDataUnit::getType" ref="49592f6dd8c651597f78cf58f13464ab" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__payload.html#g0eee230c7ab57e31bb4e438a72354993">PayloadType</a> AppDataUnit::getType </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>type of this data </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="rtplisten_8cpp-example.html#a10">rtplisten.cpp</a>.</dl>
</div>
</div><p>
<a class="anchor" name="b906839553a219662ac3313f756bf3ca"></a><!-- doxytag: member="AppDataUnit::isMarked" ref="b906839553a219662ac3313f756bf3ca" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool AppDataUnit::isMarked </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Is this data unit marked?.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if marked. </dd></dl>
</div>
</div><p>
<a class="anchor" name="f8fa1122581e6e660abbe417c2a5cba5"></a><!-- doxytag: member="AppDataUnit::operator=" ref="f8fa1122581e6e660abbe417c2a5cba5" args="(const AppDataUnit &source)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_app_data_unit.html">AppDataUnit</a>& AppDataUnit::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_app_data_unit.html">AppDataUnit</a> & </td>
<td class="paramname"> <em>source</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assignment operator.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>the <a class="el" href="class_app_data_unit.html" title="Interface (envelope) to data received over RTP packets.">AppDataUnit</a> object being assigned </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the result of the assignment </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="queuebase_8h_source.html">queuebase.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jul 24 21:42:25 2009 for ccRTP by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
