| <html> |
| |
| <head> |
| <title>libogg - datatype - ogg_page</title> |
| <link rel=stylesheet href="style.css" type="text/css"> |
| </head> |
| |
| <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> |
| <table border=0 width=100%> |
| <tr> |
| <td><p class=tiny>libogg documentation</p></td> |
| <td align=right><p class=tiny>libogg release 1.3.4 - 20190830</p></td> |
| </tr> |
| </table> |
| |
| <h1>ogg_page</h1> |
| |
| <p><i>declared in "ogg/ogg.h"</i></p> |
| |
| <p> |
| The ogg_page struct encapsulates the data for an Ogg page. |
| <p> |
| 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 many |
| applications will not completely fill all pages because they flush the |
| accumulated packets periodically order to bound latency more tightly. |
| <p> |
| <p>For a complete description of ogg pages and headers, please refer to the <a href="../framing.html">framing document</a>. |
| |
| <table border=0 width=100% color=black cellspacing=0 cellpadding=7> |
| <tr bgcolor=#cccccc> |
| <td> |
| <pre><b> |
| typedef struct { |
| unsigned char *header; |
| long header_len; |
| unsigned char *body; |
| long body_len; |
| } ogg_page; |
| </b></pre> |
| </td> |
| </tr> |
| </table> |
| |
| <h3>Relevant Struct Members</h3> |
| <dl> |
| <dt><i>header</i></dt> |
| <dd>Pointer to the page header for this page. The exact contents of this header are defined in the framing spec document.</dd> |
| <dt><i>header_len</i></dt> |
| <dd>Length of the page header in bytes.</a> |
| <dt><i>body</i></dt> |
| <dd>Pointer to the data for this page.</dd> |
| <dt><i>body_len</i></dt> |
| <dd>Length of the body data in bytes.</dd> |
| </dl> |
| |
| |
| <br><br> |
| <hr noshade> |
| <table border=0 width=100%> |
| <tr valign=top> |
| <td><p class=tiny>copyright © 2000-2019 Xiph.Org Foundation</p></td> |
| <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td> |
| </tr><tr> |
| <td><p class=tiny>libogg documentation</p></td> |
| <td align=right><p class=tiny>libogg release 1.3.4 - 20190830</p></td> |
| </tr> |
| </table> |
| |
| </body> |
| |
| </html> |
