libogg-1.0/doc/ogg/ogg_sync_pageseek.html

   1 <html>
   2
   3 <head>
   4 <title>libogg - function - ogg_sync_pageseek</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 release 1.0 - 20000615</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>ogg_sync_pageseek</h1>
  17
  18 <p><i>declared in "ogg/ogg.h";</i></p>
  19
  20 <p>This function synchronizes the ogg_sync_state struct to the next ogg_page.
  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.
  22
  23 <br><br>
  24 <table border=0 color=black cellspacing=0 cellpadding=7>
  25 <tr bgcolor=#cccccc>
  26         <td>
  27 <pre><b>
  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);
  29 </b></pre>
  30         </td>
  31 </tr>
  32 </table>
  33
  34 <h3>Parameters</h3>
  35 <dl>
  36 <dt><i>oy</i></dt>
  37 <dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd>
  38 <dt><i>og</i></dt>
  39 <dd>Pointer to a page (or an incomplete page) of data.  This is the page we are attempting to sync.
  40 </dl>
  41
  42
  43 <h3>Return Values</h3>
  44 <blockquote>
  45 <li>-n means that we skipped n bytes within the bitstream.</li>
  46 <li>
  47 0 means that the page isn't ready and we need more data.  No bytes have been skipped.</li>
  48 <li>
  49 n means that the page was synced at the current location, with a page length of n bytes.
  50 </blockquote>
  51 <p>
  52
  53 <br><br>
  54 <hr noshade>
  55 <table border=0 width=100%>
  56 <tr valign=top>
  57 <td><p class=tiny>copyright &copy; 2000 xiph.org</p></td>
  58 <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>
  59 </tr><tr>
  60 <td><p class=tiny>libogg documentation</p></td>
  61 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
  62 </tr>
  63 </table>
  64
  65
  66 </body>
  67
  68 </html>