doc/libvorbis/vorbis_synthesis_read.html

   1 <html>
   2
   3 <head>
   4 <title>libvorbis - function - vorbis_synthesis_read</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_read</h1>
  17
  18 <p><i>declared in "vorbis/codec.h";</i></p>
  19
  20 <p>This function informs the Vorbis decoder of how many
  21 samples the application used from the last buffer output by
  22 <a href="vorbis_synthesis_pcmout.html">vorbis_synthesis_pcmout</a>.</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_synthesis_read(vorbis_dsp_state *v,int samples);
  29 </b></pre>
  30         </td>
  31 </tr>
  32 </table>
  33
  34 <h3>Parameters</h3>
  35 <dl>
  36 <dt><i>v</i></dt>
  37 <dd>The <a href="vorbis_dsp_state.html">vorbis_dsp_state</a> for the
  38 decoder instance.</dd>
  39 <dt><i>samples</i></dt>
  40 <dd>The number of samples the application has used.</dd>
  41 </dl>
  42
  43
  44 <h3>Return Values</h3>
  45 <blockquote>
  46 <li>0 on success.</li>
  47 <li>OV_EINVAL if <i>samples</i> is greater than the number of remaining
  48 samples in the buffer.</li>
  49 </blockquote>
  50 <p>
  51
  52 <br><br>
  53 <hr noshade>
  54 <table border=0 width=100%>
  55 <tr valign=top>
  56 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
  57 <td align=right><p class=tiny><a href="https://xiph.org/vorbis/index.html">Ogg Vorbis</a></p></td>
  58 </tr><tr>
  59 <td><p class=tiny>libvorbis documentation</p></td>
  60 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  61 </tr>
  62 </table>
  63
  64
  65 </body>
  66
  67 </html>