ov_comment.html 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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_comment</h1>
  14. <p><i>declared in "ivorbisfile.h";</i></p>
  15. <p>Returns a pointer to the <a href="vorbis_comment.html">vorbis_comment</a> struct for the specified bitstream. For nonseekable streams, returns the struct for the current bitstream.
  16. <p>
  17. <br><br>
  18. <table border=0 color=black cellspacing=0 cellpadding=7>
  19. <tr bgcolor=#cccccc>
  20. <td>
  21. <pre><b>
  22. vorbis_comment *ov_comment(OggVorbis_File *vf,int link);
  23. </b></pre>
  24. </td>
  25. </tr>
  26. </table>
  27. <h3>Parameters</h3>
  28. <dl>
  29. <dt><i>vf</i></dt>
  30. <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec
  31. functions.</dd>
  32. <dt><i>i</i></dt>
  33. <dd>Link to the desired logical bitstream. For nonseekable files, this argument is ignored. To retrieve the <a href="vorbis_comment.html">vorbis_comment</a> struct for the current bitstream, this parameter should be set to -1.</dd>
  34. </dl>
  35. <h3>Return Values</h3>
  36. <blockquote>
  37. <li>Returns the vorbis_comment struct for the specified bitstream.</li>
  38. <li>NULL if the specified bitstream does not exist or the file has been initialized improperly.</li>
  39. </blockquote>
  40. <p>
  41. <br><br>
  42. <hr noshade>
  43. <table border=0 width=100%>
  44. <tr valign=top>
  45. <td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>
  46. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
  47. </tr><tr>
  48. <td><p class=tiny>Tremor documentation</p></td>
  49. <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
  50. </tr>
  51. </table>
  52. </body>
  53. </html>