ov_bitrate_instant.html 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  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_instant</h1>
  14. <p><i>declared in "ivorbisfile.h";</i></p>
  15. <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.
  16. <br><br>
  17. <table border=0 color=black cellspacing=0 cellpadding=7>
  18. <tr bgcolor=#cccccc>
  19. <td>
  20. <pre><b>
  21. long ov_bitrate_instant(OggVorbis_File *vf);
  22. </b></pre>
  23. </td>
  24. </tr>
  25. </table>
  26. <h3>Parameters</h3>
  27. <dl>
  28. <dt><i>vf</i></dt>
  29. <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec
  30. functions.
  31. </dl>
  32. <h3>Return Values</h3>
  33. <blockquote>
  34. <li>0 indicates the beginning of the file or unchanged bitrate info.</li>
  35. <li><i>n</i> indicates the actual bitrate since the last call.</li>
  36. <li>OV_FALSE indicates that playback is not in progress, and thus there is no instantaneous bitrate information to report.</li>
  37. <li>OV_EINVAL indicates that the stream represented by <tt>vf</tt> is not open.</li>
  38. </blockquote>
  39. <p>
  40. <br><br>
  41. <hr noshade>
  42. <table border=0 width=100%>
  43. <tr valign=top>
  44. <td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>
  45. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
  46. </tr><tr>
  47. <td><p class=tiny>Tremor documentation</p></td>
  48. <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
  49. </tr>
  50. </table>
  51. </body>
  52. </html>