| <html> |
| |
| <head> |
| <title>Tremor - function - ov_bitrate</title> |
| <link rel=stylesheet href="style.css" type="text/css"> |
| </head> |
| |
| <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> |
| <table border=0 width=100%> |
| <tr> |
| <td><p class=tiny>Tremor documentation</p></td> |
| <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td> |
| </tr> |
| </table> |
| |
| <h1>ov_bitrate</h1> |
| |
| <p><i>declared in "ivorbisfile.h";</i></p> |
| |
| <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. |
| <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. |
| <p> |
| |
| <br><br> |
| <table border=0 color=black cellspacing=0 cellpadding=7> |
| <tr bgcolor=#cccccc> |
| <td> |
| <pre><b> |
| long ov_bitrate(OggVorbis_File *vf,int i); |
| </b></pre> |
| </td> |
| </tr> |
| </table> |
| |
| <h3>Parameters</h3> |
| <dl> |
| <dt><i>vf</i></dt> |
| <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec |
| functions.</dd> |
| <dt><i>i</i></dt> |
| <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> |
| </dl> |
| |
| |
| <h3>Return Values</h3> |
| <blockquote> |
| <li>OV_EINVAL indicates that an invalid argument value was submitted or that the stream represented by <tt>vf</tt> is not open.</li> |
| <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. |
| <li><i>n</i> indicates the bitrate for the given logical bitstream or the entire |
| physical bitstream. If the file is open for random (seekable) access, it will |
| find the *actual* average bitrate. If the file is streaming (nonseekable), it |
| returns the nominal bitrate (if set) or else the average of the |
| upper/lower bounds (if set).</li> |
| </blockquote> |
| <p> |
| |
| |
| <br><br> |
| <hr noshade> |
| <table border=0 width=100%> |
| <tr valign=top> |
| <td><p class=tiny>copyright © 2002 Xiph.org</p></td> |
| <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td> |
| </tr><tr> |
| <td><p class=tiny>Tremor documentation</p></td> |
| <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td> |
| </tr> |
| </table> |
| |
| </body> |
| |
| </html> |
