Mercurial > hg > sv-dependency-builds
annotate src/libogg-1.3.0/doc/libogg/ogg_sync_pageseek.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_sync_pageseek</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_sync_pageseek</h1> |
| cannam@86 | 17 |
| cannam@86 | 18 <p><i>declared in "ogg/ogg.h";</i></p> |
| cannam@86 | 19 |
| cannam@86 | 20 <p>This function synchronizes the ogg_sync_state struct to the next ogg_page. |
| cannam@86 | 21 <p>This is useful when seeking within a bitstream. ogg_sync_pageseek will synchronize to the next page in the bitstream and return information about how many bytes we advanced or skipped in order to do so. |
| cannam@86 | 22 |
| cannam@86 | 23 <br><br> |
| cannam@86 | 24 <table border=0 color=black cellspacing=0 cellpadding=7> |
| cannam@86 | 25 <tr bgcolor=#cccccc> |
| cannam@86 | 26 <td> |
| cannam@86 | 27 <pre><b> |
| cannam@86 | 28 int ogg_sync_pageseek(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy, <a href="ogg_page.html">ogg_page</a> *og); |
| cannam@86 | 29 </b></pre> |
| cannam@86 | 30 </td> |
| cannam@86 | 31 </tr> |
| cannam@86 | 32 </table> |
| cannam@86 | 33 |
| cannam@86 | 34 <h3>Parameters</h3> |
| cannam@86 | 35 <dl> |
| cannam@86 | 36 <dt><i>oy</i></dt> |
| cannam@86 | 37 <dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd> |
| cannam@86 | 38 <dt><i>og</i></dt> |
| cannam@86 | 39 <dd>Pointer to a page (or an incomplete page) of data. This is the page we are attempting to sync. |
| cannam@86 | 40 </dl> |
| cannam@86 | 41 |
| cannam@86 | 42 |
| cannam@86 | 43 <h3>Return Values</h3> |
| cannam@86 | 44 <blockquote> |
| cannam@86 | 45 <li>-n means that we skipped n bytes within the bitstream.</li> |
| cannam@86 | 46 <li> |
| cannam@86 | 47 0 means that the page isn't ready and we need more data, or than an internal error occurred. No bytes have been skipped.</li> |
| cannam@86 | 48 <li> |
| cannam@86 | 49 n means that the page was synced at the current location, with a page length of n bytes. |
| cannam@86 | 50 </blockquote> |
| cannam@86 | 51 <p> |
| cannam@86 | 52 |
| cannam@86 | 53 <br><br> |
| cannam@86 | 54 <hr noshade> |
| cannam@86 | 55 <table border=0 width=100%> |
| cannam@86 | 56 <tr valign=top> |
| cannam@86 | 57 <td><p class=tiny>copyright © 2000-2011 Xiph.Org</p></td> |
| cannam@86 | 58 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td> |
| cannam@86 | 59 </tr><tr> |
| cannam@86 | 60 <td><p class=tiny>libogg documentation</p></td> |
| cannam@86 | 61 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td> |
| cannam@86 | 62 </tr> |
| cannam@86 | 63 </table> |
| cannam@86 | 64 |
| cannam@86 | 65 |
| cannam@86 | 66 </body> |
| cannam@86 | 67 |
| cannam@86 | 68 </html> |