summaryrefslogtreecommitdiffhomepage
path: root/contrib/vorbis/doc/libvorbis/vorbis_synthesis.html
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/vorbis/doc/libvorbis/vorbis_synthesis.html')
-rw-r--r--contrib/vorbis/doc/libvorbis/vorbis_synthesis.html70
1 files changed, 70 insertions, 0 deletions
diff --git a/contrib/vorbis/doc/libvorbis/vorbis_synthesis.html b/contrib/vorbis/doc/libvorbis/vorbis_synthesis.html
new file mode 100644
index 0000000..38ac4ed
--- /dev/null
+++ b/contrib/vorbis/doc/libvorbis/vorbis_synthesis.html
@@ -0,0 +1,70 @@
+<html>
+
+<head>
+<title>libvorbis - function - vorbis_synthesis</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</h1>
+
+<p><i>declared in "vorbis/codec.h";</i></p>
+
+<p>This function decodes a Vorbis packet into a block of data. The
+<a href="vorbis_block.html">vorbis_block</a> should then be submitted
+to the <a href="vorbis_dsp_state.html">vorbis_dsp_state</a>
+for the decoder instance using
+<a href="vorbis_synthesis_blockin.html">vorbis_synthesis_blockin</a>
+to be assembled into the final decoded audio.</p>
+
+<table border=0 color=black cellspacing=0 cellpadding=7>
+<tr bgcolor=#cccccc>
+ <td>
+<pre><b>
+extern int vorbis_synthesis(vorbis_block *vb,ogg_packet *op);
+</b></pre>
+ </td>
+</tr>
+</table>
+
+<h3>Parameters</h3>
+<dl>
+<dt><i>vb</i></dt>
+<dd>The <a href="vorbis_block.html">vorbis_block</a> to decode the
+packet into.</dd>
+<dt><i>op</i></dt>
+<dd>The ogg_packet to decode.</dd>
+</dl>
+
+
+<h3>Return Values</h3>
+<blockquote>
+<li>0 on success.</li>
+<li>OV_ENOTAUDIO if the packet is not an audio packet.</li>
+<li>OV_EBADPACKET if there was an error in the packet.</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>