Home | History | Annotate | Download | only in vorbisfile
      1 <html>
      2 
      3 <head>
      4 <title>Vorbisfile - function - ov_bitrate</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>ov_bitrate_instant</h1>
     17 
     18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
     19 
     20 <p>Used to find the most recent bitrate played back within the file.  Will return 0 if the bitrate has not changed or it is the beginning of the file.
     21 
     22 <br><br>
     23 <table border=0 color=black cellspacing=0 cellpadding=7>
     24 <tr bgcolor=#cccccc>
     25 	<td>
     26 <pre><b>
     27 long ov_bitrate_instant(OggVorbis_File *vf);
     28 </b></pre>
     29 	</td>
     30 </tr>
     31 </table>
     32 
     33 <h3>Parameters</h3>
     34 <dl>
     35 <dt><i>vf</i></dt>
     36 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
     37 functions.
     38 </dl>
     39 
     40 
     41 <h3>Return Values</h3>
     42 <blockquote>
     43 <li>0 indicates the beginning of the file or unchanged bitrate info.</li>
     44 <li><i>n</i> indicates the actual bitrate since the last call.</li>
     45 <li>OV_FALSE indicates that playback is not in progress, and thus there is no instantaneous bitrate information to report.</li>
     46 <li>OV_EINVAL indicates that the stream represented by <tt>vf</tt> is not open.</li>
     47 </blockquote>
     48 <p>
     49 
     50 
     51 <br><br>
     52 <hr noshade>
     53 <table border=0 width=100%>
     54 <tr valign=top>
     55 <td><p class=tiny>copyright &copy; 2007 Xiph.org</p></td>
     56 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
     57 </tr><tr>
     58 <td><p class=tiny>Vorbisfile documentation</p></td>
     59 <td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
     60 </tr>
     61 </table>
     62 
     63 </body>
     64 
     65 </html>
     66