1<html> 2 3<head> 4<title>libogg - General Functions</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.2.0 - 20100325</p></td> 13</tr> 14</table> 15 16<h1>General Functions</h1> 17<p>Libogg contains several functions which are generally useful when using Ogg streaming, whether encoding or decoding. 18<p> 19All the <b>libogg</b> specific functions are declared in "ogg/ogg.h". 20<p> 21<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. 22<br> 23 24<table border=1 color=black width=50% cellspacing=0 cellpadding=7> 25<tr bgcolor=#cccccc> 26 <td><b>function</b></td> 27 <td><b>purpose</b></td> 28</tr> 29<tr valign=top> 30<td><a href="ogg_stream_init.html">ogg_stream_init</a></td> 31 <td>Initializes an Ogg bitstream.</td> 32</tr> 33<tr valign=top> 34<td><a href="ogg_stream_clear.html">ogg_stream_clear</a></td> 35 <td>Clears the storage within the Ogg stream, but does not free the stream itself.<td> 36</tr> 37<tr valign=top> 38<td><a href="ogg_stream_reset.html">ogg_stream_reset</a></td> 39 <td>Resets the stream status to its initial position.</td> 40</tr> 41<tr valign=top> 42<td><a href="ogg_stream_destroy.html">ogg_stream_destroy</a></td> 43 <td>Frees the entire Ogg stream.</td> 44</tr> 45<tr valign=top> 46<td><a href="ogg_stream_check.html">ogg_stream_check</a></td> 47 <td>Check for asyncronous errors.</td> 48</tr> 49<tr valign=top> 50<td><a href="ogg_stream_eos.html">ogg_stream_eos</a></td> 51 <td>Indicates whether we are at the end of the stream.</td> 52</tr> 53<tr valign=top> 54<td><a href="ogg_page_version.html">ogg_page_version</a></td> 55 <td>Returns the version of ogg_page that this stream/page uses</td> 56</tr> 57<tr valign=top> 58<td><a href="ogg_page_continued.html">ogg_page_continued</a></td> 59 <td>Indicates if the current page contains a continued packet from the last page.</td> 60</tr> 61<tr valign=top> 62<td><a href="ogg_page_packets.html">ogg_page_packets</a></td> 63 <td>Indicates the number of packets contained in a page.</td> 64</tr> 65<tr valign=top> 66<td><a href="ogg_page_bos.html">ogg_page_bos</a></td> 67 <td>Indicates if the current page is the beginning of the stream.</td> 68</tr> 69<tr valign=top> 70<td><a href="ogg_page_eos.html">ogg_page_eos</a></td> 71 <td>Indicates if the current page is the end of the stream.</td> 72</tr> 73<tr valign=top> 74<td><a href="ogg_page_granulepos.html">ogg_page_granulepos</a></td> 75 <td>Returns the precise playback location of this page.</td> 76</tr> 77<tr valign=top> 78<td><a href="ogg_page_serialno.html">ogg_page_serialno</a></td> 79 <td>Returns the unique serial number of the logical bitstream associated with this page.</td> 80</tr> 81<tr valign=top> 82<td><a href="ogg_page_pageno.html">ogg_page_pageno</a></td> 83 <td>Returns the sequential page number for this page.</td> 84</tr> 85<tr valign=top> 86<td><a href="ogg_packet_clear.html">ogg_packet_clear</a></td> 87 <td>Clears the ogg_packet structure.</td> 88</tr> 89<tr valign=top> 90<td><a href="ogg_page_checksum_set.html">ogg_page_checksum_set</a></td> 91 <td>Checksums an ogg_page.</td> 92</tr> 93</table> 94 95<br><br> 96<hr noshade> 97<table border=0 width=100%> 98<tr valign=top> 99<td><p class=tiny>copyright © 2000-2010 Xiph.Org</p></td> 100<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td> 101</tr><tr> 102<td><p class=tiny>libogg documentation</p></td> 103<td align=right><p class=tiny>libogg release 1.2.0 - 20100325</p></td> 104</tr> 105</table> 106 107</body> 108 109</html> 110