<!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: AppDataUnit 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="class_app_data_unit-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">AppDataUnit Class Reference<div class="ingroups"><a class="el" href="group__queuebase.html">Base classes for RTP queues.</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Interface (envelope) to data received over RTP packets.
<a href="class_app_data_unit.html#details">More...</a></p>
<p><code>#include <<a class="el" href="queuebase_8h_source.html">queuebase.h</a>></code></p>
<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:ae0462a601ae93b31209a63096037e4e4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#ae0462a601ae93b31209a63096037e4e4">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 class="separator:ae0462a601ae93b31209a63096037e4e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adccd733b4cb1f844ac1d305b3cf8a1fe"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#adccd733b4cb1f844ac1d305b3cf8a1fe">~AppDataUnit</a> ()</td></tr>
<tr class="separator:adccd733b4cb1f844ac1d305b3cf8a1fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa7e2a24afa4bc13f1eacea65569043cb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#aa7e2a24afa4bc13f1eacea65569043cb">AppDataUnit</a> (const <a class="el" href="class_app_data_unit.html">AppDataUnit</a> &src)</td></tr>
<tr class="separator:aa7e2a24afa4bc13f1eacea65569043cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8fa1122581e6e660abbe417c2a5cba5"><td class="memItemLeft" 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#af8fa1122581e6e660abbe417c2a5cba5">operator=</a> (const <a class="el" href="class_app_data_unit.html">AppDataUnit</a> &source)</td></tr>
<tr class="memdesc:af8fa1122581e6e660abbe417c2a5cba5"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#af8fa1122581e6e660abbe417c2a5cba5">More...</a><br /></td></tr>
<tr class="separator:af8fa1122581e6e660abbe417c2a5cba5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a49592f6dd8c651597f78cf58f13464ab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__payload.html#ga0eee230c7ab57e31bb4e438a72354993">PayloadType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#a49592f6dd8c651597f78cf58f13464ab">getType</a> () const </td></tr>
<tr class="separator:a49592f6dd8c651597f78cf58f13464ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe15787e1cc84dd03b0769a5546d7a38"><td class="memItemLeft" align="right" valign="top">const uint8 *const </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#abe15787e1cc84dd03b0769a5546d7a38">getData</a> () const </td></tr>
<tr class="memdesc:abe15787e1cc84dd03b0769a5546d7a38"><td class="mdescLeft"> </td><td class="mdescRight">Get data as it is received in RTP packets (i.e. <a href="#abe15787e1cc84dd03b0769a5546d7a38">More...</a><br /></td></tr>
<tr class="separator:abe15787e1cc84dd03b0769a5546d7a38"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af41ffb3a12208e4ec9f6aa1b1180eedd"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#af41ffb3a12208e4ec9f6aa1b1180eedd">getSize</a> () const </td></tr>
<tr class="separator:af41ffb3a12208e4ec9f6aa1b1180eedd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe3507d58bdbd17c57846f3679d5f2d1"><td class="memItemLeft" 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#abe3507d58bdbd17c57846f3679d5f2d1">getSource</a> () const </td></tr>
<tr class="separator:abe3507d58bdbd17c57846f3679d5f2d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab906839553a219662ac3313f756bf3ca"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#ab906839553a219662ac3313f756bf3ca">isMarked</a> () const </td></tr>
<tr class="memdesc:ab906839553a219662ac3313f756bf3ca"><td class="mdescLeft"> </td><td class="mdescRight">Is this data unit marked?. <a href="#ab906839553a219662ac3313f756bf3ca">More...</a><br /></td></tr>
<tr class="separator:ab906839553a219662ac3313f756bf3ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7dcc3be7075451c19f68bb9536f64cd0"><td class="memItemLeft" align="right" valign="top">uint16 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#a7dcc3be7075451c19f68bb9536f64cd0">getSeqNum</a> () const </td></tr>
<tr class="memdesc:a7dcc3be7075451c19f68bb9536f64cd0"><td class="mdescLeft"> </td><td class="mdescRight">Get data unit sequence number. <a href="#a7dcc3be7075451c19f68bb9536f64cd0">More...</a><br /></td></tr>
<tr class="separator:a7dcc3be7075451c19f68bb9536f64cd0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a245c3e9693e2064bce8522099da28b4a"><td class="memItemLeft" align="right" valign="top">uint8 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#a245c3e9693e2064bce8522099da28b4a">getContributorsCount</a> () const </td></tr>
<tr class="memdesc:a245c3e9693e2064bce8522099da28b4a"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of contributing sources in the CSRC list. <a href="#a245c3e9693e2064bce8522099da28b4a">More...</a><br /></td></tr>
<tr class="separator:a245c3e9693e2064bce8522099da28b4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebeebfd00b3b8d8d98ac001a9d286f3f"><td class="memItemLeft" align="right" valign="top">const uint32 * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_app_data_unit.html#aebeebfd00b3b8d8d98ac001a9d286f3f">getContributorsID</a> () const </td></tr>
<tr class="memdesc:aebeebfd00b3b8d8d98ac001a9d286f3f"><td class="mdescLeft"> </td><td class="mdescRight">Get the array of 32-bit CSRC identifiers. <a href="#aebeebfd00b3b8d8d98ac001a9d286f3f">More...</a><br /></td></tr>
<tr class="separator:aebeebfd00b3b8d8d98ac001a9d286f3f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface (envelope) to data received over RTP packets. </p>
<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="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="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#_a8">rtpduphello.cpp</a>, <a class="el" href="rtphello_8cpp-example.html#_a7">rtphello.cpp</a>, and <a class="el" href="rtplisten_8cpp-example.html#_a7">rtplisten.cpp</a>.</dd>
</dl></div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae0462a601ae93b31209a63096037e4e4"></a>
<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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="adccd733b4cb1f844ac1d305b3cf8a1fe"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">AppDataUnit::~AppDataUnit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aa7e2a24afa4bc13f1eacea65569043cb"></a>
<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">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</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>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a245c3e9693e2064bce8522099da28b4a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8 AppDataUnit::getContributorsCount </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 number of contributing sources in the CSRC list. </p>
</div>
</div>
<a class="anchor" id="aebeebfd00b3b8d8d98ac001a9d286f3f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const uint32* AppDataUnit::getContributorsID </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 array of 32-bit CSRC identifiers. </p>
<dl class="section return"><dt>Returns</dt><dd>NULL if (<a class="el" href="class_app_data_unit.html#a245c3e9693e2064bce8522099da28b4a" title="Get the number of contributing sources in the CSRC list. ">getContributorsCount()</a> == 0) </dd></dl>
</div>
</div>
<a class="anchor" id="abe15787e1cc84dd03b0769a5546d7a38"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const uint8* const AppDataUnit::getData </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 data as it is received in RTP packets (i.e. </p>
<p>for multi-octet encodings, octets are in network order.</p>
<dl class="section return"><dt>Returns</dt><dd>Raw pointer to data block. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="audiorx_8cpp-example.html#a7">audiorx.cpp</a>, <a class="el" href="ccrtptest_8cpp-example.html#a5">ccrtptest.cpp</a>, <a class="el" href="rtpduphello_8cpp-example.html#a11">rtpduphello.cpp</a>, and <a class="el" href="rtphello_8cpp-example.html#a8">rtphello.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7dcc3be7075451c19f68bb9536f64cd0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint16 AppDataUnit::getSeqNum </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 data unit sequence number. </p>
</div>
</div>
<a class="anchor" id="af41ffb3a12208e4ec9f6aa1b1180eedd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t AppDataUnit::getSize </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">
<dl class="section return"><dt>Returns</dt><dd>length of data in octets </dd></dl>
<dl><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#a8">rtplisten.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="abe3507d58bdbd17c57846f3679d5f2d1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>Source that sent this data </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="rtplisten_8cpp-example.html#a10">rtplisten.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a49592f6dd8c651597f78cf58f13464ab"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__payload.html#ga0eee230c7ab57e31bb4e438a72354993">PayloadType</a> AppDataUnit::getType </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">
<dl class="section return"><dt>Returns</dt><dd>type of this data </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="rtplisten_8cpp-example.html#a9">rtplisten.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab906839553a219662ac3313f756bf3ca"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool AppDataUnit::isMarked </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>Is this data unit marked?. </p>
<dl class="section return"><dt>Returns</dt><dd>true if marked. </dd></dl>
</div>
</div>
<a class="anchor" id="af8fa1122581e6e660abbe417c2a5cba5"></a>
<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 class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</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>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the result of the assignment </dd></dl>
</div>
</div>
<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></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
>
41
