cannam@86: cannam@86: cannam@86: cannam@86: libogg - function - ogg_sync_pageseek cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:

libogg documentation

libogg release 1.3.0 - 20110804

cannam@86: cannam@86:

ogg_sync_pageseek

cannam@86: cannam@86:

declared in "ogg/ogg.h";

cannam@86: cannam@86:

This function synchronizes the ogg_sync_state struct to the next ogg_page. cannam@86:

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. cannam@86: cannam@86:

cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:
cannam@86: 

cannam@86: int ogg_sync_pageseek(ogg_sync_state *oy, ogg_page *og);
cannam@86:
cannam@86:
cannam@86: cannam@86:

Parameters

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

Return Values

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

    cannam@86: cannam@86:

    cannam@86:

    cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:

    copyright © 2000-2011 Xiph.Org

    Ogg Container Format

    libogg documentation

    libogg release 1.3.0 - 20110804

    cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: