etlegacy-libs/vorbis/doc/libvorbis/vorbis_analysis_wrote.html

81 lines
2 KiB
HTML
Raw Normal View History

2013-01-24 15:44:19 +00:00
<html>
<head>
<title>libvorbis - function - vorbis_analysis_wrote</title>
<link rel=stylesheet href="style.css" type="text/css">
</head>
<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
<table border=0 width=100%>
<tr>
<td><p class=tiny>libvorbis documentation</p></td>
<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
</tr>
</table>
<h1>vorbis_analysis_wrote</h1>
<p><i>declared in "vorbis/codec.h";</i></p>
<p>This function tells the encoder new data is available for compression.
Call this after writing new audio into the buffer array returned by
vorbis_analysis_buffer().
</p>
<p>
Call with the <i>vals</i> parameter set to zero to signal the end
of the input data.
</p>
<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
<td>
<pre><b>
extern int vorbis_analysis_wrote(vorbis_dsp_state *v,int vals);
</b></pre>
</td>
</tr>
</table>
<h3>Parameters</h3>
<dl>
<dt><i>v</i></dt>
<dd>Pointer to the vorbis_dsp_state representing the encoder.</dd>
<dt><i>vals</i></dt>
<dd>Number of samples successfully written. This must be less than
or equal to the value passed to vorbis_analysis_buffer(). A value
of zero means all input data has been provided and the compressed
stream should be finalized.</dd>
</dl>
<h3>Return Values</h3>
<ul>
<li>0 for success</li>
<li>negative values for failure:
<ul>
<li>OV_EINVAL - Invalid request; e.g. vals overflows the allocated space.</li>
<li>OV_EFAULT - Internal fault; indicates a bug or memory corruption.</li>
<li>OV_EIMPL - Unimplemented; not supported by this version of the library.</li>
</ul>
</li>
</ul>
<p>
<br><br>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
<td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>libvorbis documentation</p></td>
<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
</tr>
</table>
</body>
</html>