Chris@1: Chris@1: Chris@1: Chris@1: libogg - function - ogg_page_packets Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:

libogg documentation

libogg release 1.3.0 - 20110804

Chris@1: Chris@1:

ogg_page_packets

Chris@1: Chris@1:

declared in "ogg/ogg.h";

Chris@1: Chris@1:

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

Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:

Chris@1: int ogg_page_packets(ogg_page *og);
Chris@1: 
Chris@1: 
Chris@1:
Chris@1: Chris@1:

Parameters

Chris@1:
Chris@1:
og
Chris@1:
Pointer to the current ogg_page struct.
Chris@1:
Chris@1: Chris@1: Chris@1:

Return Values

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

Chris@1: If a page happens to be a single packet that was begun on a previous page, and Chris@1: spans to the next page (in the case of a three or more page packet), the Chris@1: return will be:
Chris@1:
Chris@1: ogg_page_packets(page) will return 0,
Chris@1: ogg_page_continued(page) will return non-zero.
Chris@1:
Chris@1:

Chris@1: Chris@1:

Chris@1:


Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:

copyright © 2000-2011 Xiph.Org

Ogg Container Format

libogg documentation

libogg release 1.3.0 - 20110804

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: