cannam@86: cannam@86: cannam@86: cannam@86: libogg - function - ogg_page_packets 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_page_packets

cannam@86: cannam@86:

declared in "ogg/ogg.h";

cannam@86: cannam@86:

Returns the number of packets that are completed on this page. If the cannam@86: leading packet is begun on a previous page, but ends on this page, it's cannam@86: counted. cannam@86:

cannam@86:

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

cannam@86: int ogg_page_packets(ogg_page *og);
cannam@86: 
cannam@86: 
cannam@86:
cannam@86: cannam@86:

Parameters

cannam@86:
cannam@86:
og
cannam@86:
Pointer to the current ogg_page struct.
cannam@86:
cannam@86: cannam@86: cannam@86:

Return Values

cannam@86:
cannam@86: If a page consists of a packet begun on a previous page, and a new packet cannam@86: begun (but not completed) on this page, the return will be:
cannam@86:
cannam@86: ogg_page_packets(page) will return 1,
cannam@86: ogg_page_continued(paged) will return non-zero.
cannam@86:

cannam@86: If a page happens to be a single packet that was begun on a previous page, and cannam@86: spans to the next page (in the case of a three or more page packet), the cannam@86: return will be:
cannam@86:
cannam@86: ogg_page_packets(page) will return 0,
cannam@86: ogg_page_continued(page) will return non-zero.
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: