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</h1> 17 18 <p><i>declared in "vorbis/vorbisfile.h";</i></p> 19 20 <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. 21 <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. 22 <p> 23 24 <br><br> 25 <table border=0 color=black cellspacing=0 cellpadding=7> 26 <tr bgcolor=#cccccc> 27 <td> 28 <pre><b> 29 long ov_bitrate(OggVorbis_File *vf,int i); 30 </b></pre> 31 </td> 32 </tr> 33 </table> 34 35 <h3>Parameters</h3> 36 <dl> 37 <dt><i>vf</i></dt> 38 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile 39 functions.</dd> 40 <dt><i>i</i></dt> 41 <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> 42 </dl> 43 44 45 <h3>Return Values</h3> 46 <blockquote> 47 <li>OV_EINVAL indicates that an invalid argument value was submitted or that the stream represented by <tt>vf</tt> is not open.</li> 48 <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. 49 <li><i>n</i> indicates the bitrate for the given logical bitstream or the entire 50 physical bitstream. If the file is open for random (seekable) access, it will 51 find the *actual* average bitrate. If the file is streaming (nonseekable), it 52 returns the nominal bitrate (if set) or else the average of the 53 upper/lower bounds (if set).</li> 54 </blockquote> 55 <p> 56 57 58 <br><br> 59 <hr noshade> 60 <table border=0 width=100%> 61 <tr valign=top> 62 <td><p class=tiny>copyright © 2007 Xiph.org</p></td> 63 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> 64 </tr><tr> 65 <td><p class=tiny>Vorbisfile documentation</p></td> 66 <td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td> 67 </tr> 68 </table> 69 70 </body> 71 72 </html> 73
