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