examples/sfexamples/oggvorbiscodec/src/tremor/doc/ov_bitrate_instant.html

00001 <html>
00002 
00003 <head>
00004 <title>Tremor - function - ov_bitrate</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>Tremor documentation</p></td>
00012 <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
00013 </tr>
00014 </table>
00015 
00016 <h1>ov_bitrate_instant</h1>
00017 
00018 <p><i>declared in "ivorbisfile.h";</i></p>
00019 
00020 <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.
00021 
00022 <br><br>
00023 <table border=0 color=black cellspacing=0 cellpadding=7>
00024 <tr bgcolor=#cccccc>
00025         <td>
00026 <pre><b>
00027 long ov_bitrate_instant(OggVorbis_File *vf);
00028 </b></pre>
00029         </td>
00030 </tr>
00031 </table>
00032 
00033 <h3>Parameters</h3>
00034 <dl>
00035 <dt><i>vf</i></dt>
00036 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec
00037 functions.
00038 </dl>
00039 
00040 
00041 <h3>Return Values</h3>
00042 <blockquote>
00043 <li>0 indicates the beginning of the file or unchanged bitrate info.</li>
00044 <li><i>n</i> indicates the actual bitrate since the last call.</li>
00045 <li>OV_FALSE indicates that playback is not in progress, and thus there is no instantaneous bitrate information to report.</li>
00046 <li>OV_EINVAL indicates that the stream represented by <tt>vf</tt> is not open.</li>
00047 </blockquote>
00048 <p>
00049 
00050 
00051 <br><br>
00052 <hr noshade>
00053 <table border=0 width=100%>
00054 <tr valign=top>
00055 <td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>
00056 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
00057 </tr><tr>
00058 <td><p class=tiny>Tremor documentation</p></td>
00059 <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
00060 </tr>
00061 </table>
00062 
00063 </body>
00064 
00065 </html>

Generated by  doxygen 1.6.2