<!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: RTCPCompoundPacket 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>RTCPCompoundPacket Class Reference</h1><!-- doxytag: class="RTCPCompoundPacket" --><!-- doxytag: inherits="RTPMemoryObject" -->Represents an RTCP compound packet.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="rtcpcompoundpacket_8h_source.html">rtcpcompoundpacket.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for RTCPCompoundPacket:</div>
<div class="dynsection">
<p><center><img src="classRTCPCompoundPacket__inherit__graph.png" border="0" usemap="#RTCPCompoundPacket__inherit__map" alt="Inheritance graph"></center>
<map name="RTCPCompoundPacket__inherit__map">
<area shape="rect" href="classRTCPCompoundPacketBuilder.html" title="This class can be used to construct an RTCP compound packet." alt="" coords="5,84,208,111"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classRTCPCompoundPacket-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="classRTCPCompoundPacket.html#138b4834a02e93c64cf75d035140125c">RTCPCompoundPacket</a> (<a class="el" href="classRTPRawPacket.html">RTPRawPacket</a> &rawpack, <a class="el" href="classRTPMemoryManager.html">RTPMemoryManager</a> *memmgr=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="classRTCPCompoundPacket.html" title="Represents an RTCP compound packet.">RTCPCompoundPacket</a> instance from the data in <code>rawpack</code>, installing a memory manager if specified. <a href="#138b4834a02e93c64cf75d035140125c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPCompoundPacket.html#52cc8773431c1e60752f1ea435a2c56d">RTCPCompoundPacket</a> (uint8_t *packet, size_t len, bool deletedata=true, <a class="el" href="classRTPMemoryManager.html">RTPMemoryManager</a> *memmgr=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="classRTCPCompoundPacket.html" title="Represents an RTCP compound packet.">RTCPCompoundPacket</a> instance from the data in <code>packet}</code>, with size <code>len</code>. <a href="#52cc8773431c1e60752f1ea435a2c56d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPCompoundPacket.html#a77c69ac4c16fd4b439fdf77918cf90c">GetCreationError</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks if the RTCP compound packet was created successfully. <a href="#a77c69ac4c16fd4b439fdf77918cf90c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPCompoundPacket.html#435a7af9ce14aa0567adf6405ad6bd82">GetCompoundPacketData</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the data of the entire RTCP compound packet. <a href="#435a7af9ce14aa0567adf6405ad6bd82"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPCompoundPacket.html#942899855cd7b37f496a0792d35fe7f6">GetCompoundPacketLength</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of the entire RTCP compound packet. <a href="#942899855cd7b37f496a0792d35fe7f6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPCompoundPacket.html#83d814fb463e2208ad74074f479881ce">GotoFirstPacket</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts the iteration over the individual RTCP packets in the RTCP compound packet. <a href="#83d814fb463e2208ad74074f479881ce"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classRTCPPacket.html">RTCPPacket</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRTCPCompoundPacket.html#b5887a95d3c9249809e4fb9a35c29e59">GetNextPacket</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the next individual RTCP packet. <a href="#b5887a95d3c9249809e4fb9a35c29e59"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="138b4834a02e93c64cf75d035140125c"></a><!-- doxytag: member="RTCPCompoundPacket::RTCPCompoundPacket" ref="138b4834a02e93c64cf75d035140125c" args="(RTPRawPacket &rawpack, RTPMemoryManager *memmgr=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RTCPCompoundPacket::RTCPCompoundPacket </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classRTPRawPacket.html">RTPRawPacket</a> & </td>
<td class="paramname"> <em>rawpack</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classRTPMemoryManager.html">RTPMemoryManager</a> * </td>
<td class="paramname"> <em>memmgr</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>
</div>
</div><p>
<a class="anchor" name="52cc8773431c1e60752f1ea435a2c56d"></a><!-- doxytag: member="RTCPCompoundPacket::RTCPCompoundPacket" ref="52cc8773431c1e60752f1ea435a2c56d" args="(uint8_t *packet, size_t len, bool deletedata=true, RTPMemoryManager *memmgr=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RTCPCompoundPacket::RTCPCompoundPacket </td>
<td>(</td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"> <em>packet</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>deletedata</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classRTPMemoryManager.html">RTPMemoryManager</a> * </td>
<td class="paramname"> <em>memmgr</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>
Creates an <a class="el" href="classRTCPCompoundPacket.html" title="Represents an RTCP compound packet.">RTCPCompoundPacket</a> instance from the data in <code>packet}</code>, with size <code>len</code>. The <code>deletedata</code> flag specifies if the data in <code>packet</code> should be deleted when the compound packet is destroyed. If specified, a memory manager will be installed.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="435a7af9ce14aa0567adf6405ad6bd82"></a><!-- doxytag: member="RTCPCompoundPacket::GetCompoundPacketData" ref="435a7af9ce14aa0567adf6405ad6bd82" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* RTCPCompoundPacket::GetCompoundPacketData </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="942899855cd7b37f496a0792d35fe7f6"></a><!-- doxytag: member="RTCPCompoundPacket::GetCompoundPacketLength" ref="942899855cd7b37f496a0792d35fe7f6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t RTCPCompoundPacket::GetCompoundPacketLength </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="a77c69ac4c16fd4b439fdf77918cf90c"></a><!-- doxytag: member="RTCPCompoundPacket::GetCreationError" ref="a77c69ac4c16fd4b439fdf77918cf90c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RTCPCompoundPacket::GetCreationError </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If the raw packet data in the constructor could not be parsed, this function returns the error code of what went wrong. If the packet had an invalid format, the return value is <code>ERR_RTP_RTCPCOMPOUND_INVALIDPACKET</code>.
</div>
</div><p>
<a class="anchor" name="b5887a95d3c9249809e4fb9a35c29e59"></a><!-- doxytag: member="RTCPCompoundPacket::GetNextPacket" ref="b5887a95d3c9249809e4fb9a35c29e59" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRTCPPacket.html">RTCPPacket</a>* RTCPCompoundPacket::GetNextPacket </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a pointer to the next individual RTCP packet. Note that no <code>delete</code> call may be done on the <a class="el" href="classRTCPPacket.html" title="Base class for specific types of RTCP packets.">RTCPPacket</a> instance which is returned.
</div>
</div><p>
<a class="anchor" name="83d814fb463e2208ad74074f479881ce"></a><!-- doxytag: member="RTCPCompoundPacket::GotoFirstPacket" ref="83d814fb463e2208ad74074f479881ce" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RTCPCompoundPacket::GotoFirstPacket </td>
<td>(</td>
<td class="paramname"> </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="rtcpcompoundpacket_8h_source.html">rtcpcompoundpacket.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jul 26 09:42:13 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>
