summaryrefslogtreecommitdiffhomepage
path: root/doc/libogg/general.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/libogg/general.html')
-rw-r--r--doc/libogg/general.html109
1 files changed, 109 insertions, 0 deletions
diff --git a/doc/libogg/general.html b/doc/libogg/general.html
new file mode 100644
index 0000000..d892dd3
--- /dev/null
+++ b/doc/libogg/general.html
@@ -0,0 +1,109 @@
+<html>
+
+<head>
+<title>libogg - General Functions</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.2 - 20140527</p></td>
+</tr>
+</table>
+
+<h1>General Functions</h1>
+<p>Libogg contains several functions which are generally useful when using Ogg streaming, whether encoding or decoding.
+<p>
+All the <b>libogg</b> specific functions are declared in "ogg/ogg.h".
+<p>
+<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.
+<br>
+
+<table border=1 color=black width=50% cellspacing=0 cellpadding=7>
+<tr bgcolor=#cccccc>
+ <td><b>function</b></td>
+ <td><b>purpose</b></td>
+</tr>
+<tr valign=top>
+<td><a href="ogg_stream_init.html">ogg_stream_init</a></td>
+ <td>Initializes an Ogg bitstream.</td>
+</tr>
+<tr valign=top>
+<td><a href="ogg_stream_clear.html">ogg_stream_clear</a></td>
+ <td>Clears the storage within the Ogg stream, but does not free the stream itself.<td>
+</tr>
+<tr valign=top>
+<td><a href="ogg_stream_reset.html">ogg_stream_reset</a></td>
+ <td>Resets the stream status to its initial position.</td>
+</tr>
+<tr valign=top>
+<td><a href="ogg_stream_destroy.html">ogg_stream_destroy</a></td>
+ <td>Frees the entire Ogg stream.</td>
+</tr>
+<tr valign=top>
+<td><a href="ogg_stream_check.html">ogg_stream_check</a></td>
+ <td>Check for asyncronous errors.</td>
+</tr>
+<tr valign=top>
+<td><a href="ogg_stream_eos.html">ogg_stream_eos</a></td>
+ <td>Indicates whether we are at the end of the stream.</td>
+</tr>
+<tr valign=top>
+<td><a href="ogg_page_version.html">ogg_page_version</a></td>
+ <td>Returns the version of ogg_page that this stream/page uses</td>
+</tr>
+<tr valign=top>
+<td><a href="ogg_page_continued.html">ogg_page_continued</a></td>
+ <td>Indicates if the current page contains a continued packet from the last page.</td>
+</tr>
+<tr valign=top>
+<td><a href="ogg_page_packets.html">ogg_page_packets</a></td>
+ <td>Indicates the number of packets contained in a page.</td>
+</tr>
+<tr valign=top>
+<td><a href="ogg_page_bos.html">ogg_page_bos</a></td>
+ <td>Indicates if the current page is the beginning of the stream.</td>
+</tr>
+<tr valign=top>
+<td><a href="ogg_page_eos.html">ogg_page_eos</a></td>
+ <td>Indicates if the current page is the end of the stream.</td>
+</tr>
+<tr valign=top>
+<td><a href="ogg_page_granulepos.html">ogg_page_granulepos</a></td>
+ <td>Returns the precise playback location of this page.</td>
+</tr>
+<tr valign=top>
+<td><a href="ogg_page_serialno.html">ogg_page_serialno</a></td>
+ <td>Returns the unique serial number of the logical bitstream associated with this page.</td>
+</tr>
+<tr valign=top>
+<td><a href="ogg_page_pageno.html">ogg_page_pageno</a></td>
+ <td>Returns the sequential page number for this page.</td>
+</tr>
+<tr valign=top>
+<td><a href="ogg_packet_clear.html">ogg_packet_clear</a></td>
+ <td>Clears the ogg_packet structure.</td>
+</tr>
+<tr valign=top>
+<td><a href="ogg_page_checksum_set.html">ogg_page_checksum_set</a></td>
+ <td>Checksums an ogg_page.</td>
+</tr>
+</table>
+
+<br><br>
+<hr noshade>
+<table border=0 width=100%>
+<tr valign=top>
+<td><p class=tiny>copyright &copy; 2000-2014 Xiph.Org</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.2 - 20140527</p></td>
+</tr>
+</table>
+
+</body>
+
+</html>