annotate src/libogg-1.3.0/doc/libogg/ogg_page_packets.html @ 83:ae30d91d2ffe

Replace these with versions built using an older toolset (so as to avoid ABI compatibilities when linking on Ubuntu 14.04 for packaging purposes)
author Chris Cannam
date Fri, 07 Feb 2020 11:51:13 +0000
parents 05aa0afa9217
children
rev   line source
Chris@1 1 <html>
Chris@1 2
Chris@1 3 <head>
Chris@1 4 <title>libogg - function - ogg_page_packets</title>
Chris@1 5 <link rel=stylesheet href="style.css" type="text/css">
Chris@1 6 </head>
Chris@1 7
Chris@1 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
Chris@1 9 <table border=0 width=100%>
Chris@1 10 <tr>
Chris@1 11 <td><p class=tiny>libogg documentation</p></td>
Chris@1 12 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
Chris@1 13 </tr>
Chris@1 14 </table>
Chris@1 15
Chris@1 16 <h1>ogg_page_packets</h1>
Chris@1 17
Chris@1 18 <p><i>declared in "ogg/ogg.h";</i></p>
Chris@1 19
Chris@1 20 <p>Returns the number of packets that are completed on this page. If the
Chris@1 21 leading packet is begun on a previous page, but ends on this page, it's
Chris@1 22 counted.
Chris@1 23 <p>
Chris@1 24 <br><br>
Chris@1 25 <table border=0 color=black cellspacing=0 cellpadding=7>
Chris@1 26 <tr bgcolor=#cccccc>
Chris@1 27 <td>
Chris@1 28 <pre><b>
Chris@1 29 int ogg_page_packets(ogg_page *og);
Chris@1 30
Chris@1 31 </b></pre>
Chris@1 32 </td>
Chris@1 33 </tr>
Chris@1 34 </table>
Chris@1 35
Chris@1 36 <h3>Parameters</h3>
Chris@1 37 <dl>
Chris@1 38 <dt><i>og</i></dt>
Chris@1 39 <dd>Pointer to the current ogg_page struct.</dd>
Chris@1 40 </dl>
Chris@1 41
Chris@1 42
Chris@1 43 <h3>Return Values</h3>
Chris@1 44 <blockquote>
Chris@1 45 If a page consists of a packet begun on a previous page, and a new packet
Chris@1 46 begun (but not completed) on this page, the return will be:<br>
Chris@1 47 <br>
Chris@1 48 ogg_page_packets(page) will return 1,<br>
Chris@1 49 ogg_page_continued(paged) will return non-zero.<br>
Chris@1 50 <br><br>
Chris@1 51 If a page happens to be a single packet that was begun on a previous page, and
Chris@1 52 spans to the next page (in the case of a three or more page packet), the
Chris@1 53 return will be:<br>
Chris@1 54 <br>
Chris@1 55 ogg_page_packets(page) will return 0,<br>
Chris@1 56 ogg_page_continued(page) will return non-zero.<br>
Chris@1 57 </blockquote>
Chris@1 58 <p>
Chris@1 59
Chris@1 60 <br><br>
Chris@1 61 <hr noshade>
Chris@1 62 <table border=0 width=100%>
Chris@1 63 <tr valign=top>
Chris@1 64 <td><p class=tiny>copyright &copy; 2000-2011 Xiph.Org</p></td>
Chris@1 65 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
Chris@1 66 </tr><tr>
Chris@1 67 <td><p class=tiny>libogg documentation</p></td>
Chris@1 68 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
Chris@1 69 </tr>
Chris@1 70 </table>
Chris@1 71
Chris@1 72
Chris@1 73 </body>
Chris@1 74
Chris@1 75 </html>