vorbis_comment.html 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. <html>
  2. <head>
  3. <title>Tremor - 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>Tremor documentation</p></td>
  10. <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
  11. </tr>
  12. </table>
  13. <h1>vorbis_comment</h1>
  14. <p><i>declared in "ivorbiscodec.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 *comment_lengths;
  29. int comments;
  30. char *vendor;
  31. } vorbis_comment;</b></pre>
  32. </td>
  33. </tr>
  34. </table>
  35. <h3>Parameters</h3>
  36. <dl>
  37. <dt><i>user_comments</i></dt>
  38. <dd>Unlimited user comment array. The individual strings in the array are 8 bit clean, by the Vorbis specification, and as such the <tt>comment_lengths</tt> array should be consulted to determine string length. For convenience, each string is also NULL-terminated by the decode library (although Vorbis comments are not NULL terminated within the bitstream itself).</dd>
  39. <dt><i>comment_lengths</i></dt>
  40. <dd>An int array that stores the length of each comment string</dd>
  41. <dt><i>comments</i></dt>
  42. <dd>Int signifying number of user comments in user_comments field.</dd>
  43. <dt><i>vendor</i></dt>
  44. <dd>Information about the creator of the file. Stored in a standard C 0-terminated string.</dd>
  45. </dl>
  46. <br><br>
  47. <hr noshade>
  48. <table border=0 width=100%>
  49. <tr valign=top>
  50. <td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>
  51. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
  52. </tr><tr>
  53. <td><p class=tiny>Tremor documentation</p></td>
  54. <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
  55. </tr>
  56. </table>
  57. </body>
  58. </html>