Mercurial > hg > sv-dependency-builds

annotate src/libogg-1.3.0/doc/libogg/general.html @ 86:98c1576536ae

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