Project: libvorbis
Code Location: http://svn.xiph.org/trunk/vorbis/trunk/vorbis
Browse
libvorbis/
Download File
vorbis_synthesis_read.html
<html>

<head>
<title>libvorbis - function - vorbis_synthesis_read</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_synthesis_read</h1>

<p><i>declared in "vorbis/codec.h";</i></p>

<p>This function informs the Vorbis decoder of how many
samples the application used from the last buffer output by
<a href="vorbis_synthesis_pcmout.html">vorbis_synthesis_pcmout</a>.</p>

<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
	<td>
<pre><b>
extern int      vorbis_synthesis_read(vorbis_dsp_state *v,int samples);
</b></pre>
	</td>
</tr>
</table>

<h3>Parameters</h3>
<dl>
<dt><i>v</i></dt>
<dd>The <a href="vorbis_dsp_state.html">vorbis_dsp_state</a> for the
decoder instance.</dd>
<dt><i>samples</i></dt>
<dd>The number of samples the application has used.</dd>
</dl>


<h3>Return Values</h3>
<blockquote>
<li>0 on success.</li>
<li>OV_EINVAL if <i>samples</i> is greater than the number of remaining
samples in the buffer.</li>
</blockquote>
<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>