examples/SFExamples/oggvorbiscodec/src/libvorbis/doc/vorbisfile/fileinfo.html

00001 <html>
00002 
00003 <head>
00004 <title>Vorbisfile - File Information</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>Vorbisfile documentation</p></td>
00012 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00013 </tr>
00014 </table>
00015 
00016 <h1>File Information</h1>
00017 <p>Libvorbisfile contains many functions to get information about bitstream attributes and decoding status.
00018 <p>
00019 All libvorbisfile file information routines are declared in "vorbis/vorbisfile.h".
00020 <p>
00021 
00022 <table border=1 color=black width=50% cellspacing=0 cellpadding=7>
00023 <tr bgcolor=#cccccc>
00024         <td><b>function</b></td>
00025         <td><b>purpose</b></td>
00026 </tr>
00027 <tr valign=top>
00028         <td><a href="ov_bitrate.html">ov_bitrate</a></td>
00029         <td>Returns the average bitrate of the current logical bitstream.</td>
00030 </tr>
00031 <tr valign=top>
00032         <td><a href="ov_bitrate_instant.html">ov_bitrate_instant</a></td>
00033         <td>Returns the exact bitrate since the last call of this function, or -1 if at the beginning of the bitream or no new information is available.</td>
00034 </tr>
00035 <tr valign=top>
00036         <td><a href="ov_streams.html">ov_streams</a></td>
00037         <td>Gives the number of logical bitstreams within the current physical bitstream.</td>
00038 </tr>
00039 <tr valign=top>
00040         <td><a href="ov_seekable.html">ov_seekable</a></td>
00041         <td>Indicates whether the bitstream is seekable.</td>
00042 </tr>
00043 <tr valign=top>
00044         <td><a href="ov_serialnumber.html">ov_serialnumber</a></td>
00045         <td>Returns the unique serial number of the specified logical bitstream.</td>
00046 </tr>
00047 <tr valign=top>
00048         <td><a href="ov_raw_total.html">ov_raw_total</a></td>
00049         <td>Returns the total (compressed) bytes in a physical or logical seekable bitstream.</td>
00050 </tr>
00051 <tr valign=top>
00052         <td><a href="ov_pcm_total.html">ov_pcm_total</a></td>
00053         <td>Returns the total number of samples in a physical or logical seekable bitstream.</td>
00054 </tr>
00055 <tr valign=top>
00056         <td><a href="ov_time_total.html">ov_time_total</a></td>
00057         <td>Returns the total time length in seconds of a physical or logical seekable bitstream.</td>
00058 </tr>
00059 <tr valign=top>
00060         <td><a href="ov_raw_tell.html">ov_raw_tell</a></td>
00061         <td>Returns the byte location of the next sample to be read, giving the approximate location in the stream that the decoding engine has reached.</td>
00062 </tr>
00063 <tr valign=top>
00064         <td><a href="ov_pcm_tell.html">ov_pcm_tell</a></td>
00065         <td>Returns the sample location of the next sample to be read, giving the approximate location in the stream that the decoding engine has reached.</td>
00066 </tr>
00067 <tr valign=top>
00068         <td><a href="ov_time_tell.html">ov_time_tell</a></td>
00069         <td>Returns the time location of the next sample to be read, giving the approximate location in the stream that the decoding engine has reached.</td>
00070 </tr>
00071 <tr valign=top>
00072         <td><a href="ov_info.html">ov_info</a></td>
00073         <td>Returns the <a href="vorbis_info.html">vorbis_info</a> struct for a specific bitstream section.</td>
00074 </tr>
00075 <tr valign=top>
00076         <td><a href="ov_comment.html">ov_comment</a></td>
00077         <td>Returns attached <a href="vorbis_comment.html">comments</a> for the current bitstream.</td>
00078 </tr>
00079 </table>
00080 
00081 <br><br>
00082 <hr noshade>
00083 <table border=0 width=100%>
00084 <tr valign=top>
00085 <td><p class=tiny>copyright &copy; 2003 Xiph.org</p></td>
00086 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
00087 </tr><tr>
00088 <td><p class=tiny>Vorbisfile documentation</p></td>
00089 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00090 </tr>
00091 </table>
00092 
00093 </body>
00094 
00095 </html>

Generated by  doxygen 1.6.2