ov_bitrate.html 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. <html>
  2. <head>
  3. <title>Tremor - function - ov_bitrate</title>
  4. <link rel=stylesheet href="style.css" type="text/css">
  5. </head>
  6. <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
  7. <table border=0 width=100%>
  8. <tr>
  9. <td><p class=tiny>Tremor documentation</p></td>
  10. <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
  11. </tr>
  12. </table>
  13. <h1>ov_bitrate</h1>
  14. <p><i>declared in "ivorbisfile.h";</i></p>
  15. <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.
  16. <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.
  17. <p>
  18. <br><br>
  19. <table border=0 color=black cellspacing=0 cellpadding=7>
  20. <tr bgcolor=#cccccc>
  21. <td>
  22. <pre><b>
  23. long ov_bitrate(OggVorbis_File *vf,int i);
  24. </b></pre>
  25. </td>
  26. </tr>
  27. </table>
  28. <h3>Parameters</h3>
  29. <dl>
  30. <dt><i>vf</i></dt>
  31. <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec
  32. functions.</dd>
  33. <dt><i>i</i></dt>
  34. <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>
  35. </dl>
  36. <h3>Return Values</h3>
  37. <blockquote>
  38. <li>OV_EINVAL indicates that an invalid argument value was submitted or that the stream represented by <tt>vf</tt> is not open.</li>
  39. <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.
  40. <li><i>n</i> indicates the bitrate for the given logical bitstream or the entire
  41. physical bitstream. If the file is open for random (seekable) access, it will
  42. find the *actual* average bitrate. If the file is streaming (nonseekable), it
  43. returns the nominal bitrate (if set) or else the average of the
  44. upper/lower bounds (if set).</li>
  45. </blockquote>
  46. <p>
  47. <br><br>
  48. <hr noshade>
  49. <table border=0 width=100%>
  50. <tr valign=top>
  51. <td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>
  52. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
  53. </tr><tr>
  54. <td><p class=tiny>Tremor documentation</p></td>
  55. <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
  56. </tr>
  57. </table>
  58. </body>
  59. </html>