vorbis_info.html 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. <html>
  2. <head>
  3. <title>vorbis - datatype - vorbis_info</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>libvorbisenc documentation</p></td>
  10. <td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
  11. </tr>
  12. </table>
  13. <h1>vorbis_info</h1>
  14. <p><i>declared in "vorbis/codec.h"</i></p>
  15. <p>
  16. The vorbis_info structure contains information about a vorbis bitstream.
  17. <p>
  18. <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
  19. <tr bgcolor=#cccccc>
  20. <td>
  21. <pre><b>typedef struct vorbis_info{
  22. int version;
  23. int channels;
  24. long rate;
  25. long bitrate_upper;
  26. long bitrate_nominal;
  27. long bitrate_lower;
  28. long bitrate_window;
  29. void *codec_setup;
  30. } vorbis_info;</b></pre>
  31. </td>
  32. </tr>
  33. </table>
  34. <h3>Relevant Struct Members</h3>
  35. <dl>
  36. <dt><i>version</i></dt>
  37. <dd>Vorbis encoder version used to create this bitstream.</dd>
  38. <dt><i>channels</i></dt>
  39. <dd>Int signifying number of channels in bitstream.</dd>
  40. <dt><i>rate</i></dt>
  41. <dd>Sampling rate of the bitstream.</dd>
  42. <dt><i>bitrate_upper</i></dt>
  43. <dd>Specifies the upper limit in a VBR bitstream. If the value matches the bitrate_nominal and bitrate_lower parameters, the stream is fixed bitrate. May be unset if no limit exists.</dd>
  44. <dt><i>bitrate_nominal</i></dt>
  45. <dd>Specifies the average bitrate for a VBR bitstream. May be unset. If the bitrate_upper and bitrate_lower parameters match, the stream is fixed bitrate.</dd>
  46. <dt><i>bitrate_lower</i></dt>
  47. <dd>Specifies the lower limit in a VBR bitstream. If the value matches the bitrate_nominal and bitrate_upper parameters, the stream is fixed bitrate. May be unset if no limit exists.</dd>
  48. <dt><i>bitrate_window</i></dt>
  49. <dd>Specifies the size of the bit reservoir in seconds relative to the nominal bitrate. May be unset.</dd>
  50. <dt><i>codec_setup</i></dt>
  51. <dd>Pointer to private encoder setup state.</dd>
  52. </dl>
  53. <br><br>
  54. <hr noshade>
  55. <table border=0 width=100%>
  56. <tr valign=top>
  57. <td><p class=tiny>copyright &copy; 2004 vorbis team</p></td>
  58. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
  59. </tr><tr>
  60. <td><p class=tiny>vorbisfile documentation</p></td>
  61. <td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
  62. </tr>
  63. </table>
  64. </body>
  65. </html>