<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ccRTP: PayloadFormat Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.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><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 class="tabs">
<ul>
<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>
<div class="contents">
<h1>PayloadFormat Class Reference<br>
<small>
[<a class="el" href="group__payload.html">Payload types and formats.</a>]</small>
</h1><!-- doxytag: class="PayloadFormat" -->Base payload format class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="formats_8h_source.html">formats.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for PayloadFormat:</div>
<div class="dynsection">
<p><center><img src="class_payload_format.png" usemap="#PayloadFormat_map" border="0" alt=""></center>
<map name="PayloadFormat_map">
<area href="class_dynamic_payload_format.html" alt="DynamicPayloadFormat" shape="rect" coords="0,56,146,80">
<area href="class_static_payload_format.html" alt="StaticPayloadFormat" shape="rect" coords="156,56,302,80">
</map>
</div>
<p>
<a href="class_payload_format-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="el" href="group__payload.html#g0eee230c7ab57e31bb4e438a72354993">PayloadType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_payload_format.html#c0892cc249dc5e92a80c7aa08dd3a606">getPayloadType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get payload type numeric identifier carried in RTP packets. <a href="#c0892cc249dc5e92a80c7aa08dd3a606"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_payload_format.html#4eee0cbd76e62e6f8b2bd946bcac8c69">getRTPClockRate</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get RTP clock rate for this payload format. <a href="#4eee0cbd76e62e6f8b2bd946bcac8c69"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_payload_format.html#5d636a742cdbca37dccfb95e13e295f1">PayloadFormat</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_payload_format.html" title="Base payload format class.">PayloadFormat</a> must not be used but as base class. <a href="#5d636a742cdbca37dccfb95e13e295f1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_payload_format.html#b9df45a15af6e2096811ca138f91015d">~PayloadFormat</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_payload_format.html" title="Base payload format class.">PayloadFormat</a> must not be used but as base class. <a href="#b9df45a15af6e2096811ca138f91015d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_payload_format.html#da0482147ab69f8a721889092d2107ab">setPayloadType</a> (<a class="el" href="group__payload.html#g0eee230c7ab57e31bb4e438a72354993">PayloadType</a> pt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set payload type numeric identifier carried in RTP packets. <a href="#da0482147ab69f8a721889092d2107ab"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_payload_format.html#f0cb0dbdd14ac16695db98794f26777b">setRTPClockRate</a> (uint32 rate)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set RTP clock rate. <a href="#f0cb0dbdd14ac16695db98794f26777b"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_payload_format.html#baad952cbb33303a8b86fc6c90857e61">defaultRTPClockRate</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Base payload format class.
<p>
The properties of a payload format that, as an RTP stack, ccRTP takes into account are the payload type (numeric identifier) and the RTP clock rate.<p>
This is a base class for both <a class="el" href="class_static_payload_format.html" title="Static payload format objects.">StaticPayloadFormat</a> and <a class="el" href="class_dynamic_payload_format.html" title="Dynamic payload format objects.">DynamicPayloadFormat</a>.<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd>Federico Montesino Pouzols <<a href="mailto:fedemp@altern.org">fedemp@altern.org</a>> </dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="5d636a742cdbca37dccfb95e13e295f1"></a><!-- doxytag: member="PayloadFormat::PayloadFormat" ref="5d636a742cdbca37dccfb95e13e295f1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PayloadFormat::PayloadFormat </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="class_payload_format.html" title="Base payload format class.">PayloadFormat</a> must not be used but as base class.
<p>
</div>
</div><p>
<a class="anchor" name="b9df45a15af6e2096811ca138f91015d"></a><!-- doxytag: member="PayloadFormat::~PayloadFormat" ref="b9df45a15af6e2096811ca138f91015d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PayloadFormat::~PayloadFormat </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="class_payload_format.html" title="Base payload format class.">PayloadFormat</a> must not be used but as base class.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c0892cc249dc5e92a80c7aa08dd3a606"></a><!-- doxytag: member="PayloadFormat::getPayloadType" ref="c0892cc249dc5e92a80c7aa08dd3a606" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__payload.html#g0eee230c7ab57e31bb4e438a72354993">PayloadType</a> PayloadFormat::getPayloadType </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get payload type numeric identifier carried in RTP packets.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>payload type numeric identifier. </dd></dl>
</div>
</div><p>
<a class="anchor" name="4eee0cbd76e62e6f8b2bd946bcac8c69"></a><!-- doxytag: member="PayloadFormat::getRTPClockRate" ref="4eee0cbd76e62e6f8b2bd946bcac8c69" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32 PayloadFormat::getRTPClockRate </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get RTP clock rate for this payload format.
<p>
Note this method provides the RTP clock rate (for the timestamp in RTP data packets headers), which is not necessarily the same as the codec clock rate.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>RTP clock rate in Hz. </dd></dl>
</div>
</div><p>
<a class="anchor" name="da0482147ab69f8a721889092d2107ab"></a><!-- doxytag: member="PayloadFormat::setPayloadType" ref="da0482147ab69f8a721889092d2107ab" args="(PayloadType pt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PayloadFormat::setPayloadType </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__payload.html#g0eee230c7ab57e31bb4e438a72354993">PayloadType</a> </td>
<td class="paramname"> <em>pt</em> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set payload type numeric identifier carried in RTP packets.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pt</em> </td><td>payload type number. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="f0cb0dbdd14ac16695db98794f26777b"></a><!-- doxytag: member="PayloadFormat::setRTPClockRate" ref="f0cb0dbdd14ac16695db98794f26777b" args="(uint32 rate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PayloadFormat::setRTPClockRate </td>
<td>(</td>
<td class="paramtype">uint32 </td>
<td class="paramname"> <em>rate</em> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set RTP clock rate.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rate</em> </td><td>RTP clock rate in Hz. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="baad952cbb33303a8b86fc6c90857e61"></a><!-- doxytag: member="PayloadFormat::defaultRTPClockRate" ref="baad952cbb33303a8b86fc6c90857e61" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint32 <a class="el" href="class_payload_format.html#baad952cbb33303a8b86fc6c90857e61">PayloadFormat::defaultRTPClockRate</a><code> [static, protected]</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><a class="el" href="formats_8h_source.html">formats.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jul 24 21:42:25 2009 for ccRTP 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>
