00001 <html>
00002
00003 <head>
00004 <title>libogg - datatype - ogg_page</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>libogg documentation</p></td>
00012 <td align=right><p class=tiny>libogg - 200011015</p></td>
00013 </tr>
00014 </table>
00015
00016 <h1>ogg_page</h1>
00017
00018 <p><i>declared in "ogg/ogg.h"</i></p>
00019
00020 <p>
00021 The ogg_page struct encapsulates the data for an Ogg page.
00022 <p>
00023 Ogg pages are the fundamental unit of framing and interleave in an ogg bitstream.
00024 They are made up of packet segments of 255 bytes each. There can be as many as
00025 255 packet segments per page, for a maximum page size of a little under 64 kB.
00026 This is not a practical limitation as the segments can be joined across
00027 page boundaries allowing packets of arbitrary size. In practice pages are
00028 usually around 4 kB.
00029 <p>
00030 <p>For a complete description of ogg pages and headers, please refer to the <a href="../framing.html">framing document</a>.
00031
00032 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
00033 <tr bgcolor=#cccccc>
00034 <td>
00035 <pre><b>
00036 typedef struct {
00037 unsigned char *header;
00038 long header_len;
00039 unsigned char *body;
00040 long body_len;
00041 } ogg_page;
00042 </b></pre>
00043 </td>
00044 </tr>
00045 </table>
00046
00047 <h3>Relevant Struct Members</h3>
00048 <dl>
00049 <dt><i>header</i></dt>
00050 <dd>Pointer to the page header for this page. The exact contents of this header are defined in the framing spec document.</dd>
00051 <dt><i>header_len</i></dt>
00052 <dd>Length of the page header in bytes.</a>
00053 <dt><i>body</i></dt>
00054 <dd>Pointer to the data for this page.</dd>
00055 <dt><i>body_len</i></dt>
00056 <dd>Length of the body data in bytes.</dd>
00057 </dl>
00058
00059
00060 <br><br>
00061 <hr noshade>
00062 <table border=0 width=100%>
00063 <tr valign=top>
00064 <td><p class=tiny>copyright © 2001 xiph.org foundation</p></td>
00065 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td>
00066 </tr><tr>
00067 <td><p class=tiny>libogg documentation</p></td>
00068 <td align=right><p class=tiny>libogg version - 20011015</p></td>
00069 </tr>
00070 </table>
00071
00072 </body>
00073
00074 </html>
