00001 <html>
00002
00003 <head>
00004 <title>libogg - General Functions</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 release 1.0 - 20000615</p></td>
00013 </tr>
00014 </table>
00015
00016 <h1>General Functions</h1>
00017 <p>Libogg contains several functions which are generally useful when using Ogg streaming, whether encoding or decoding.
00018 <p>
00019 All the <b>libogg</b> specific functions are declared in "ogg/ogg.h".
00020 <p>
00021 <p>These functions can be used to manipulate some of the basic elements of Ogg - streams and pages. Streams and pages are important during both the encode and decode process.
00022 <br>
00023
00024 <table border=1 color=black width=50% cellspacing=0 cellpadding=7>
00025 <tr bgcolor=#cccccc>
00026 <td><b>function</b></td>
00027 <td><b>purpose</b></td>
00028 </tr>
00029 <tr valign=top>
00030 <td><a href="ogg_stream_init.html">ogg_stream_init</a></td>
00031 <td>Initializes an Ogg bitstream.</td>
00032 </tr>
00033 <tr valign=top>
00034 <td><a href="ogg_stream_clear.html">ogg_stream_clear</a></td>
00035 <td>Clears the storage within the Ogg stream, but does not free the stream itself.<td>
00036 </tr>
00037 <tr valign=top>
00038 <td><a href="ogg_stream_reset.html">ogg_stream_reset</a></td>
00039 <td>Resets the stream status to its initial position.</td>
00040 </tr>
00041 <tr valign=top>
00042 <td><a href="ogg_stream_destroy.html">ogg_stream_destroy</a></td>
00043 <td>Frees the entire Ogg stream.</td>
00044 </tr>
00045 <tr valign=top>
00046 <td><a href="ogg_stream_eos.html">ogg_stream_eos</a></td>
00047 <td>Indicates whether we are at the end of the stream.</td>
00048 </tr>
00049 <tr valign=top>
00050 <td><a href="ogg_page_version.html">ogg_page_version</a></td>
00051 <td>Returns the version of ogg_page that this stream/page uses</td>
00052 </tr>
00053 <tr valign=top>
00054 <td><a href="ogg_page_continued.html">ogg_page_continued</a></td>
00055 <td>Indicates if the current page contains a continued packet from the last page.</td>
00056 </tr>
00057 <tr valign=top>
00058 <td><a href="ogg_page_packets.html">ogg_page_packets</a></td>
00059 <td>Indicates the number of packets contained in a page.</td>
00060 </tr>
00061 <tr valign=top>
00062 <td><a href="ogg_page_bos.html">ogg_page_bos</a></td>
00063 <td>Indicates if the current page is the beginning of the stream.</td>
00064 </tr>
00065 <tr valign=top>
00066 <td><a href="ogg_page_eos.html">ogg_page_eos</a></td>
00067 <td>Indicates if the current page is the end of the stream.</td>
00068 </tr>
00069 <tr valign=top>
00070 <td><a href="ogg_page_granulepos.html">ogg_page_granulepos</a></td>
00071 <td>Returns the precise playback location of this page.</td>
00072 </tr>
00073 <tr valign=top>
00074 <td><a href="ogg_page_serialno.html">ogg_page_serialno</a></td>
00075 <td>Returns the unique serial number of the logical bitstream associated with this page.</td>
00076 </tr>
00077 <tr valign=top>
00078 <td><a href="ogg_page_pageno.html">ogg_page_pageno</a></td>
00079 <td>Returns the sequential page number for this page.</td>
00080 </tr>
00081 <tr valign=top>
00082 <td><a href="ogg_packet_clear.html">ogg_packet_clear</a><td>
00083 <td>Clears the ogg_packet structure.</td>
00084 </tr>
00085 <tr valign=top>
00086 <td><a href="ogg_page_checksum_set.html">ogg_page_checksum_set</a></td>
00087 <td>Checksums an ogg_page.</td>
00088 </tr>
00089 </table>
00090
00091 <br><br>
00092 <hr noshade>
00093 <table border=0 width=100%>
00094 <tr valign=top>
00095 <td><p class=tiny>copyright © 2000 xiph.org</p></td>
00096 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td>
00097 </tr><tr>
00098 <td><p class=tiny>libogg documentation</p></td>
00099 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00100 </tr>
00101 </table>
00102
00103 </body>
00104
00105 </html>
