]> git.jsancho.org Git - lugaru.git/blob - libogg-1.0/doc/ogg/vorbis_comment.html
Added (more or less) demo data files.
[lugaru.git] / libogg-1.0 / doc / ogg / vorbis_comment.html
1 <html>
2
3 <head>
4 <title>Vorbisfile - datatype - vorbis_comment</title>
5 <link rel=stylesheet href="style.css" type="text/css">
6 </head>
7
8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
9 <table border=0 width=100%>
10 <tr>
11 <td><p class=tiny>Vorbisfile documentation</p></td>
12 <td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</p></td>
13 </tr>
14 </table>
15
16 <h1>vorbis_comment</h1>
17
18 <p><i>declared in "vorbis/codec.h"</i></p>
19
20 <p>
21 The vorbis_comment structure defines an Ogg Vorbis comment.
22 <p>
23 Only the fields the program needs must be defined.  If a field isn't
24 defined by the application, it will either be blank (if it's a string value)
25 or set to some reasonable default (usually 0).
26 <p>
27
28 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
29 <tr bgcolor=#cccccc>
30         <td>
31 <pre><b>typedef struct vorbis_comment{
32   /* unlimited user comment fields. */
33   char **user_comments;
34   int  *comment_lengths;
35   int   comments;
36   char *vendor;
37
38 } vorbis_comment;</b></pre>
39         </td>
40 </tr>
41 </table>
42
43 <h3>Parameters</h3>
44 <dl>
45 <dt><i>user_comments</i></dt>
46 <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>
47 <dt><i>comment_lengths</i></dt>
48 <dd>An array that stores the length of each comment string</dd>
49 <dt><i>comments</i></dt>
50 <dd>number of user comments in user_comments field.</dd>
51 <dt><i>vendor</i></dt>
52 <dd>Information about the creator of the file.  Stored in a standard C 0-terminated string.</dd>
53 </dl>
54
55
56 <br><br>
57 <hr noshade>
58 <table border=0 width=100%>
59 <tr valign=top>
60 <td><p class=tiny>copyright &copy; 2002 Xiph.org Foundation</p></td>
61 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
62 </tr><tr>
63 <td><p class=tiny>Vorbisfile documentation</p></td>
64 <td align=right><p class=tiny>libVorbisfile version 1.65 - 20020719</p></td>
65 </tr>
66 </table>
67
68 </body>
69
70 </html>