00001 <html>
00002
00003 <head>
00004 <title>Vorbisfile - 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>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>ov_bitrate</h1>
00017
00018 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
00019
00020 <p>This function returns the average bitrate for the specified logical bitstream. This may be different from the <a href=ov_info.html>ov_info->nominal_bitrate</a> value, as it is based on the actual average for this bitstream if the file is seekable.
00021 <p>Nonseekable files will return the nominal bitrate setting or the average of the upper and lower bounds, if any of these values are set.
00022 <p>
00023
00024 <br><br>
00025 <table border=0 color=black cellspacing=0 cellpadding=7>
00026 <tr bgcolor=#cccccc>
00027 <td>
00028 <pre><b>
00029 long ov_bitrate(OggVorbis_File *vf,int i);
00030 </b></pre>
00031 </td>
00032 </tr>
00033 </table>
00034
00035 <h3>Parameters</h3>
00036 <dl>
00037 <dt><i>vf</i></dt>
00038 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
00039 functions.</dd>
00040 <dt><i>i</i></dt>
00041 <dd>Link to the desired logical bitstream. For nonseekable files, this argument is ignored. To retrieve the bitrate for the entire bitstream, this parameter should be set to -1.</dd>
00042 </dl>
00043
00044
00045 <h3>Return Values</h3>
00046 <blockquote>
00047 <li>OV_EINVAL indicates that an invalid argument value was submitted or that the stream represented by <tt>vf</tt> is not open.</li>
00048 <li>OV_FALSE means the call returned a 'false' status, which in this case most likely indicates that the file is nonseekable and the upper, lower, and nominal bitrates were unset.
00049 <li><i>n</i> indicates the bitrate for the given logical bitstream or the entire
00050 physical bitstream. If the file is open for random (seekable) access, it will
00051 find the *actual* average bitrate. If the file is streaming (nonseekable), it
00052 returns the nominal bitrate (if set) or else the average of the
00053 upper/lower bounds (if set).</li>
00054 </blockquote>
00055 <p>
00056
00057
00058 <br><br>
00059 <hr noshade>
00060 <table border=0 width=100%>
00061 <tr valign=top>
00062 <td><p class=tiny>copyright © 2003 Xiph.org</p></td>
00063 <td align=right><p class=tiny><a href="http:
00064 </tr><tr>
00065 <td><p class=tiny>Vorbisfile documentation</p></td>
00066 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00067 </tr>
00068 </table>
00069
00070 </body>
00071
00072 </html>
