Dependencies/libvorbis/doc/vorbisfile/fileinfo.html

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