00001 <html>
00002
00003 <head>
00004 <title>libogg - function - ogg_sync_pageseek</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 release 1.0 - 20000615</p></td>
00013 </tr>
00014 </table>
00015
00016 <h1>ogg_sync_pageseek</h1>
00017
00018 <p><i>declared in "ogg/ogg.h";</i></p>
00019
00020 <p>This function synchronizes the ogg_sync_state struct to the next ogg_page.
00021 <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.
00022
00023 <br><br>
00024 <table border=0 color=black cellspacing=0 cellpadding=7>
00025 <tr bgcolor=#cccccc>
00026 <td>
00027 <pre><b>
00028 int ogg_sync_pageseek(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy, <a href="ogg_page.html">ogg_page</a> *og);
00029 </b></pre>
00030 </td>
00031 </tr>
00032 </table>
00033
00034 <h3>Parameters</h3>
00035 <dl>
00036 <dt><i>oy</i></dt>
00037 <dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd>
00038 <dt><i>og</i></dt>
00039 <dd>Pointer to a page (or an incomplete page) of data. This is the page we are attempting to sync.
00040 </dl>
00041
00042
00043 <h3>Return Values</h3>
00044 <blockquote>
00045 <li>-n means that we skipped n bytes within the bitstream.</li>
00046 <li>
00047 0 means that the page isn't ready and we need more data. No bytes have been skipped.</li>
00048 <li>
00049 n means that the page was synced at the current location, with a page length of n bytes.
00050 </blockquote>
00051 <p>
00052
00053 <br><br>
00054 <hr noshade>
00055 <table border=0 width=100%>
00056 <tr valign=top>
00057 <td><p class=tiny>copyright © 2000 xiph.org</p></td>
00058 <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>
00059 </tr><tr>
00060 <td><p class=tiny>libogg documentation</p></td>
00061 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00062 </tr>
00063 </table>
00064
00065
00066 </body>
00067
00068 </html>
