libogg documentation

libogg - 200011015

ogg_page

declared in "ogg/ogg.h"

The ogg_page struct encapsulates the data for an Ogg page.

Ogg pages are the fundamental unit of framing and interleave in an ogg bitstream. They are made up of packet segments of 255 bytes each. There can be as many as 255 packet segments per page, for a maximum page size of a little under 64 kB. This is not a practical limitation as the segments can be joined across page boundaries allowing packets of arbitrary size. In practice pages are usually around 4 kB.

For a complete description of ogg pages and headers, please refer to the framing document.

typedef struct {
  unsigned char *header;
  long           header_len;
  unsigned char *body;
  long           body_len;
} ogg_page;

Relevant Struct Members

header
Pointer to the page header for this page. The exact contents of this header are defined in the framing spec document.
header_len
Length of the page header in bytes.
body
Pointer to the data for this page.
body_len
Length of the body data in bytes.



copyright © 2001 xiph.org foundation

Ogg Vorbis
team@xiph.org

libogg documentation

libogg version - 20011015