<!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: RTPSender 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_1RTPSender.html">RTPSender</a>
</div>
</div>
<div class="contents">
<h1>RTPSender Class Reference</h1><!-- doxytag: class="TelEngine::RTPSender" --><!-- doxytag: inherits="TelEngine::RTPBaseIO" -->RTP/RTCP packet sender.
<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 RTPSender:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1RTPSender.png" usemap="#RTPSender_map" border="0" alt=""></center>
<map name="RTPSender_map">
<area href="classTelEngine_1_1RTPBaseIO.html" alt="RTPBaseIO" shape="rect" coords="0,0,76,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1RTPSender-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_1RTPSender.html#b1c781db273271b16017393cdb414d48">RTPSender</a> (<a class="el" href="classTelEngine_1_1RTPSession.html">RTPSession</a> *session=0, bool randomTs=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPSender.html#6358655e0b2345e7fcb6347a5a661892">~RTPSender</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPSender.html#9a63b53fcb48373b7060ac06d068f1b3">rtpSend</a> (bool marker, int payload, unsigned int timestamp, const void *data, int len)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPSender.html#c613df8b4984b817c9c054a1704e218f">rtpSendData</a> (bool marker, unsigned int timestamp, const void *data, int len)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPSender.html#48cb92a081a0e315ed28988d717c4cea">rtpSendEvent</a> (int event, int duration, int volume=0, unsigned int timestamp=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPSender.html#965cdcdc6ba3878a57ea13ac4d40f904">rtpSendKey</a> (char key, int duration, int volume=0, unsigned int timestamp=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPSender.html#c73223cbf894ed34cbe7b8e01bbc828f">padding</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1RTPSender.html#e2449c7112750f808ca52e157683b7ed">padding</a> (int chunk)</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_1RTPSender.html#c7cf24f02cfa3147bf2cbf6434edb9c0">timerTick</a> (const <a class="el" href="classTelEngine_1_1Time.html">Time</a> &when)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
RTP/RTCP packet sender.
<p>
Class that builds and sends RTP and RTCP packets <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="b1c781db273271b16017393cdb414d48"></a><!-- doxytag: member="TelEngine::RTPSender::RTPSender" ref="b1c781db273271b16017393cdb414d48" args="(RTPSession *session=0, bool randomTs=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1RTPSender.html">RTPSender</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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>randomTs</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>session</em> </td><td>RTP session the sender belongs </td></tr>
<tr><td valign="top"></td><td valign="top"><em>randomTs</em> </td><td>Initialize a random timestamp offset </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="6358655e0b2345e7fcb6347a5a661892"></a><!-- doxytag: member="TelEngine::RTPSender::~RTPSender" ref="6358655e0b2345e7fcb6347a5a661892" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1RTPSender.html">RTPSender</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Do-nothing destructor
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e2449c7112750f808ca52e157683b7ed"></a><!-- doxytag: member="TelEngine::RTPSender::padding" ref="e2449c7112750f808ca52e157683b7ed" args="(int chunk)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool padding </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>chunk</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the padding to a multiple of a data chunk <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>chunk</em> </td><td>Size to pad the payload to a multiple of </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the new chunk size is valid </dd></dl>
</div>
</div><p>
<a class="anchor" name="c73223cbf894ed34cbe7b8e01bbc828f"></a><!-- doxytag: member="TelEngine::RTPSender::padding" ref="c73223cbf894ed34cbe7b8e01bbc828f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int padding </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the payload padding size <dl class="return" compact><dt><b>Returns:</b></dt><dd>Chunk size to pad the payload to a multiple of </dd></dl>
</div>
</div><p>
<a class="anchor" name="9a63b53fcb48373b7060ac06d068f1b3"></a><!-- doxytag: member="TelEngine::RTPSender::rtpSend" ref="9a63b53fcb48373b7060ac06d068f1b3" 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">bool rtpSend </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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Send one RTP payload 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 must be 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 send </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Length of the data block </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if data sending was attempted </dd></dl>
</div>
</div><p>
<a class="anchor" name="c613df8b4984b817c9c054a1704e218f"></a><!-- doxytag: member="TelEngine::RTPSender::rtpSendData" ref="c613df8b4984b817c9c054a1704e218f" args="(bool marker, unsigned int timestamp, const void *data, int len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool rtpSendData </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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Send 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 must be 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 send </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Length of the data block </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if data sending was attempted </dd></dl>
</div>
</div><p>
<a class="anchor" name="48cb92a081a0e315ed28988d717c4cea"></a><!-- doxytag: member="TelEngine::RTPSender::rtpSendEvent" ref="48cb92a081a0e315ed28988d717c4cea" args="(int event, int duration, int volume=0, unsigned int timestamp=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool rtpSendEvent </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">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> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>timestamp</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Send 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>Event code to send </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 packet data, zero to use current </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if data sending was attempted </dd></dl>
</div>
</div><p>
<a class="anchor" name="965cdcdc6ba3878a57ea13ac4d40f904"></a><!-- doxytag: member="TelEngine::RTPSender::rtpSendKey" ref="965cdcdc6ba3878a57ea13ac4d40f904" args="(char key, int duration, int volume=0, unsigned int timestamp=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool rtpSendKey </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> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>timestamp</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Send one RTP key 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>key</em> </td><td>Key to send </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 packet data, zero to use current </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if data sending was attempted </dd></dl>
</div>
</div><p>
<a class="anchor" name="c7cf24f02cfa3147bf2cbf6434edb9c0"></a><!-- doxytag: member="TelEngine::RTPSender::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 send events and buffered data <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
>
399
