<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Yate: RTPReceiver Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</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 class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1RTPReceiver.html">RTPReceiver</a>
</div>
</div>
<div class="contents">
<h1>RTPReceiver Class Reference</h1><!-- doxytag: class="TelEngine::RTPReceiver" --><!-- doxytag: inherits="TelEngine::RTPBaseIO" -->RTP/RTCP packet receiver.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yatertp_8h-source.html">yatertp.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for RTPReceiver:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1RTPReceiver.png" usemap="#RTPReceiver_map" border="0" alt=""></center>
<map name="RTPReceiver_map">
<area href="classTelEngine_1_1RTPBaseIO.html" alt="RTPBaseIO" shape="rect" coords="0,0,86,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1RTPReceiver-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="classTelEngine_1_1RTPReceiver.html#1ee51cd89c434a5fa85713717fdcca05">RTPReceiver</a> (<a class="el" href="classTelEngine_1_1RTPSession.html">RTPSession</a> *session=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPReceiver.html#fb899f8d647a5ce10e6e2bfa93799a7d">~RTPReceiver</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPReceiver.html#d027e40693b58693394405a78528de70">setDejitter</a> (<a class="el" href="classTelEngine_1_1RTPDejitter.html">RTPDejitter</a> *dejitter)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPReceiver.html#62a1999296be58a42c55bd54c7a24183">setDejitter</a> (unsigned int mindelay, unsigned int maxdelay)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPReceiver.html#e678cca5cfeb7c8a58b16d41d8706ae5">rtpRecv</a> (bool marker, int payload, unsigned int timestamp, const void *data, int len)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPReceiver.html#a539e395602c98a4ecbdd75781742e95">rtpRecvData</a> (bool marker, unsigned int timestamp, const void *data, int len)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPReceiver.html#b646b71f45303825af34b38dcb8f5257">rtpRecvEvent</a> (int event, char key, int duration, int volume, unsigned int timestamp)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPReceiver.html#0c8abf13a5befeab556cbb8d1d9e96a8">rtpNewPayload</a> (int payload, unsigned int timestamp)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPReceiver.html#124c4a4f4d09c2810ed40d20a2bb30fe">rtpNewSSRC</a> (u_int32_t newSsrc, bool marker)</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPReceiver.html#c7cf24f02cfa3147bf2cbf6434edb9c0">timerTick</a> (const <a class="el" href="classTelEngine_1_1Time.html">Time</a> &when)</td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26e33ecea0308f1345ac1e8010b0ecb8"></a><!-- doxytag: member="TelEngine::RTPReceiver::RTPSession" ref="26e33ecea0308f1345ac1e8010b0ecb8" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>RTPSession</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
RTP/RTCP packet receiver.
<p>
Class that handles incoming RTP and RTCP packets <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="1ee51cd89c434a5fa85713717fdcca05"></a><!-- doxytag: member="TelEngine::RTPReceiver::RTPReceiver" ref="1ee51cd89c434a5fa85713717fdcca05" args="(RTPSession *session=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1RTPReceiver.html">RTPReceiver</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1RTPSession.html">RTPSession</a> * </td>
<td class="paramname"> <em>session</em> = <code>0</code> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor
</div>
</div><p>
<a class="anchor" name="fb899f8d647a5ce10e6e2bfa93799a7d"></a><!-- doxytag: member="TelEngine::RTPReceiver::~RTPReceiver" ref="fb899f8d647a5ce10e6e2bfa93799a7d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1RTPReceiver.html">RTPReceiver</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor - gets rid of the jitter buffer if present
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0c8abf13a5befeab556cbb8d1d9e96a8"></a><!-- doxytag: member="TelEngine::RTPReceiver::rtpNewPayload" ref="0c8abf13a5befeab556cbb8d1d9e96a8" args="(int payload, unsigned int timestamp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void rtpNewPayload </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>payload</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>timestamp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Method called for unknown payload types just before attempting to call <a class="el" href="classTelEngine_1_1RTPReceiver.html#a539e395602c98a4ecbdd75781742e95">rtpRecvData()</a>. This is a good opportunity to change the payload type and continue. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>payload</em> </td><td>Payload number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timestamp</em> </td><td>Sampling instant of the unexpected packet data </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="124c4a4f4d09c2810ed40d20a2bb30fe"></a><!-- doxytag: member="TelEngine::RTPReceiver::rtpNewSSRC" ref="124c4a4f4d09c2810ed40d20a2bb30fe" args="(u_int32_t newSsrc, bool marker)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void rtpNewSSRC </td>
<td>(</td>
<td class="paramtype">u_int32_t </td>
<td class="paramname"> <em>newSsrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>marker</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Method called when a packet with an unexpected SSRC is received just before processing further. This is a good opportunity to change the SSRC and continue <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>newSsrc</em> </td><td>SSRC received in packet </td></tr>
<tr><td valign="top"></td><td valign="top"><em>marker</em> </td><td>True if marker bit is set in the RTP packet </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e678cca5cfeb7c8a58b16d41d8706ae5"></a><!-- doxytag: member="TelEngine::RTPReceiver::rtpRecv" ref="e678cca5cfeb7c8a58b16d41d8706ae5" args="(bool marker, int payload, unsigned int timestamp, const void *data, int len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool rtpRecv </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>marker</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>payload</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>timestamp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Process one RTP payload packet. Default behaviour is to call <a class="el" href="classTelEngine_1_1RTPReceiver.html#a539e395602c98a4ecbdd75781742e95">rtpRecvData()</a> or <a class="el" href="classTelEngine_1_1RTPReceiver.html#b646b71f45303825af34b38dcb8f5257">rtpRecvEvent()</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>marker</em> </td><td>Set to true if the marker bit is set </td></tr>
<tr><td valign="top"></td><td valign="top"><em>payload</em> </td><td>Payload number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timestamp</em> </td><td>Sampling instant of the packet data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Pointer to data block to process </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Length of the data block in bytes </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if data was handled </dd></dl>
</div>
</div><p>
<a class="anchor" name="a539e395602c98a4ecbdd75781742e95"></a><!-- doxytag: member="TelEngine::RTPReceiver::rtpRecvData" ref="a539e395602c98a4ecbdd75781742e95" args="(bool marker, unsigned int timestamp, const void *data, int len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool rtpRecvData </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>marker</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>timestamp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Process one RTP data packet <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>marker</em> </td><td>Set to true if the marker bit is set </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timestamp</em> </td><td>Sampling instant of the packet data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Pointer to data block to process </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Length of the data block in bytes </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if data was handled </dd></dl>
</div>
</div><p>
<a class="anchor" name="b646b71f45303825af34b38dcb8f5257"></a><!-- doxytag: member="TelEngine::RTPReceiver::rtpRecvEvent" ref="b646b71f45303825af34b38dcb8f5257" args="(int event, char key, int duration, int volume, unsigned int timestamp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool rtpRecvEvent </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>duration</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>volume</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>timestamp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Process one RTP event <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>Received event code </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Received key (for events 0-16) or zero </td></tr>
<tr><td valign="top"></td><td valign="top"><em>duration</em> </td><td>Duration of the event as number of samples </td></tr>
<tr><td valign="top"></td><td valign="top"><em>volume</em> </td><td>Attenuation of the tone, zero for don't care </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timestamp</em> </td><td>Sampling instant of the initial packet data </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if data was handled </dd></dl>
</div>
</div><p>
<a class="anchor" name="62a1999296be58a42c55bd54c7a24183"></a><!-- doxytag: member="TelEngine::RTPReceiver::setDejitter" ref="62a1999296be58a42c55bd54c7a24183" args="(unsigned int mindelay, unsigned int maxdelay)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setDejitter </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>mindelay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>maxdelay</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allocate and set a new dejitter buffer in this receiver <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>mindelay</em> </td><td>Minimum length of the dejitter buffer in microseconds </td></tr>
<tr><td valign="top"></td><td valign="top"><em>maxdelay</em> </td><td>Maximum length of the dejitter buffer in microseconds </td></tr>
</table>
</dl>
<p>References <a class="el" href="yatertp_8h-source.html#l00490">RTPReceiver::setDejitter()</a>.</p>
<p>Referenced by <a class="el" href="yatertp_8h-source.html#l00490">RTPReceiver::setDejitter()</a>.</p>
</div>
</div><p>
<a class="anchor" name="d027e40693b58693394405a78528de70"></a><!-- doxytag: member="TelEngine::RTPReceiver::setDejitter" ref="d027e40693b58693394405a78528de70" args="(RTPDejitter *dejitter)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setDejitter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1RTPDejitter.html">RTPDejitter</a> * </td>
<td class="paramname"> <em>dejitter</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set a new dejitter buffer in this receiver <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dejitter</em> </td><td>New dejitter buffer to set, NULL to remove </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="c7cf24f02cfa3147bf2cbf6434edb9c0"></a><!-- doxytag: member="TelEngine::RTPReceiver::timerTick" ref="c7cf24f02cfa3147bf2cbf6434edb9c0" args="(const Time &when)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void timerTick </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1Time.html">Time</a> & </td>
<td class="paramname"> <em>when</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Method called periodically to finish lingering events <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>when</em> </td><td><a class="el" href="classTelEngine_1_1Time.html" title="A time holding class.">Time</a> to use as base in all computing </td></tr>
</table>
</dl>
<p>Implements <a class="el" href="classTelEngine_1_1RTPBaseIO.html#2cc5feab91a437e2a272bc093c0d4ee0">RTPBaseIO</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatertp_8h-source.html">yatertp.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:13 2008 for Yate by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
eeacaa4eb55fa544d622989e42fc27b1
>
files
>
396
