00001 <html>
00002
00003 <head>
00004 <title>libogg - function - ogg_page_packets</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>libogg documentation</p></td>
00012 <td align=right><p class=tiny>libogg - 20011218</p></td>
00013 </tr>
00014 </table>
00015
00016 <h1>ogg_page_packets</h1>
00017
00018 <p><i>declared in "ogg/ogg.h";</i></p>
00019
00020 <p>Returns the number of packets that are completed on this page. If the
00021 leading packet is begun on a previous page, but ends on this page, it's
00022 counted.
00023 <p>
00024 <br><br>
00025 <table border=0 color=black cellspacing=0 cellpadding=7>
00026 <tr bgcolor=#cccccc>
00027 <td>
00028 <pre><b>
00029 int ogg_page_packets(ogg_page *og);
00030
00031 </b></pre>
00032 </td>
00033 </tr>
00034 </table>
00035
00036 <h3>Parameters</h3>
00037 <dl>
00038 <dt><i>og</i></dt>
00039 <dd>Pointer to the current ogg_page struct.</dd>
00040 </dl>
00041
00042
00043 <h3>Return Values</h3>
00044 <blockquote>
00045 If a page consists of a packet begun on a previous page, and a new packet
00046 begun (but not completed) on this page, the return will be:<br>
00047 <br>
00048 ogg_page_packets(page) will return 1,<br>
00049 ogg_page_continued(paged) will return non-zero.<br>
00050 <br><br>
00051 If a page happens to be a single packet that was begun on a previous page, and
00052 spans to the next page (in the case of a three or more page packet), the
00053 return will be:<br>
00054 <br>
00055 ogg_page_packets(page) will return 0,<br>
00056 ogg_page_continued(page) will return non-zero.<br>
00057 </blockquote>
00058 <p>
00059
00060 <br><br>
00061 <hr noshade>
00062 <table border=0 width=100%>
00063 <tr valign=top>
00064 <td><p class=tiny>copyright © 2001 xiph.org</p></td>
00065 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td>
00066 </tr><tr>
00067 <td><p class=tiny>libogg documentation</p></td>
00068 <td align=right><p class=tiny>libogg - 20011218</p></td>
00069 </tr>
00070 </table>
00071
00072
00073 </body>
00074
00075 </html>
