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