annotate src/libvorbis-1.3.3/doc/libvorbis/vorbis_comment_init.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_init</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_init</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 initializes a <a href="vorbis_comment.html">vorbis_comment</a>
Chris@1 21 structure for use. After calling this function, the vorbis_comment
Chris@1 22 structure contains no comments.</p>
Chris@1 23
Chris@1 24 <p><i>Note:</i> No internal storage is allocated by this function;
Chris@1 25 internal storage is allocated as needed by other libvorbis functions that
Chris@1 26 modify the vorbis_comment structure. If you modify the vorbis_comment
Chris@1 27 structure directly, without using libvorbis, you should <i>not</i>
Chris@1 28 call <a href="vorbis_comment_clear.html">vorbis_comment_clear</a> when
Chris@1 29 you are finished but instead clean up after it yourself. See the note
Chris@1 30 on the <a href="vorbis_comment_clear.html">vorbis_comment_clear</a>
Chris@1 31 page for more information.</p>
Chris@1 32
Chris@1 33 <table border=0 color=black cellspacing=0 cellpadding=7>
Chris@1 34 <tr bgcolor=#cccccc>
Chris@1 35 <td>
Chris@1 36 <pre><b>
Chris@1 37 extern void vorbis_comment_init(vorbis_comment *vc);
Chris@1 38 </b></pre>
Chris@1 39 </td>
Chris@1 40 </tr>
Chris@1 41 </table>
Chris@1 42
Chris@1 43 <h3>Parameters</h3>
Chris@1 44 <dl>
Chris@1 45 <dt><i>vc</i></dt>
Chris@1 46 <dd>Pointer to the <a href="vorbis_comment.html">vorbis_comment</a>
Chris@1 47 structure to initialize.</dd>
Chris@1 48 </dl>
Chris@1 49
Chris@1 50
Chris@1 51 <h3>Return Values</h3>
Chris@1 52 <blockquote>
Chris@1 53 <li>None.</li>
Chris@1 54 </blockquote>
Chris@1 55 <p>
Chris@1 56
Chris@1 57 <br><br>
Chris@1 58 <hr noshade>
Chris@1 59 <table border=0 width=100%>
Chris@1 60 <tr valign=top>
Chris@1 61 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
Chris@1 62 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
Chris@1 63 </tr><tr>
Chris@1 64 <td><p class=tiny>libvorbis documentation</p></td>
Chris@1 65 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
Chris@1 66 </tr>
Chris@1 67 </table>
Chris@1 68
Chris@1 69
Chris@1 70 </body>
Chris@1 71
Chris@1 72 </html>