<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>jrtplib: RTCPSchedulerParams Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="jrtplib.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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</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>
<div class="contents">
<h1>RTCPSchedulerParams Class Reference</h1><!-- doxytag: class="RTCPSchedulerParams" -->Describes parameters used by the <a class="el" href="classRTCPScheduler.html" title="This class determines when RTCP compound packets should be sent.">RTCPScheduler</a> class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="rtcpscheduler_8h_source.html">rtcpscheduler.h</a>></code>
<p>
<div class="dynheader">
Collaboration diagram for RTCPSchedulerParams:</div>
<div class="dynsection">
<p><center><img src="classRTCPSchedulerParams__coll__graph.png" border="0" usemap="#RTCPSchedulerParams__coll__map" alt="Collaboration graph"></center>
<map name="RTCPSchedulerParams__coll__map">
<area shape="rect" href="classRTPTime.html" title="This class is used to specify wallclock time, delay intervals etc." alt="" coords="47,7,124,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classRTCPSchedulerParams-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">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPSchedulerParams.html#c6c5dd6001bd51c4f96f896c22e224f0">SetRTCPBandwidth</a> (double bw)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the RTCP bandwidth to be used to <code>bw</code> (in bytes per second). <a href="#c6c5dd6001bd51c4f96f896c22e224f0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPSchedulerParams.html#79d31bf4eb4b339f110fcabac4f23ae7">GetRTCPBandwidth</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the used RTCP bandwidth in bytes per second (default is 1000). <a href="#79d31bf4eb4b339f110fcabac4f23ae7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPSchedulerParams.html#79c78fc30d245baeccf5ebe33215e2b2">SetSenderBandwidthFraction</a> (double fraction)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the fraction of the RTCP bandwidth reserved for senders to <code>fraction</code>. <a href="#79c78fc30d245baeccf5ebe33215e2b2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPSchedulerParams.html#a3c32e288341d1b4f1350cd6d4c9da8e">GetSenderBandwidthFraction</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the fraction of the RTCP bandwidth reserved for senders (default is 25%). <a href="#a3c32e288341d1b4f1350cd6d4c9da8e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPSchedulerParams.html#a8ca4c1c82cad46f9221734f485b6fe1">SetMinimumTransmissionInterval</a> (const <a class="el" href="classRTPTime.html">RTPTime</a> &t)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the minimum (deterministic) interval between RTCP compound packets to <code>t</code>. <a href="#a8ca4c1c82cad46f9221734f485b6fe1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classRTPTime.html">RTPTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPSchedulerParams.html#7dc8968f2156c41ad12ab5224a34b02d">GetMinimumTransmissionInterval</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the minimum RTCP transmission interval (default is 5 seconds). <a href="#7dc8968f2156c41ad12ab5224a34b02d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPSchedulerParams.html#9fcd2d8d25f302f71c25884f28febf46">SetUseHalfAtStartup</a> (bool usehalf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If <code>usehalf</code> is <code>true</code>, only use half the minimum interval before sending the first RTCP compound packet. <a href="#9fcd2d8d25f302f71c25884f28febf46"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9d1710cdecf3f1b283296c53c5ae403b"></a><!-- doxytag: member="RTCPSchedulerParams::GetUseHalfAtStartup" ref="9d1710cdecf3f1b283296c53c5ae403b" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPSchedulerParams.html#9d1710cdecf3f1b283296c53c5ae403b">GetUseHalfAtStartup</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if only half the minimum interval should be used before sending the first RTCP compound packet (defualt is <code>true</code>). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPSchedulerParams.html#74ffd83e72183ba283739c2f970f9c30">SetRequestImmediateBYE</a> (bool v)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If <code>v</code> is <code>true</code>, the scheduler will schedule a BYE packet to be sent immediately if allowed. <a href="#74ffd83e72183ba283739c2f970f9c30"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fec076f9ce121d625fca2cbde62991d5"></a><!-- doxytag: member="RTCPSchedulerParams::GetRequestImmediateBYE" ref="fec076f9ce121d625fca2cbde62991d5" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPSchedulerParams.html#fec076f9ce121d625fca2cbde62991d5">GetRequestImmediateBYE</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns if the scheduler will schedule a BYE packet to be sent immediately if allowed (default is <code>true</code>). <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7dc8968f2156c41ad12ab5224a34b02d"></a><!-- doxytag: member="RTCPSchedulerParams::GetMinimumTransmissionInterval" ref="7dc8968f2156c41ad12ab5224a34b02d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRTPTime.html">RTPTime</a> RTCPSchedulerParams::GetMinimumTransmissionInterval </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="79d31bf4eb4b339f110fcabac4f23ae7"></a><!-- doxytag: member="RTCPSchedulerParams::GetRTCPBandwidth" ref="79d31bf4eb4b339f110fcabac4f23ae7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double RTCPSchedulerParams::GetRTCPBandwidth </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="a3c32e288341d1b4f1350cd6d4c9da8e"></a><!-- doxytag: member="RTCPSchedulerParams::GetSenderBandwidthFraction" ref="a3c32e288341d1b4f1350cd6d4c9da8e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double RTCPSchedulerParams::GetSenderBandwidthFraction </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="a8ca4c1c82cad46f9221734f485b6fe1"></a><!-- doxytag: member="RTCPSchedulerParams::SetMinimumTransmissionInterval" ref="a8ca4c1c82cad46f9221734f485b6fe1" args="(const RTPTime &t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTCPSchedulerParams::SetMinimumTransmissionInterval </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classRTPTime.html">RTPTime</a> & </td>
<td class="paramname"> <em>t</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="74ffd83e72183ba283739c2f970f9c30"></a><!-- doxytag: member="RTCPSchedulerParams::SetRequestImmediateBYE" ref="74ffd83e72183ba283739c2f970f9c30" args="(bool v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTCPSchedulerParams::SetRequestImmediateBYE </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>v</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="c6c5dd6001bd51c4f96f896c22e224f0"></a><!-- doxytag: member="RTCPSchedulerParams::SetRTCPBandwidth" ref="c6c5dd6001bd51c4f96f896c22e224f0" args="(double bw)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTCPSchedulerParams::SetRTCPBandwidth </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>bw</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="79c78fc30d245baeccf5ebe33215e2b2"></a><!-- doxytag: member="RTCPSchedulerParams::SetSenderBandwidthFraction" ref="79c78fc30d245baeccf5ebe33215e2b2" args="(double fraction)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTCPSchedulerParams::SetSenderBandwidthFraction </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>fraction</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="9fcd2d8d25f302f71c25884f28febf46"></a><!-- doxytag: member="RTCPSchedulerParams::SetUseHalfAtStartup" ref="9fcd2d8d25f302f71c25884f28febf46" args="(bool usehalf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTCPSchedulerParams::SetUseHalfAtStartup </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>usehalf</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>src/<a class="el" href="rtcpscheduler_8h_source.html">rtcpscheduler.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jul 26 09:42:14 2009 for jrtplib 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>
