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