annotate src/libvorbis-1.3.3/doc/libvorbis/vorbis_comment_add.html @ 1:05aa0afa9217

Bring in flac, ogg, vorbis
author Chris Cannam
date Tue, 19 Mar 2013 17:37:49 +0000
parents
children
rev   line source
Chris@1 1 <html>
Chris@1 2
Chris@1 3 <head>
Chris@1 4 <title>libvorbis - function - vorbis_comment_add</title>
Chris@1 5 <link rel=stylesheet href="style.css" type="text/css">
Chris@1 6 </head>
Chris@1 7
Chris@1 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
Chris@1 9 <table border=0 width=100%>
Chris@1 10 <tr>
Chris@1 11 <td><p class=tiny>libvorbis documentation</p></td>
Chris@1 12 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
Chris@1 13 </tr>
Chris@1 14 </table>
Chris@1 15
Chris@1 16 <h1>vorbis_comment_add</h1>
Chris@1 17
Chris@1 18 <p><i>declared in "vorbis/codec.h";</i></p>
Chris@1 19
Chris@1 20 <p>This function adds a raw comment string to a
Chris@1 21 <a href="vorbis_comment.html">vorbis_comment</a> structure.</p>
Chris@1 22
Chris@1 23 <p>This function should be used if the string is already in the
Chris@1 24 form "KEY=value". If you have a separate key and value, use
Chris@1 25 <a href="vorbis_comment_add_tag.html">vorbis_comment_add_tag</a>
Chris@1 26 instead.</p>
Chris@1 27
Chris@1 28 <table border=0 color=black cellspacing=0 cellpadding=7>
Chris@1 29 <tr bgcolor=#cccccc>
Chris@1 30 <td>
Chris@1 31 <pre><b>
Chris@1 32 extern void vorbis_comment_add(vorbis_comment *vc, const char *comment);
Chris@1 33 </b></pre>
Chris@1 34 </td>
Chris@1 35 </tr>
Chris@1 36 </table>
Chris@1 37
Chris@1 38 <h3>Parameters</h3>
Chris@1 39 <dl>
Chris@1 40 <dt><i>vc</i></dt>
Chris@1 41 <dd>Pointer to a vorbis_comment structure to add the comment to.</dd>
Chris@1 42 <dt><i>comment</i></dt>
Chris@1 43 <dd>Pointer to the null-terminated raw comment string. The string will
Chris@1 44 be copied, so it can be freed or modified after this function returns
Chris@1 45 without affecting the vorbis_comment structure's contents.</dd>
Chris@1 46 </dl>
Chris@1 47
Chris@1 48
Chris@1 49 <h3>Return Values</h3>
Chris@1 50 <blockquote>
Chris@1 51 <li>None.</li>
Chris@1 52 </blockquote>
Chris@1 53 <p>
Chris@1 54
Chris@1 55 <br><br>
Chris@1 56 <hr noshade>
Chris@1 57 <table border=0 width=100%>
Chris@1 58 <tr valign=top>
Chris@1 59 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
Chris@1 60 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
Chris@1 61 </tr><tr>
Chris@1 62 <td><p class=tiny>libvorbis documentation</p></td>
Chris@1 63 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
Chris@1 64 </tr>
Chris@1 65 </table>
Chris@1 66
Chris@1 67
Chris@1 68 </body>
Chris@1 69
Chris@1 70 </html>