<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>ccRTP: PayloadFormat Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ccRTP
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 id="navrow2" class="tabs2">
<ul class="tablist">
<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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-static-attribs">Static Protected Attributes</a> |
<a href="class_payload_format-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PayloadFormat Class Reference<div class="ingroups"><a class="el" href="group__payload.html">Payload types and formats.</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Base payload format class.
<a href="class_payload_format.html#details">More...</a></p>
<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="dyncontent">
<div class="center">
<img src="class_payload_format.png" usemap="#PayloadFormat_map" alt=""/>
<map id="PayloadFormat_map" name="PayloadFormat_map">
<area href="class_dynamic_payload_format.html" title="Dynamic payload format objects. " alt="DynamicPayloadFormat" shape="rect" coords="0,56,146,80"/>
<area href="class_static_payload_format.html" title="Static payload format objects. " alt="StaticPayloadFormat" shape="rect" coords="156,56,302,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac0892cc249dc5e92a80c7aa08dd3a606"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__payload.html#ga0eee230c7ab57e31bb4e438a72354993">PayloadType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_payload_format.html#ac0892cc249dc5e92a80c7aa08dd3a606">getPayloadType</a> () const </td></tr>
<tr class="memdesc:ac0892cc249dc5e92a80c7aa08dd3a606"><td class="mdescLeft"> </td><td class="mdescRight">Get payload type numeric identifier carried in RTP packets. <a href="#ac0892cc249dc5e92a80c7aa08dd3a606">More...</a><br /></td></tr>
<tr class="separator:ac0892cc249dc5e92a80c7aa08dd3a606"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4eee0cbd76e62e6f8b2bd946bcac8c69"><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_payload_format.html#a4eee0cbd76e62e6f8b2bd946bcac8c69">getRTPClockRate</a> () const </td></tr>
<tr class="memdesc:a4eee0cbd76e62e6f8b2bd946bcac8c69"><td class="mdescLeft"> </td><td class="mdescRight">Get RTP clock rate for this payload format. <a href="#a4eee0cbd76e62e6f8b2bd946bcac8c69">More...</a><br /></td></tr>
<tr class="separator:a4eee0cbd76e62e6f8b2bd946bcac8c69"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a5d636a742cdbca37dccfb95e13e295f1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_payload_format.html#a5d636a742cdbca37dccfb95e13e295f1">PayloadFormat</a> ()</td></tr>
<tr class="memdesc:a5d636a742cdbca37dccfb95e13e295f1"><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="#a5d636a742cdbca37dccfb95e13e295f1">More...</a><br /></td></tr>
<tr class="separator:a5d636a742cdbca37dccfb95e13e295f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab9df45a15af6e2096811ca138f91015d"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_payload_format.html#ab9df45a15af6e2096811ca138f91015d">~PayloadFormat</a> ()</td></tr>
<tr class="memdesc:ab9df45a15af6e2096811ca138f91015d"><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="#ab9df45a15af6e2096811ca138f91015d">More...</a><br /></td></tr>
<tr class="separator:ab9df45a15af6e2096811ca138f91015d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada0482147ab69f8a721889092d2107ab"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_payload_format.html#ada0482147ab69f8a721889092d2107ab">setPayloadType</a> (<a class="el" href="group__payload.html#ga0eee230c7ab57e31bb4e438a72354993">PayloadType</a> pt)</td></tr>
<tr class="memdesc:ada0482147ab69f8a721889092d2107ab"><td class="mdescLeft"> </td><td class="mdescRight">Set payload type numeric identifier carried in RTP packets. <a href="#ada0482147ab69f8a721889092d2107ab">More...</a><br /></td></tr>
<tr class="separator:ada0482147ab69f8a721889092d2107ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0cb0dbdd14ac16695db98794f26777b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_payload_format.html#af0cb0dbdd14ac16695db98794f26777b">setRTPClockRate</a> (uint32 rate)</td></tr>
<tr class="memdesc:af0cb0dbdd14ac16695db98794f26777b"><td class="mdescLeft"> </td><td class="mdescRight">Set RTP clock rate. <a href="#af0cb0dbdd14ac16695db98794f26777b">More...</a><br /></td></tr>
<tr class="separator:af0cb0dbdd14ac16695db98794f26777b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr class="memitem:abaad952cbb33303a8b86fc6c90857e61"><td class="memItemLeft" align="right" valign="top">static const uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_payload_format.html#abaad952cbb33303a8b86fc6c90857e61">defaultRTPClockRate</a></td></tr>
<tr class="separator:abaad952cbb33303a8b86fc6c90857e61"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base payload format class. </p>
<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>
<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="section author"><dt>Author</dt><dd>Federico Montesino Pouzols <a href="#" onclick="location.href='mai'+'lto:'+'fed'+'em'+'p@a'+'lt'+'ern'+'.o'+'rg'; return false;">fedem<span style="display: none;">.nosp@m.</span>p@al<span style="display: none;">.nosp@m.</span>tern.<span style="display: none;">.nosp@m.</span>org</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5d636a742cdbca37dccfb95e13e295f1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">PayloadFormat::PayloadFormat </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </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>
<a class="anchor" id="ab9df45a15af6e2096811ca138f91015d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual PayloadFormat::~PayloadFormat </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </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>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac0892cc249dc5e92a80c7aa08dd3a606"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__payload.html#ga0eee230c7ab57e31bb4e438a72354993">PayloadType</a> PayloadFormat::getPayloadType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get payload type numeric identifier carried in RTP packets. </p>
<dl class="section return"><dt>Returns</dt><dd>payload type numeric identifier. </dd></dl>
</div>
</div>
<a class="anchor" id="a4eee0cbd76e62e6f8b2bd946bcac8c69"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint32 PayloadFormat::getRTPClockRate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get RTP clock rate for this payload format. </p>
<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="section return"><dt>Returns</dt><dd>RTP clock rate in Hz. </dd></dl>
</div>
</div>
<a class="anchor" id="ada0482147ab69f8a721889092d2107ab"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void PayloadFormat::setPayloadType </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__payload.html#ga0eee230c7ab57e31bb4e438a72354993">PayloadType</a> </td>
<td class="paramname"><em>pt</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set payload type numeric identifier carried in RTP packets. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pt</td><td>payload type number. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af0cb0dbdd14ac16695db98794f26777b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set RTP clock rate. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rate</td><td>RTP clock rate in Hz. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="abaad952cbb33303a8b86fc6c90857e61"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const uint32 PayloadFormat::defaultRTPClockRate</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<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></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Feb 8 2015 08:32:24 for ccRTP by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
a2fa4fed774700990ee58705b206cf50
>
files
>
94
