Chris@1
|
1 <html>
|
Chris@1
|
2
|
Chris@1
|
3 <head>
|
Chris@1
|
4 <title>libogg - function - ogg_sync_pageseek</title>
|
Chris@1
|
5 <link rel=stylesheet href="style.css" type="text/css">
|
Chris@1
|
6 </head>
|
Chris@1
|
7
|
Chris@1
|
8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
|
Chris@1
|
9 <table border=0 width=100%>
|
Chris@1
|
10 <tr>
|
Chris@1
|
11 <td><p class=tiny>libogg documentation</p></td>
|
Chris@1
|
12 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
|
Chris@1
|
13 </tr>
|
Chris@1
|
14 </table>
|
Chris@1
|
15
|
Chris@1
|
16 <h1>ogg_sync_pageseek</h1>
|
Chris@1
|
17
|
Chris@1
|
18 <p><i>declared in "ogg/ogg.h";</i></p>
|
Chris@1
|
19
|
Chris@1
|
20 <p>This function synchronizes the ogg_sync_state struct to the next ogg_page.
|
Chris@1
|
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.
|
Chris@1
|
22
|
Chris@1
|
23 <br><br>
|
Chris@1
|
24 <table border=0 color=black cellspacing=0 cellpadding=7>
|
Chris@1
|
25 <tr bgcolor=#cccccc>
|
Chris@1
|
26 <td>
|
Chris@1
|
27 <pre><b>
|
Chris@1
|
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);
|
Chris@1
|
29 </b></pre>
|
Chris@1
|
30 </td>
|
Chris@1
|
31 </tr>
|
Chris@1
|
32 </table>
|
Chris@1
|
33
|
Chris@1
|
34 <h3>Parameters</h3>
|
Chris@1
|
35 <dl>
|
Chris@1
|
36 <dt><i>oy</i></dt>
|
Chris@1
|
37 <dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd>
|
Chris@1
|
38 <dt><i>og</i></dt>
|
Chris@1
|
39 <dd>Pointer to a page (or an incomplete page) of data. This is the page we are attempting to sync.
|
Chris@1
|
40 </dl>
|
Chris@1
|
41
|
Chris@1
|
42
|
Chris@1
|
43 <h3>Return Values</h3>
|
Chris@1
|
44 <blockquote>
|
Chris@1
|
45 <li>-n means that we skipped n bytes within the bitstream.</li>
|
Chris@1
|
46 <li>
|
Chris@1
|
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>
|
Chris@1
|
48 <li>
|
Chris@1
|
49 n means that the page was synced at the current location, with a page length of n bytes.
|
Chris@1
|
50 </blockquote>
|
Chris@1
|
51 <p>
|
Chris@1
|
52
|
Chris@1
|
53 <br><br>
|
Chris@1
|
54 <hr noshade>
|
Chris@1
|
55 <table border=0 width=100%>
|
Chris@1
|
56 <tr valign=top>
|
Chris@1
|
57 <td><p class=tiny>copyright © 2000-2011 Xiph.Org</p></td>
|
Chris@1
|
58 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
|
Chris@1
|
59 </tr><tr>
|
Chris@1
|
60 <td><p class=tiny>libogg documentation</p></td>
|
Chris@1
|
61 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
|
Chris@1
|
62 </tr>
|
Chris@1
|
63 </table>
|
Chris@1
|
64
|
Chris@1
|
65
|
Chris@1
|
66 </body>
|
Chris@1
|
67
|
Chris@1
|
68 </html>
|