vorbis_commentheader_out.html 1.5 KB

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