diff options
Diffstat (limited to 'contrib/vorbis/doc/vorbisenc/vorbis_encode_setup_managed.html')
-rw-r--r-- | contrib/vorbis/doc/vorbisenc/vorbis_encode_setup_managed.html | 102 |
1 files changed, 0 insertions, 102 deletions
diff --git a/contrib/vorbis/doc/vorbisenc/vorbis_encode_setup_managed.html b/contrib/vorbis/doc/vorbisenc/vorbis_encode_setup_managed.html deleted file mode 100644 index 0389dde..0000000 --- a/contrib/vorbis/doc/vorbisenc/vorbis_encode_setup_managed.html +++ /dev/null @@ -1,102 +0,0 @@ -<html> - -<head> -<title>libvorbisenc - function - vorbis_encode_setup_managed</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_managed</h1> - -<p><i>declared in "vorbis/vorbisenc.h";</i></p> - -<p>This function performs step-one of a three-step bitrate-managed -encode setup. It functions similarly to the one-step setup performed -by <a href="vorbis_encode_init.html">vorbis_encode_init()</a> but -allows an application to make further encode setup tweaks using <a -href="vorbis_encode_ctl.html">vorbis_encode_ctl()</a> before finally -calling <a -href="vorbis_encode_setup_init.html">vorbis_encode_setup_init()</a> to -complete the setup process. - -<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. After encoding, -vorbis_info_clear should be called. - -<p>The max_bitrate, nominal_bitrate, and min_bitrate settings are used -to set constraints for the encoded file. This function uses these -settings to select the appropriate encoding mode and set it up. -<p> -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -extern int vorbis_encode_init(<a href="../libvorbis/vorbis_info.html">vorbis_info</a> *vi, - long channels, - long rate, - - long max_bitrate, - long nominal_bitrate, - long min_bitrate); - -</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> -<dt><i>channels</i></dt> -<dd>The number of channels to be encoded.</dd> -<dt><i>rate</i></dt> -<dd>The sampling rate of the source audio.</dd> -<dt><i>max_bitrate</i></dt> -<dd>Desired maximum bitrate (limit). -1 indicates unset.</dd> -<dt><i>nominal_bitrate</i></dt> -<dd>Desired average, or central, bitrate. -1 indicates unset.</dd> -<dt><i>min_bitrate</i></dt> -<dd>Desired minimum bitrate. -1 indicates unset.</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 - Invalid setup request, eg, out of range argument. </li> -<li>OV_EIMPL - Unimplemented mode; unable to comply with bitrate request.</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> |