summaryrefslogtreecommitdiff
path: root/doc/libogg/ogg_sync_pageout.html
diff options
context:
space:
mode:
authorMonty <xiphmont@xiph.org>2009-05-27 04:50:41 +0000
committerMonty <xiphmont@xiph.org>2009-05-27 04:50:41 +0000
commitaa729da057002630b75791f5fd0e2641d9e51b87 (patch)
treec068d2afeed290d4960389617b476e7e1de9d028 /doc/libogg/ogg_sync_pageout.html
parentaf61d78995f531579ffdd24fd8a5360484ab66a2 (diff)
downloadogg-aa729da057002630b75791f5fd0e2641d9e51b87.tar.gz
Commit doc updates relating to async error interface
git-svn-id: http://svn.xiph.org/trunk/ogg@16049 0101bb08-14d6-0310-b084-bc0e0c8e3800
Diffstat (limited to 'doc/libogg/ogg_sync_pageout.html')
-rw-r--r--doc/libogg/ogg_sync_pageout.html8
1 files changed, 3 insertions, 5 deletions
diff --git a/doc/libogg/ogg_sync_pageout.html b/doc/libogg/ogg_sync_pageout.html
index 26a1ab1..c42fe30 100644
--- a/doc/libogg/ogg_sync_pageout.html
+++ b/doc/libogg/ogg_sync_pageout.html
@@ -44,11 +44,9 @@ int ogg_sync_pageout(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy, <a hr
<h3>Return Values</h3>
<blockquote>
-<li>-1 if we were not properly synced and had to skip some bytes.</li>
-<li>
-0 if we need more data to verify a page.</li>
-<li>
-1 if we have a page.</li>
+<li>-1 returned if stream has not yet captured sync (bytes were skipped).</li>
+<li>0 returned if more data needed or an internal error occurred.</li>
+<li>1 indicated a page was synced and returned.</li>
</blockquote>
<p>