doc/libvorbis/vorbis_synthesis_headerin.html

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