12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970 |
- <html>
- <head>
- <title>Tremor - datatype - vorbis_comment</title>
- <link rel=stylesheet href="style.css" type="text/css">
- </head>
- <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
- <table border=0 width=100%>
- <tr>
- <td><p class=tiny>Tremor documentation</p></td>
- <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
- </tr>
- </table>
- <h1>vorbis_comment</h1>
- <p><i>declared in "ivorbiscodec.h"</i></p>
- <p>
- The vorbis_comment structure defines an Ogg Vorbis comment.
- <p>
- Only the fields the program needs must be defined. If a field isn't
- defined by the application, it will either be blank (if it's a string value)
- or set to some reasonable default (usually 0).
- <p>
- <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
- <tr bgcolor=#cccccc>
- <td>
- <pre><b>typedef struct vorbis_comment{
- /* unlimited user comment fields. */
- char **user_comments;
- int *comment_lengths;
- int comments;
- char *vendor;
- } vorbis_comment;</b></pre>
- </td>
- </tr>
- </table>
- <h3>Parameters</h3>
- <dl>
- <dt><i>user_comments</i></dt>
- <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>
- <dt><i>comment_lengths</i></dt>
- <dd>An int array that stores the length of each comment string</dd>
- <dt><i>comments</i></dt>
- <dd>Int signifying number of user comments in user_comments field.</dd>
- <dt><i>vendor</i></dt>
- <dd>Information about the creator of the file. Stored in a standard C 0-terminated string.</dd>
- </dl>
- <br><br>
- <hr noshade>
- <table border=0 width=100%>
- <tr valign=top>
- <td><p class=tiny>copyright © 2002 Xiph.org</p></td>
- <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
- </tr><tr>
- <td><p class=tiny>Tremor documentation</p></td>
- <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
- </tr>
- </table>
- </body>
- </html>
|