vorbis_comment.html 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. <html>
  2. <head>
  3. <title>vorbisfile - datatype - vorbis_comment</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>vorbisfile documentation</p></td>
  10. <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  11. </tr>
  12. </table>
  13. <h1>vorbis_comment</h1>
  14. <p><i>declared in "vorbis/codec.h"</i></p>
  15. <p>
  16. The vorbis_comment structure defines an Ogg Vorbis comment.
  17. <p>
  18. Only the fields the program needs must be defined. If a field isn't
  19. defined by the application, it will either be blank (if it's a string value)
  20. or set to some reasonable default (usually 0).
  21. <p>
  22. <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
  23. <tr bgcolor=#cccccc>
  24. <td>
  25. <pre><b>typedef struct vorbis_comment{
  26. /* unlimited user comment fields. */
  27. char **user_comments;
  28. int comments;
  29. char *vendor;
  30. } vorbis_comment;</b></pre>
  31. </td>
  32. </tr>
  33. </table>
  34. <h3>Parameters</h3>
  35. <dl>
  36. <dt><i>user_comments</i></dt>
  37. <dd>Unlimited user comment array. Comments stored in normal C 0-terminated strings.</dd>
  38. <dt><i>comments</i></dt>
  39. <dd>Int signifying number of user comments in user_comments field.</dd>
  40. <dt><i>vendor</i></dt>
  41. <dd>Information about the creator of the file. Stored in a standard C 0-terminated string.</dd>
  42. </dl>
  43. <br><br>
  44. <hr noshade>
  45. <table border=0 width=100%>
  46. <tr valign=top>
  47. <td><p class=tiny>copyright &copy; 2000 vorbis team</p></td>
  48. <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>
  49. </tr><tr>
  50. <td><p class=tiny>vorbisfile documentation</p></td>
  51. <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  52. </tr>
  53. </table>
  54. </body>
  55. </html>