mirror of
https://github.com/etlegacy/etlegacy-libs.git
synced 2024-11-12 23:54:31 +00:00
83 lines
2.6 KiB
HTML
83 lines
2.6 KiB
HTML
<html>
|
|
|
|
<head>
|
|
<title>libvorbis - function - vorbis_analysis_headerout</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_headerout</h1>
|
|
|
|
<p><i>declared in "vorbis/codec.h";</i></p>
|
|
|
|
<p>This function creates and returns the three header packets needed
|
|
to configure a decoder to accept compressed data. I should be called
|
|
after all encoder initialization and configuration is complete. The
|
|
output packets should be placed in order at the start of the compressed
|
|
vorbis stream, prior to the first data packet.
|
|
</p>
|
|
|
|
<table border=0 color=black cellspacing=0 cellpadding=7>
|
|
<tr bgcolor=#cccccc>
|
|
<td>
|
|
<pre><b>
|
|
extern int vorbis_analysis_headerout(vorbis_dsp_state *v,
|
|
vorbis_comment *vc,
|
|
ogg_packet *op,
|
|
ogg_packet *op_comm,
|
|
ogg_packet *op_code);
|
|
</b></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Parameters</h3>
|
|
<dl>
|
|
<dt><i>v</i></dt>
|
|
<dd>Pointer to an initialized vorbis_dsp_state which holds the encoder configuration.</dd>
|
|
<dt><i>vc</i></dt>
|
|
<dd>Pointer to an initialized vorbis_comment structure which holds the metadata associated with the stream being encoded.</dd>
|
|
<dt><i>op</i></dt>
|
|
<dd>Pointer to an ogg_packet structure to be filled out with the stream identification header.</dd>
|
|
<dt><i>op_comm</i></dt>
|
|
<dd>Pointer to an ogg_packet structure to be filled out with the serialied vorbis_comment data.</dd>
|
|
<dt><i>op_code</i></dt>
|
|
<dd>Pointer to an ogg_packet structure to be filled out with the codebooks, mode descriptions, etc. which will be used encoding the stream.</dd>
|
|
</dl>
|
|
|
|
|
|
<h3>Return Values</h3>
|
|
<ul>
|
|
<li>0 for success</li>
|
|
<li>negative values for failure:
|
|
<ul>
|
|
<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 © 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>
|