doc/libvorbis/vorbis_analysis_wrote.html

   1 <html>
   2
   3 <head>
   4 <title>libvorbis - function - vorbis_analysis_wrote</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_analysis_wrote</h1>
  17
  18 <p><i>declared in "vorbis/codec.h";</i></p>
  19
  20 <p>This function tells the encoder new data is available for compression.
  21 Call this after writing new audio into the buffer array returned by
  22 vorbis_analysis_buffer().
  23 </p>
  24
  25 <p>
  26 Call with the <i>vals</i> parameter set to zero to signal the end
  27 of the input data.
  28 </p>
  29
  30 <table border=0 color=black cellspacing=0 cellpadding=7>
  31 <tr bgcolor=#cccccc>
  32         <td>
  33 <pre><b>
  34 extern int      vorbis_analysis_wrote(vorbis_dsp_state *v,int vals);
  35 </b></pre>
  36         </td>
  37 </tr>
  38 </table>
  39
  40 <h3>Parameters</h3>
  41 <dl>
  42 <dt><i>v</i></dt>
  43 <dd>Pointer to the vorbis_dsp_state representing the encoder.</dd>
  44 <dt><i>vals</i></dt>
  45 <dd>Number of samples successfully written. This must be less than
  46 or equal to the value passed to vorbis_analysis_buffer(). A value
  47 of zero means all input data has been provided and the compressed
  48 stream should be finalized.</dd>
  49 </dl>
  50
  51
  52 <h3>Return Values</h3>
  53 <ul>
  54 <li>0 for success</li>
  55 <li>negative values for failure:
  56 <ul>
  57 <li>OV_EINVAL - Invalid request; e.g. vals overflows the allocated space.</li>
  58 <li>OV_EFAULT - Internal fault; indicates a bug or memory corruption.</li>
  59 <li>OV_EIMPL - Unimplemented; not supported by this version of the library.</li>
  60 </ul>
  61 </li>
  62 </ul>
  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>