vorbis/doc/libvorbis/vorbis_commentheader_out.html

   1 <html>
   2
   3 <head>
   4 <title>libvorbis - function - vorbis_commentheader_out</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>libvorbis documentation</p></td>
  12 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>vorbis_commentheader_out</h1>
  17
  18 <p><i>declared in "vorbis/codec.h";</i></p>
  19
  20 <p>This function encodes the contents of a
  21 <a href="vorbis_comment.html">vorbis_comment</a> structure into an
  22 ogg_packet.</p>
  23
  24 <table border=0 color=black cellspacing=0 cellpadding=7>
  25 <tr bgcolor=#cccccc>
  26         <td>
  27 <pre><b>
  28 extern int      vorbis_commentheader_out(vorbis_comment *vc, ogg_packet *op);
  29 </b></pre>
  30         </td>
  31 </tr>
  32 </table>
  33
  34 <h3>Parameters</h3>
  35 <dl>
  36 <dt><i>vc</i></dt>
  37 <dd>The vorbis_comment structure to encode.</dd>
  38 <dt><i>op</i></dt>
  39 <dd>The ogg_packet to place the encoded comment packet into.</dd>
  40 </dl>
  41
  42
  43 <h3>Return Values</h3>
  44 <blockquote>
  45 <li>0 on success.</li>
  46 <li>OV_EIMPL on error.</li>
  47 </blockquote>
  48 <p>
  49
  50 <br><br>
  51 <hr noshade>
  52 <table border=0 width=100%>
  53 <tr valign=top>
  54 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
  55 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
  56 </tr><tr>
  57 <td><p class=tiny>libvorbis documentation</p></td>
  58 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  59 </tr>
  60 </table>
  61
  62
  63 </body>
  64
  65 </html>