From 8f3471999e929bb99116fac52b94d572c42ba15e Mon Sep 17 00:00:00 2001 From: Aki Date: Wed, 29 Sep 2021 22:52:15 +0200 Subject: Squashed 'ogg/' content from commit 4380566a4 git-subtree-dir: ogg git-subtree-split: 4380566a44b8d5e85ad511c9c17eb04197863ec5 --- doc/libogg/ogg_sync_pageseek.html | 68 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 doc/libogg/ogg_sync_pageseek.html (limited to 'doc/libogg/ogg_sync_pageseek.html') diff --git a/doc/libogg/ogg_sync_pageseek.html b/doc/libogg/ogg_sync_pageseek.html new file mode 100644 index 0000000..b2efe89 --- /dev/null +++ b/doc/libogg/ogg_sync_pageseek.html @@ -0,0 +1,68 @@ + + + +libogg - function - ogg_sync_pageseek + + + + + + + + + +

libogg documentation

libogg release 1.3.2 - 20140527

+ +

ogg_sync_pageseek

+ +

declared in "ogg/ogg.h";

+ +

This function synchronizes the ogg_sync_state struct to the next ogg_page. +

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. + +

+ + + + +
+
+int ogg_sync_pageseek(ogg_sync_state *oy, ogg_page *og); +
+
+ +

Parameters

oy: Pointer to a previously declared ogg_sync_state struct.
og: Pointer to a page (or an incomplete page) of data. This is the page we are attempting to sync. +

+ + +

Return Values

+
-n means that we skipped n bytes within the bitstream.
+
+0 means that the page isn't ready and we need more data, or than an internal error occurred. No bytes have been skipped.
+
+n means that the page was synced at the current location, with a page length of n bytes. +

+ +

+

+ + + + + + + + +

copyright © 2000-2014 Xiph.Org	Ogg Container Format
libogg documentation	libogg release 1.3.2 - 20140527

+ + + + + -- cgit v1.1