Home | History | Annotate | Download | only in vorbisfile
      1 <html>
      2 
      3 <head>
      4 <title>Vorbisfile - File Information</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>Vorbisfile documentation</p></td>
     12 <td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
     13 </tr>
     14 </table>
     15 
     16 <h1>File Information</h1>
     17 <p>Libvorbisfile contains many functions to get information about bitstream attributes and decoding status.
     18 <p>
     19 All libvorbisfile file information routines are declared in "vorbis/vorbisfile.h".
     20 <p>
     21 
     22 <table border=1 color=black width=50% cellspacing=0 cellpadding=7>
     23 <tr bgcolor=#cccccc>
     24 	<td><b>function</b></td>
     25 	<td><b>purpose</b></td>
     26 </tr>
     27 <tr valign=top>
     28 	<td><a href="ov_bitrate.html">ov_bitrate</a></td>
     29 	<td>Returns the average bitrate of the current logical bitstream.</td>
     30 </tr>
     31 <tr valign=top>
     32 	<td><a href="ov_bitrate_instant.html">ov_bitrate_instant</a></td>
     33 	<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>
     34 </tr>
     35 <tr valign=top>
     36 	<td><a href="ov_streams.html">ov_streams</a></td>
     37 	<td>Gives the number of logical bitstreams within the current physical bitstream.</td>
     38 </tr>
     39 <tr valign=top>
     40 	<td><a href="ov_seekable.html">ov_seekable</a></td>
     41 	<td>Indicates whether the bitstream is seekable.</td>
     42 </tr>
     43 <tr valign=top>
     44 	<td><a href="ov_serialnumber.html">ov_serialnumber</a></td>
     45 	<td>Returns the unique serial number of the specified logical bitstream.</td>
     46 </tr>
     47 <tr valign=top>
     48 	<td><a href="ov_raw_total.html">ov_raw_total</a></td>
     49 	<td>Returns the total (compressed) bytes in a physical or logical seekable bitstream.</td>
     50 </tr>
     51 <tr valign=top>
     52 	<td><a href="ov_pcm_total.html">ov_pcm_total</a></td>
     53 	<td>Returns the total number of samples in a physical or logical seekable bitstream.</td>
     54 </tr>
     55 <tr valign=top>
     56 	<td><a href="ov_time_total.html">ov_time_total</a></td>
     57 	<td>Returns the total time length in seconds of a physical or logical seekable bitstream.</td>
     58 </tr>
     59 <tr valign=top>
     60 	<td><a href="ov_raw_tell.html">ov_raw_tell</a></td>
     61 	<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>
     62 </tr>
     63 <tr valign=top>
     64 	<td><a href="ov_pcm_tell.html">ov_pcm_tell</a></td>
     65 	<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>
     66 </tr>
     67 <tr valign=top>
     68 	<td><a href="ov_time_tell.html">ov_time_tell</a></td>
     69 	<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>
     70 </tr>
     71 <tr valign=top>
     72 	<td><a href="ov_info.html">ov_info</a></td>
     73 	<td>Returns the <a href="vorbis_info.html">vorbis_info</a> struct for a specific bitstream section.</td>
     74 </tr>
     75 <tr valign=top>
     76 	<td><a href="ov_comment.html">ov_comment</a></td>
     77 	<td>Returns attached <a href="vorbis_comment.html">comments</a> for the current bitstream.</td>
     78 </tr>
     79 </table>
     80 
     81 <br><br>
     82 <hr noshade>
     83 <table border=0 width=100%>
     84 <tr valign=top>
     85 <td><p class=tiny>copyright &copy; 2007 Xiph.org</p></td>
     86 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
     87 </tr><tr>
     88 <td><p class=tiny>Vorbisfile documentation</p></td>
     89 <td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
     90 </tr>
     91 </table>
     92 
     93 </body>
     94 
     95 </html>
     96