4
<title>libogg - function - ogg_sync_pageseek</title>
5
<link rel=stylesheet href="style.css" type="text/css">
8
<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
9
<table border=0 width=100%>
11
<td><p class=tiny>libogg documentation</p></td>
12
<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
16
<h1>ogg_sync_pageseek</h1>
18
<p><i>declared in "ogg/ogg.h";</i></p>
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.
24
<table border=0 color=black cellspacing=0 cellpadding=7>
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);
37
<dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd>
39
<dd>Pointer to a page (or an incomplete page) of data. This is the page we are attempting to sync.
43
<h3>Return Values</h3>
45
<li>-n means that we skipped n bytes within the bitstream.</li>
47
0 means that the page isn't ready and we need more data. No bytes have been skipped.</li>
49
n means that the page was synced at the current location, with a page length of n bytes.
55
<table border=0 width=100%>
57
<td><p class=tiny>copyright © 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>
60
<td><p class=tiny>libogg documentation</p></td>
61
<td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
added
removed
doc/libogg/ogg_sync_pageseek.html
