doc/libvorbis/vorbis_synthesis.html

   1 <html>
   2
   3 <head>
   4 <title>libvorbis - function - vorbis_synthesis</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</h1>
  17
  18 <p><i>declared in "vorbis/codec.h";</i></p>
  19
  20 <p>This function decodes a Vorbis packet into a block of data. The
  21 <a href="vorbis_block.html">vorbis_block</a> should then be submitted
  22 to the <a href="vorbis_dsp_state.html">vorbis_dsp_state</a>
  23 for the decoder instance using
  24 <a href="vorbis_synthesis_blockin.html">vorbis_synthesis_blockin</a>
  25 to be assembled into the final decoded audio.</p>
  26
  27 <table border=0 color=black cellspacing=0 cellpadding=7>
  28 <tr bgcolor=#cccccc>
  29         <td>
  30 <pre><b>
  31 extern int      vorbis_synthesis(vorbis_block *vb,ogg_packet *op);
  32 </b></pre>
  33         </td>
  34 </tr>
  35 </table>
  36
  37 <h3>Parameters</h3>
  38 <dl>
  39 <dt><i>vb</i></dt>
  40 <dd>The <a href="vorbis_block.html">vorbis_block</a> to decode the
  41 packet into.</dd>
  42 <dt><i>op</i></dt>
  43 <dd>The ogg_packet to decode.</dd>
  44 </dl>
  45
  46
  47 <h3>Return Values</h3>
  48 <blockquote>
  49 <li>0 on success.</li>
  50 <li>OV_ENOTAUDIO if the packet is not an audio packet.</li>
  51 <li>OV_EBADPACKET if there was an error in the packet.</li>
  52 </blockquote>
  53 <p>
  54
  55 <br><br>
  56 <hr noshade>
  57 <table border=0 width=100%>
  58 <tr valign=top>
  59 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
  60 <td align=right><p class=tiny><a href="https://xiph.org/vorbis/">Ogg Vorbis</a></p></td>
  61 </tr><tr>
  62 <td><p class=tiny>libvorbis documentation</p></td>
  63 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  64 </tr>
  65 </table>
  66
  67
  68 </body>
  69
  70 </html>