Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > 7c0c66d6521a2c8efa0ef6bf03291d7f > files > 189

jrtplib-devel-3.7.1-7.fc12.i686.rpm

<!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: RTPSessionParams 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>RTPSessionParams Class Reference</h1><!-- doxytag: class="RTPSessionParams" -->Describes the parameters for to be used by an <a class="el" href="classRTPSession.html" title="High level class for using RTP.">RTPSession</a> instance.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="rtpsessionparams_8h_source.html">rtpsessionparams.h</a>&gt;</code>
<p>
<div class="dynheader">
Collaboration diagram for RTPSessionParams:</div>
<div class="dynsection">
<p><center><img src="classRTPSessionParams__coll__graph.png" border="0" usemap="#RTPSessionParams__coll__map" alt="Collaboration graph"></center>
<map name="RTPSessionParams__coll__map">
<area shape="rect" href="classRTPTime.html" title="This class is used to specify wallclock time, delay intervals etc." alt="" coords="36,7,113,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classRTPSessionParams-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"><a class="anchor" name="a7c5d107791c0cf0468489d6046918dd"></a><!-- doxytag: member="RTPSessionParams::SetUsePollThread" ref="a7c5d107791c0cf0468489d6046918dd" args="(bool usethread)" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#a7c5d107791c0cf0468489d6046918dd">SetUsePollThread</a> (bool usethread)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If <code>usethread</code> is <code>true</code>, the session will use a poll thread to automatically process incoming data and to send RTCP packets when necessary. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#cebd973fdacb895d9822da5b72db5282">IsUsingPollThread</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether the session should use a poll thread or not (default is <code>true</code>).  <a href="#cebd973fdacb895d9822da5b72db5282"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#4a3188faeb8d8298c8b3ee66d42a4ce5">SetMaximumPacketSize</a> (size_t max)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the maximum allowed packet size for the session.  <a href="#4a3188faeb8d8298c8b3ee66d42a4ce5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#b18dfcb648ba057a2df6010470d5ace6">GetMaximumPacketSize</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the maximum allowed packet size (default is 1400 bytes).  <a href="#b18dfcb648ba057a2df6010470d5ace6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="39a500a498a3c04d48c565460e75af70"></a><!-- doxytag: member="RTPSessionParams::SetAcceptOwnPackets" ref="39a500a498a3c04d48c565460e75af70" args="(bool accept)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#39a500a498a3c04d48c565460e75af70">SetAcceptOwnPackets</a> (bool accept)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If the argument is <code>true</code>, the session should accept its own packets and store them accordingly in the source table. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#41af1e40190425e09b198648c51f8c38">AcceptOwnPackets</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns <code>true</code> if the session should accept its own packets (default is <code>false</code>).  <a href="#41af1e40190425e09b198648c51f8c38"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#a71b986e27370e01313e46c5750e3133">SetReceiveMode</a> (<a class="el" href="classRTPTransmitter.html#bae77e9adf52db77f5ea29757dfa6386">RTPTransmitter::ReceiveMode</a> recvmode)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the receive mode to be used by the session.  <a href="#a71b986e27370e01313e46c5750e3133"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classRTPTransmitter.html#bae77e9adf52db77f5ea29757dfa6386">RTPTransmitter::ReceiveMode</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#8d2dc2bde9cf65fcc8445b73ac01ca82">GetReceiveMode</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the receive mode to be used by the session (default is: accept all packets).  <a href="#8d2dc2bde9cf65fcc8445b73ac01ca82"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#7edf8de28827890508192680a733a8a0">SetOwnTimestampUnit</a> (double tsunit)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the timestamp unit for our own data.  <a href="#7edf8de28827890508192680a733a8a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#468e1bec0777aa83284744f6a734274f">GetOwnTimestampUnit</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the currently set timestamp unit.  <a href="#468e1bec0777aa83284744f6a734274f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#7ff2bb9cb3492a60edf695d8bc9192af">SetResolveLocalHostname</a> (bool v)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets a flag indicating if a DNS lookup should be done to determine our hostname (to construct a CNAME item).  <a href="#7ff2bb9cb3492a60edf695d8bc9192af"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a1d40ef72453749f420cfbd2383b855"></a><!-- doxytag: member="RTPSessionParams::GetResolveLocalHostname" ref="2a1d40ef72453749f420cfbd2383b855" args="() const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#2a1d40ef72453749f420cfbd2383b855">GetResolveLocalHostname</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether the local hostname should be determined from the transmitter's list of local IP addresses or not (default is <code>false</code>). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#39d54ea93e92cd13364d3e969b9e4d50">SetProbationType</a> (<a class="el" href="classRTPSources.html#c56d7cb0238003c4e803471d1889ff35">RTPSources::ProbationType</a> probtype)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If probation support is enabled, this function sets the probation type to be used.  <a href="#39d54ea93e92cd13364d3e969b9e4d50"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classRTPSources.html#c56d7cb0238003c4e803471d1889ff35">RTPSources::ProbationType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#e91a57ccdfb5599221e148ac6683b4c2">GetProbationType</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the probation type which will be used (default is <a class="el" href="classRTPSources.html#c56d7cb0238003c4e803471d1889ff354bae46da9a267cb8bf2db85feb3e3e32" title="Store incoming RTP packet from a source that&#39;s on probation for later retrieval...">RTPSources::ProbationStore</a>).  <a href="#e91a57ccdfb5599221e148ac6683b4c2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#5f0c266b6b21eea3d94ccc816193d078">SetSessionBandwidth</a> (double sessbw)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the session bandwidth in bytes per second.  <a href="#5f0c266b6b21eea3d94ccc816193d078"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#61965713190d0ee846a45fc63276aede">GetSessionBandwidth</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the session bandwidth in bytes per second (default is 10000 bytes per second).  <a href="#61965713190d0ee846a45fc63276aede"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#cfeff2c7f0fb34822826868ad51e841a">SetControlTrafficFraction</a> (double frac)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the fraction of the session bandwidth to be used for control traffic.  <a href="#cfeff2c7f0fb34822826868ad51e841a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#0c2666007ab05e4d7e6cf913b562bfc8">GetControlTrafficFraction</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the fraction of the session bandwidth that will be used for control traffic (default is 5%).  <a href="#0c2666007ab05e4d7e6cf913b562bfc8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#73229616f32a7bd93210b8571d89d133">SetSenderControlBandwidthFraction</a> (double frac)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the minimum fraction of the control traffic that will be used by senders.  <a href="#73229616f32a7bd93210b8571d89d133"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#80c40900663e370b8f44743081aa47ec">GetSenderControlBandwidthFraction</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the minimum fraction of the control traffic that will be used by senders (default is 25%).  <a href="#80c40900663e370b8f44743081aa47ec"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#764e4ad0484d781914af79eba6ec1276">SetMinimumRTCPTransmissionInterval</a> (const <a class="el" href="classRTPTime.html">RTPTime</a> &amp;t)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the minimal time interval between sending RTCP packets.  <a href="#764e4ad0484d781914af79eba6ec1276"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classRTPTime.html">RTPTime</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#be22d5c9845f337a833337f2fc7a7473">GetMinimumRTCPTransmissionInterval</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the minimal time interval between sending RTCP packets (default is 5 seconds).  <a href="#be22d5c9845f337a833337f2fc7a7473"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6fdcc9976d5c7228ad493d3cd04a9bc0"></a><!-- doxytag: member="RTPSessionParams::SetUseHalfRTCPIntervalAtStartup" ref="6fdcc9976d5c7228ad493d3cd04a9bc0" args="(bool usehalf)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#6fdcc9976d5c7228ad493d3cd04a9bc0">SetUseHalfRTCPIntervalAtStartup</a> (bool usehalf)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If <code>usehalf</code> is set to <code>true</code>, the session will only wait half of the calculated RTCP interval before sending its first RTCP packet. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d64b9bcb22d8fedd4d58869952a9896d"></a><!-- doxytag: member="RTPSessionParams::GetUseHalfRTCPIntervalAtStartup" ref="d64b9bcb22d8fedd4d58869952a9896d" args="() const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#d64b9bcb22d8fedd4d58869952a9896d">GetUseHalfRTCPIntervalAtStartup</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether the session will only wait half of the calculated RTCP interval before sending its first RTCP packet or not (default is <code>true</code>). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#8161e8ce0de7d499d80869f4ff0e4e49">SetRequestImmediateBYE</a> (bool v)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If <code>v</code> is <code>true</code>, the session will send a BYE packet immediately if this is allowed.  <a href="#8161e8ce0de7d499d80869f4ff0e4e49"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#19c26901c79a63dbea5054d2d4db40e2">GetRequestImmediateBYE</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether the session should send a BYE packet immediately (if allowed) or not (default is <code>true</code>).  <a href="#19c26901c79a63dbea5054d2d4db40e2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9e9cf714c22f500f68587ffaeb816000"></a><!-- doxytag: member="RTPSessionParams::SetSenderReportForBYE" ref="9e9cf714c22f500f68587ffaeb816000" args="(bool v)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#9e9cf714c22f500f68587ffaeb816000">SetSenderReportForBYE</a> (bool v)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">When sending a BYE packet, this indicates whether it will be part of an RTCP compound packet that begins with a sender report (if allowed) or a receiver report. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b5c13d3d92c3a4700e319880cf9fb289"></a><!-- doxytag: member="RTPSessionParams::GetSenderReportForBYE" ref="b5c13d3d92c3a4700e319880cf9fb289" args="() const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#b5c13d3d92c3a4700e319880cf9fb289">GetSenderReportForBYE</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns <code>true</code> if a BYE packet will be sent in an RTCP compound packet which starts with a sender report; if a receiver report will be used, the function returns <code>false</code> (default is <code>true</code>). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#373c940ccb039dd10878cafdb603ba81">SetSenderTimeoutMultiplier</a> (double m)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the multiplier to be used when timing out senders.  <a href="#373c940ccb039dd10878cafdb603ba81"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#9ad3b05b2974aaae3049e746f7c26711">GetSenderTimeoutMultiplier</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the multiplier to be used when timing out senders (default is 2).  <a href="#9ad3b05b2974aaae3049e746f7c26711"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#b56bc31fd4d5e77e43f7d409b8b92549">SetSourceTimeoutMultiplier</a> (double m)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the multiplier to be used when timing out members.  <a href="#b56bc31fd4d5e77e43f7d409b8b92549"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#3a9bb38fa05b15640b8be464a96a2a08">GetSourceTimeoutMultiplier</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the multiplier to be used when timing out members (default is 5).  <a href="#3a9bb38fa05b15640b8be464a96a2a08"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#d96d174019cd8cb1d33f60905db3c1c1">SetBYETimeoutMultiplier</a> (double m)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the multiplier to be used when timing out a member after it has sent a BYE packet.  <a href="#d96d174019cd8cb1d33f60905db3c1c1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#3c50d39d59e003d2f9ded3d4a7e21b77">GetBYETimeoutMultiplier</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the multiplier to be used when timing out a member after it has sent a BYE packet (default is 1).  <a href="#3c50d39d59e003d2f9ded3d4a7e21b77"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#3379581ac26d384fade3a3342ba82131">SetCollisionTimeoutMultiplier</a> (double m)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the multiplier to be used when timing out entries in the collision table.  <a href="#3379581ac26d384fade3a3342ba82131"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#f5029158926c9a980f3c28afe07a77f7">GetCollisionTimeoutMultiplier</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the multiplier to be used when timing out entries in the collision table (default is 10).  <a href="#f5029158926c9a980f3c28afe07a77f7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#a7372afaef53fbf50375b6079626bccf">SetNoteTimeoutMultiplier</a> (double m)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the multiplier to be used when timing out SDES NOTE information.  <a href="#a7372afaef53fbf50375b6079626bccf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRTPSessionParams.html#3f08ab35c35086277a937ccfa407fea8">GetNoteTimeoutMultiplier</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the multiplier to be used when timing out SDES NOTE information (default is 25).  <a href="#3f08ab35c35086277a937ccfa407fea8"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Describes the parameters for to be used by an <a class="el" href="classRTPSession.html" title="High level class for using RTP.">RTPSession</a> instance. Note that the own timestamp unit must be set to a valid number, otherwise the session can't be created. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="41af1e40190425e09b198648c51f8c38"></a><!-- doxytag: member="RTPSessionParams::AcceptOwnPackets" ref="41af1e40190425e09b198648c51f8c38" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool RTPSessionParams::AcceptOwnPackets           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="3c50d39d59e003d2f9ded3d4a7e21b77"></a><!-- doxytag: member="RTPSessionParams::GetBYETimeoutMultiplier" ref="3c50d39d59e003d2f9ded3d4a7e21b77" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double RTPSessionParams::GetBYETimeoutMultiplier           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="f5029158926c9a980f3c28afe07a77f7"></a><!-- doxytag: member="RTPSessionParams::GetCollisionTimeoutMultiplier" ref="f5029158926c9a980f3c28afe07a77f7" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double RTPSessionParams::GetCollisionTimeoutMultiplier           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="0c2666007ab05e4d7e6cf913b562bfc8"></a><!-- doxytag: member="RTPSessionParams::GetControlTrafficFraction" ref="0c2666007ab05e4d7e6cf913b562bfc8" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double RTPSessionParams::GetControlTrafficFraction           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="b18dfcb648ba057a2df6010470d5ace6"></a><!-- doxytag: member="RTPSessionParams::GetMaximumPacketSize" ref="b18dfcb648ba057a2df6010470d5ace6" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t RTPSessionParams::GetMaximumPacketSize           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="be22d5c9845f337a833337f2fc7a7473"></a><!-- doxytag: member="RTPSessionParams::GetMinimumRTCPTransmissionInterval" ref="be22d5c9845f337a833337f2fc7a7473" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classRTPTime.html">RTPTime</a> RTPSessionParams::GetMinimumRTCPTransmissionInterval           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="3f08ab35c35086277a937ccfa407fea8"></a><!-- doxytag: member="RTPSessionParams::GetNoteTimeoutMultiplier" ref="3f08ab35c35086277a937ccfa407fea8" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double RTPSessionParams::GetNoteTimeoutMultiplier           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="468e1bec0777aa83284744f6a734274f"></a><!-- doxytag: member="RTPSessionParams::GetOwnTimestampUnit" ref="468e1bec0777aa83284744f6a734274f" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double RTPSessionParams::GetOwnTimestampUnit           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="e91a57ccdfb5599221e148ac6683b4c2"></a><!-- doxytag: member="RTPSessionParams::GetProbationType" ref="e91a57ccdfb5599221e148ac6683b4c2" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classRTPSources.html#c56d7cb0238003c4e803471d1889ff35">RTPSources::ProbationType</a> RTPSessionParams::GetProbationType           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="8d2dc2bde9cf65fcc8445b73ac01ca82"></a><!-- doxytag: member="RTPSessionParams::GetReceiveMode" ref="8d2dc2bde9cf65fcc8445b73ac01ca82" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classRTPTransmitter.html#bae77e9adf52db77f5ea29757dfa6386">RTPTransmitter::ReceiveMode</a> RTPSessionParams::GetReceiveMode           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="19c26901c79a63dbea5054d2d4db40e2"></a><!-- doxytag: member="RTPSessionParams::GetRequestImmediateBYE" ref="19c26901c79a63dbea5054d2d4db40e2" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool RTPSessionParams::GetRequestImmediateBYE           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="80c40900663e370b8f44743081aa47ec"></a><!-- doxytag: member="RTPSessionParams::GetSenderControlBandwidthFraction" ref="80c40900663e370b8f44743081aa47ec" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double RTPSessionParams::GetSenderControlBandwidthFraction           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="9ad3b05b2974aaae3049e746f7c26711"></a><!-- doxytag: member="RTPSessionParams::GetSenderTimeoutMultiplier" ref="9ad3b05b2974aaae3049e746f7c26711" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double RTPSessionParams::GetSenderTimeoutMultiplier           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="61965713190d0ee846a45fc63276aede"></a><!-- doxytag: member="RTPSessionParams::GetSessionBandwidth" ref="61965713190d0ee846a45fc63276aede" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double RTPSessionParams::GetSessionBandwidth           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="3a9bb38fa05b15640b8be464a96a2a08"></a><!-- doxytag: member="RTPSessionParams::GetSourceTimeoutMultiplier" ref="3a9bb38fa05b15640b8be464a96a2a08" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double RTPSessionParams::GetSourceTimeoutMultiplier           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="cebd973fdacb895d9822da5b72db5282"></a><!-- doxytag: member="RTPSessionParams::IsUsingPollThread" ref="cebd973fdacb895d9822da5b72db5282" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool RTPSessionParams::IsUsingPollThread           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="d96d174019cd8cb1d33f60905db3c1c1"></a><!-- doxytag: member="RTPSessionParams::SetBYETimeoutMultiplier" ref="d96d174019cd8cb1d33f60905db3c1c1" args="(double m)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RTPSessionParams::SetBYETimeoutMultiplier           </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>m</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="3379581ac26d384fade3a3342ba82131"></a><!-- doxytag: member="RTPSessionParams::SetCollisionTimeoutMultiplier" ref="3379581ac26d384fade3a3342ba82131" args="(double m)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RTPSessionParams::SetCollisionTimeoutMultiplier           </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>m</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="cfeff2c7f0fb34822826868ad51e841a"></a><!-- doxytag: member="RTPSessionParams::SetControlTrafficFraction" ref="cfeff2c7f0fb34822826868ad51e841a" args="(double frac)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RTPSessionParams::SetControlTrafficFraction           </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>frac</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="4a3188faeb8d8298c8b3ee66d42a4ce5"></a><!-- doxytag: member="RTPSessionParams::SetMaximumPacketSize" ref="4a3188faeb8d8298c8b3ee66d42a4ce5" args="(size_t max)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RTPSessionParams::SetMaximumPacketSize           </td>
          <td>(</td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>max</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="764e4ad0484d781914af79eba6ec1276"></a><!-- doxytag: member="RTPSessionParams::SetMinimumRTCPTransmissionInterval" ref="764e4ad0484d781914af79eba6ec1276" args="(const RTPTime &amp;t)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RTPSessionParams::SetMinimumRTCPTransmissionInterval           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classRTPTime.html">RTPTime</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>t</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="a7372afaef53fbf50375b6079626bccf"></a><!-- doxytag: member="RTPSessionParams::SetNoteTimeoutMultiplier" ref="a7372afaef53fbf50375b6079626bccf" args="(double m)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RTPSessionParams::SetNoteTimeoutMultiplier           </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>m</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="7edf8de28827890508192680a733a8a0"></a><!-- doxytag: member="RTPSessionParams::SetOwnTimestampUnit" ref="7edf8de28827890508192680a733a8a0" args="(double tsunit)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RTPSessionParams::SetOwnTimestampUnit           </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>tsunit</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Sets the timestamp unit for our own data. The timestamp unit is defined as a time interval in seconds divided by the corresponding timestamp interval. For example, for 8000 Hz audio, the timestamp unit would typically be 1/8000. Since this value is initially set to an illegal value, the user must set this to an allowed value to be able to create a session. 
</div>
</div><p>
<a class="anchor" name="39d54ea93e92cd13364d3e969b9e4d50"></a><!-- doxytag: member="RTPSessionParams::SetProbationType" ref="39d54ea93e92cd13364d3e969b9e4d50" args="(RTPSources::ProbationType probtype)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RTPSessionParams::SetProbationType           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classRTPSources.html#c56d7cb0238003c4e803471d1889ff35">RTPSources::ProbationType</a>&nbsp;</td>
          <td class="paramname"> <em>probtype</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="a71b986e27370e01313e46c5750e3133"></a><!-- doxytag: member="RTPSessionParams::SetReceiveMode" ref="a71b986e27370e01313e46c5750e3133" args="(RTPTransmitter::ReceiveMode recvmode)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RTPSessionParams::SetReceiveMode           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classRTPTransmitter.html#bae77e9adf52db77f5ea29757dfa6386">RTPTransmitter::ReceiveMode</a>&nbsp;</td>
          <td class="paramname"> <em>recvmode</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="8161e8ce0de7d499d80869f4ff0e4e49"></a><!-- doxytag: member="RTPSessionParams::SetRequestImmediateBYE" ref="8161e8ce0de7d499d80869f4ff0e4e49" args="(bool v)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RTPSessionParams::SetRequestImmediateBYE           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>v</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="7ff2bb9cb3492a60edf695d8bc9192af"></a><!-- doxytag: member="RTPSessionParams::SetResolveLocalHostname" ref="7ff2bb9cb3492a60edf695d8bc9192af" args="(bool v)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RTPSessionParams::SetResolveLocalHostname           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>v</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
If <code>v</code> is set to <code>true</code>, the session will ask the transmitter to find a host name based upon the IP addresses in its list of local IP addresses. If set to <code>false</code>, a call to <code>gethostname</code> or something similar will be used to find the local hostname. Note that the first method might take some time. 
</div>
</div><p>
<a class="anchor" name="73229616f32a7bd93210b8571d89d133"></a><!-- doxytag: member="RTPSessionParams::SetSenderControlBandwidthFraction" ref="73229616f32a7bd93210b8571d89d133" args="(double frac)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RTPSessionParams::SetSenderControlBandwidthFraction           </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>frac</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="373c940ccb039dd10878cafdb603ba81"></a><!-- doxytag: member="RTPSessionParams::SetSenderTimeoutMultiplier" ref="373c940ccb039dd10878cafdb603ba81" args="(double m)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RTPSessionParams::SetSenderTimeoutMultiplier           </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>m</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="5f0c266b6b21eea3d94ccc816193d078"></a><!-- doxytag: member="RTPSessionParams::SetSessionBandwidth" ref="5f0c266b6b21eea3d94ccc816193d078" args="(double sessbw)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RTPSessionParams::SetSessionBandwidth           </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>sessbw</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="b56bc31fd4d5e77e43f7d409b8b92549"></a><!-- doxytag: member="RTPSessionParams::SetSourceTimeoutMultiplier" ref="b56bc31fd4d5e77e43f7d409b8b92549" args="(double m)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RTPSessionParams::SetSourceTimeoutMultiplier           </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>m</em>          </td>
          <td>&nbsp;)&nbsp;</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="rtpsessionparams_8h_source.html">rtpsessionparams.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&nbsp;
<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>