1 files changed, 80 insertions, 0 deletions
diff --git a/doc/libvorbis/vorbis_synthesis_headerin.html b/doc/libvorbis/vorbis_synthesis_headerin.html
new file mode 100644
index 0000000..835d8ce
--- /dev/null
+++ b/doc/libvorbis/vorbis_synthesis_headerin.html
@@ -0,0 +1,80 @@
+<html>
+
+<head>
+<title>libvorbis - function - vorbis_synthesis_headerin</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_headerin</h1>
+
+<p><i>declared in "vorbis/codec.h";</i></p>
+
+<p>This function decodes a header packet from a Vorbis stream and applies
+the contents to the given <a href="vorbis_info.html">vorbis_info</a>
+structure (to provide codec parameters to the decoder) and
+<a href="vorbis_comment.html">vorbis_comment</a> structure (to provide
+access to the embedded Vorbis comments).</p>
+
+<p>Once the three Vorbis header packets (info, comments,
+and codebooks, in that order) have been passed to this
+function, the <a href="vorbis_info.html">vorbis_info</a>
+structure is ready to be used in a call to
+<a href="vorbis_synthesis_init.html">vorbis_synthesis_init</a>.</p>
+
+<table border=0 color=black cellspacing=0 cellpadding=7>
+<tr bgcolor=#cccccc>
+	<td>
+<pre><b>
+extern int      vorbis_synthesis_headerin(vorbis_info *vi,vorbis_comment *vc,
+                                          ogg_packet *op);
+</b></pre>
+	</td>
+</tr>
+</table>
+
+<h3>Parameters</h3>
+<dl>
+<dt><i>vi</i></dt>
+<dd>The <a href="vorbis_info.html">vorbis_info</a> structure to apply
+the decoded information to.</dd>
+<dt><i>vc</i></dt>
+<dd>The <a href="vorbis_comment.html">vorbis_comment</a> structure to
+apply the decoded comments to.</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_ENOTVORBIS if the packet is not a Vorbis header packet.</li>
+<li>OV_EBADHEADER if there was an error interpreting the packet.</li>
+<li>OV_EFAULT on internal error.</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>