diff options
| author | Aki <please@ignore.pl> | 2021-09-29 22:52:49 +0200 |
|---|---|---|
| committer | Aki <please@ignore.pl> | 2021-09-29 22:52:49 +0200 |
| commit | 74f4b1bc3b627ba4c7e03498234d88cacdfbe97b (patch) | |
| tree | 197b5978d6e38f44069ea92583098a1da04aa635 /doc/vorbisenc/vorbis_encode_setup_init.html | |
| download | starshatter-74f4b1bc3b627ba4c7e03498234d88cacdfbe97b.zip starshatter-74f4b1bc3b627ba4c7e03498234d88cacdfbe97b.tar.gz starshatter-74f4b1bc3b627ba4c7e03498234d88cacdfbe97b.tar.bz2 | |
Squashed 'vorbis/' content from commit d22c3ab5f
git-subtree-dir: vorbis
git-subtree-split: d22c3ab5f633460abc2532feee60ca0892134cbf
Diffstat (limited to 'doc/vorbisenc/vorbis_encode_setup_init.html')
| -rw-r--r-- | doc/vorbisenc/vorbis_encode_setup_init.html | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/doc/vorbisenc/vorbis_encode_setup_init.html b/doc/vorbisenc/vorbis_encode_setup_init.html new file mode 100644 index 0000000..aa2c904 --- /dev/null +++ b/doc/vorbisenc/vorbis_encode_setup_init.html @@ -0,0 +1,88 @@ +<html> + +<head> +<title>libvorbisenc - function - vorbis_encode_setup_init</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>libvorbisenc documentation</p></td> +<td align=right><p class=tiny>libvorbisenc version 1.3.2 - 20101101</p></td> +</tr> +</table> + +<h1>vorbis_encode_setup_init</h1> + +<p><i>declared in "vorbis/vorbisenc.h";</i></p> + +<p>This function performs the last stage of three-step encoding setup, as described in the API overview under <a href="overview.html#BBR">managed bitrate modes</a>. + +<p>Before this function is called, the <a +href="../libvorbis/vorbis_info.html">vorbis_info</a> struct should be initialized +by using vorbis_info_init() from the libvorbis API, one of <a +href="vorbis_encode_setup_managed.html">vorbis_encode_setup_managed()</a> +or <a +href="vorbis_encode_setup_vbr.html">vorbis_encode_setup_vbr()</a> +called to initialize the high-level encoding setup, and <a +href="vorbis_encode_ctl.html">vorbis_encode_ctl()</a> called if +necessary to make encoding setup changes. vorbis_encode_setup_init() +finalizes the highlevel encoding structure into a complete encoding +setup after which the application may make no further setup changes.<p> + +After encoding, vorbis_info_clear should be called. +<p> +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +extern int vorbis_encode_setup_init(<a href="../libvorbis/vorbis_info.html">vorbis_info</a> *vi); + +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>vi</i></dt> +<dd>Pointer to an initialized <a href="../libvorbis/vorbis_info.html">vorbis_info</a> struct.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +0 for success</li> + +<li>less than zero for failure:</li> +<ul> +<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li> +<li>OV_EINVAL - Attempt to use vorbis_encode_setup_init() without first calling one of <a +href="vorbis_encode_setup_managed.html">vorbis_encode_setup_managed()</a> +or <a +href="vorbis_encode_setup_vbr.html">vorbis_encode_setup_vbr()</a> +to initialize the high-level encoding setup +</li> +</ul> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000-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>libvorbisenc documentation</p></td> +<td align=right><p class=tiny>libvorbisenc version 1.3.2 - 20101101</p></td> +</tr> +</table> + + +</body> + +</html> |