|
cannam@86
|
1 <html>
|
|
cannam@86
|
2
|
|
cannam@86
|
3 <head>
|
|
cannam@86
|
4 <title>libogg - datatype - ogg_page</title>
|
|
cannam@86
|
5 <link rel=stylesheet href="style.css" type="text/css">
|
|
cannam@86
|
6 </head>
|
|
cannam@86
|
7
|
|
cannam@86
|
8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
|
|
cannam@86
|
9 <table border=0 width=100%>
|
|
cannam@86
|
10 <tr>
|
|
cannam@86
|
11 <td><p class=tiny>libogg documentation</p></td>
|
|
cannam@86
|
12 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
|
|
cannam@86
|
13 </tr>
|
|
cannam@86
|
14 </table>
|
|
cannam@86
|
15
|
|
cannam@86
|
16 <h1>ogg_page</h1>
|
|
cannam@86
|
17
|
|
cannam@86
|
18 <p><i>declared in "ogg/ogg.h"</i></p>
|
|
cannam@86
|
19
|
|
cannam@86
|
20 <p>
|
|
cannam@86
|
21 The ogg_page struct encapsulates the data for an Ogg page.
|
|
cannam@86
|
22 <p>
|
|
cannam@86
|
23 Ogg pages are the fundamental unit of framing and interleave in an ogg bitstream.
|
|
cannam@86
|
24 They are made up of packet segments of 255 bytes each. There can be as many as
|
|
cannam@86
|
25 255 packet segments per page, for a maximum page size of a little under 64 kB.
|
|
cannam@86
|
26 This is not a practical limitation as the segments can be joined across
|
|
cannam@86
|
27 page boundaries allowing packets of arbitrary size. In practice many
|
|
cannam@86
|
28 applications will not completely fill all pages because they flush the
|
|
cannam@86
|
29 accumulated packets periodically order to bound latency more tightly.
|
|
cannam@86
|
30 <p>
|
|
cannam@86
|
31 <p>For a complete description of ogg pages and headers, please refer to the <a href="../framing.html">framing document</a>.
|
|
cannam@86
|
32
|
|
cannam@86
|
33 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
|
|
cannam@86
|
34 <tr bgcolor=#cccccc>
|
|
cannam@86
|
35 <td>
|
|
cannam@86
|
36 <pre><b>
|
|
cannam@86
|
37 typedef struct {
|
|
cannam@86
|
38 unsigned char *header;
|
|
cannam@86
|
39 long header_len;
|
|
cannam@86
|
40 unsigned char *body;
|
|
cannam@86
|
41 long body_len;
|
|
cannam@86
|
42 } ogg_page;
|
|
cannam@86
|
43 </b></pre>
|
|
cannam@86
|
44 </td>
|
|
cannam@86
|
45 </tr>
|
|
cannam@86
|
46 </table>
|
|
cannam@86
|
47
|
|
cannam@86
|
48 <h3>Relevant Struct Members</h3>
|
|
cannam@86
|
49 <dl>
|
|
cannam@86
|
50 <dt><i>header</i></dt>
|
|
cannam@86
|
51 <dd>Pointer to the page header for this page. The exact contents of this header are defined in the framing spec document.</dd>
|
|
cannam@86
|
52 <dt><i>header_len</i></dt>
|
|
cannam@86
|
53 <dd>Length of the page header in bytes.</a>
|
|
cannam@86
|
54 <dt><i>body</i></dt>
|
|
cannam@86
|
55 <dd>Pointer to the data for this page.</dd>
|
|
cannam@86
|
56 <dt><i>body_len</i></dt>
|
|
cannam@86
|
57 <dd>Length of the body data in bytes.</dd>
|
|
cannam@86
|
58 </dl>
|
|
cannam@86
|
59
|
|
cannam@86
|
60
|
|
cannam@86
|
61 <br><br>
|
|
cannam@86
|
62 <hr noshade>
|
|
cannam@86
|
63 <table border=0 width=100%>
|
|
cannam@86
|
64 <tr valign=top>
|
|
cannam@86
|
65 <td><p class=tiny>copyright © 2000-2011 Xiph.Org</p></td>
|
|
cannam@86
|
66 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
|
|
cannam@86
|
67 </tr><tr>
|
|
cannam@86
|
68 <td><p class=tiny>libogg documentation</p></td>
|
|
cannam@86
|
69 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
|
|
cannam@86
|
70 </tr>
|
|
cannam@86
|
71 </table>
|
|
cannam@86
|
72
|
|
cannam@86
|
73 </body>
|
|
cannam@86
|
74
|
|
cannam@86
|
75 </html>
|
