| 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 release 1.3.5 - 20210603</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 many
|
|---|
| 28 | applications will not completely fill all pages because they flush the
|
|---|
| 29 | accumulated packets periodically order to bound latency more tightly.
|
|---|
| 30 | <p>
|
|---|
| 31 | <p>For a complete description of ogg pages and headers, please refer to the <a href="../framing.html">framing document</a>.
|
|---|
| 32 |
|
|---|
| 33 | <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
|
|---|
| 34 | <tr bgcolor=#cccccc>
|
|---|
| 35 | <td>
|
|---|
| 36 | <pre><b>
|
|---|
| 37 | typedef struct {
|
|---|
| 38 | unsigned char *header;
|
|---|
| 39 | long header_len;
|
|---|
| 40 | unsigned char *body;
|
|---|
| 41 | long body_len;
|
|---|
| 42 | } ogg_page;
|
|---|
| 43 | </b></pre>
|
|---|
| 44 | </td>
|
|---|
| 45 | </tr>
|
|---|
| 46 | </table>
|
|---|
| 47 |
|
|---|
| 48 | <h3>Relevant Struct Members</h3>
|
|---|
| 49 | <dl>
|
|---|
| 50 | <dt><i>header</i></dt>
|
|---|
| 51 | <dd>Pointer to the page header for this page. The exact contents of this header are defined in the framing spec document.</dd>
|
|---|
| 52 | <dt><i>header_len</i></dt>
|
|---|
| 53 | <dd>Length of the page header in bytes.</a>
|
|---|
| 54 | <dt><i>body</i></dt>
|
|---|
| 55 | <dd>Pointer to the data for this page.</dd>
|
|---|
| 56 | <dt><i>body_len</i></dt>
|
|---|
| 57 | <dd>Length of the body data in bytes.</dd>
|
|---|
| 58 | </dl>
|
|---|
| 59 |
|
|---|
| 60 |
|
|---|
| 61 | <br><br>
|
|---|
| 62 | <hr noshade>
|
|---|
| 63 | <table border=0 width=100%>
|
|---|
| 64 | <tr valign=top>
|
|---|
| 65 | <td><p class=tiny>copyright © 2000-2021 Xiph.Org Foundation</p></td>
|
|---|
| 66 | <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
|
|---|
| 67 | </tr><tr>
|
|---|
| 68 | <td><p class=tiny>libogg documentation</p></td>
|
|---|
| 69 | <td align=right><p class=tiny>libogg release 1.3.5 - 20210603</p></td>
|
|---|
| 70 | </tr>
|
|---|
| 71 | </table>
|
|---|
| 72 |
|
|---|
| 73 | </body>
|
|---|
| 74 |
|
|---|
| 75 | </html>
|
|---|
