00001 <html>
00002
00003 <head>
00004 <title>Vorbisfile - datatype - vorbis_comment</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>Vorbisfile documentation</p></td>
00012 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00013 </tr>
00014 </table>
00015
00016 <h1>vorbis_comment</h1>
00017
00018 <p><i>declared in "vorbis/codec.h"</i></p>
00019
00020 <p>
00021 The vorbis_comment structure defines an Ogg Vorbis comment.
00022 <p>
00023 Only the fields the program needs must be defined. If a field isn't
00024 defined by the application, it will either be blank (if it's a string value)
00025 or set to some reasonable default (usually 0).
00026 <p>
00027
00028 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
00029 <tr bgcolor=#cccccc>
00030 <td>
00031 <pre><b>typedef struct vorbis_comment{
00032
00033 char **user_comments;
00034 int *comment_lengths;
00035 int comments;
00036 char *vendor;
00037
00038 } vorbis_comment;</b></pre>
00039 </td>
00040 </tr>
00041 </table>
00042
00043 <h3>Parameters</h3>
00044 <dl>
00045 <dt><i>user_comments</i></dt>
00046 <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>
00047 <dt><i>comment_lengths</i></dt>
00048 <dd>An int array that stores the length of each comment string</dd>
00049 <dt><i>comments</i></dt>
00050 <dd>Int signifying number of user comments in user_comments field.</dd>
00051 <dt><i>vendor</i></dt>
00052 <dd>Information about the creator of the file. Stored in a standard C 0-terminated string.</dd>
00053 </dl>
00054
00055
00056 <br><br>
00057 <hr noshade>
00058 <table border=0 width=100%>
00059 <tr valign=top>
00060 <td><p class=tiny>copyright © 2003 Xiph.org</p></td>
00061 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
00062 </tr><tr>
00063 <td><p class=tiny>Vorbisfile documentation</p></td>
00064 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00065 </tr>
00066 </table>
00067
00068 </body>
00069
00070 </html>
