vorbis_synthesis_headerin.html 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. <html>
  2. <head>
  3. <title>libvorbis - function - vorbis_synthesis_headerin</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_synthesis_headerin</h1>
  14. <p><i>declared in "vorbis/codec.h";</i></p>
  15. <p>This function decodes a header packet from a Vorbis stream and applies
  16. the contents to the given <a href="vorbis_info.html">vorbis_info</a>
  17. structure (to provide codec parameters to the decoder) and
  18. <a href="vorbis_comment.html">vorbis_comment</a> structure (to provide
  19. access to the embedded Vorbis comments).</p>
  20. <p>Once the three Vorbis header packets (info, comments,
  21. and codebooks, in that order) have been passed to this
  22. function, the <a href="vorbis_info.html">vorbis_info</a>
  23. structure is ready to be used in a call to
  24. <a href="vorbis_synthesis_init.html">vorbis_synthesis_init</a>.</p>
  25. <table border=0 color=black cellspacing=0 cellpadding=7>
  26. <tr bgcolor=#cccccc>
  27. <td>
  28. <pre><b>
  29. extern int vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc,
  30. ogg_packet *op);
  31. </b></pre>
  32. </td>
  33. </tr>
  34. </table>
  35. <h3>Parameters</h3>
  36. <dl>
  37. <dt><i>vi</i></dt>
  38. <dd>The <a href="vorbis_info.html">vorbis_info</a> structure to apply
  39. the decoded information to.</dd>
  40. <dt><i>vc</i></dt>
  41. <dd>The <a href="vorbis_comment.html">vorbis_comment</a> structure to
  42. apply the decoded comments to.</dd>
  43. <dt><i>op</i></dt>
  44. <dd>The ogg_packet to decode.</dd>
  45. </dl>
  46. <h3>Return Values</h3>
  47. <blockquote>
  48. <li>0 on success.</li>
  49. <li>OV_ENOTVORBIS if the packet is not a Vorbis header packet.</li>
  50. <li>OV_EBADHEADER if there was an error interpreting the packet.</li>
  51. <li>OV_EFAULT on internal error.</li>
  52. </blockquote>
  53. <p>
  54. <br><br>
  55. <hr noshade>
  56. <table border=0 width=100%>
  57. <tr valign=top>
  58. <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
  59. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
  60. </tr><tr>
  61. <td><p class=tiny>libvorbis documentation</p></td>
  62. <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  63. </tr>
  64. </table>
  65. </body>
  66. </html>