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