<td>This function takes a <a href="vorbis_info.html">vorbis_info</a> struct and encoding parameters and sets up a proper encoding environment.</tt></a>.</td>
</tr>\r
<tr valign=top>
+<td><a href="vorbis_encode_init_vbr.html">vorbis_encode_init_vbr</a></td>
+<td>This function takes a <a href="vorbis_info.html">vorbis_info</a> struct
+and encoding parameters for VBR encoding.</td>
+</tr>
+<tr valign=top>
<td><a href="vorbis_encode_ctl.html">vorbis_encode_ctl</a></td>
<td>Function in progress, to be used in future versions of this API.</td>
</tr>
--- /dev/null
+<html>
+
+<head>
+<title>libvorbisenc - function - vorbis_encode_init_vbr</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 - 20011218</p></td>
+</tr>
+</table>
+
+<h1>vorbis_encode_init_vbr</h1>
+
+<p><i>declared in "vorbis/libvorbisenc.h";</i></p>
+
+<p>This is the primary function within libvorbisenc. This is used to properly set up an encoding environment using libvorbisenc.\r
+<p>Before this function is called, the <a href="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_vbr(<a href="vorbis_info.html">vorbis_info</a> *vi,\r
+ long channels,\r
+ long rate,\r
+ \r
+ float base_quality /* from 0. (lo) to 1. (hi) */);\r
+
+</b></pre>
+ </td>
+</tr>
+</table>
+
+<h3>Parameters</h3>
+<dl>
+<dt><i>vi</i></dt>
+<dd>File pointer to an initialized <a href="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>base_quality</i></dt>
+<dd>Desired quality level from 0.0 to 1.0 (lo to hi).</dd>
+</dl>
+
+
+<h3>Return Values</h3>
+<blockquote>
+<li>
+0 for success</li>
+
+<li>less than zero for failure:</li>\r
+<ul>\r
+<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
+</ul>\r
+</blockquote>
+<p>
+
+<br><br>
+<hr noshade>
+<table border=0 width=100%>
+<tr valign=top>
+<td><p class=tiny>copyright © 2000 xiph.org</p></td>
+<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
+</tr><tr>
+<td><p class=tiny>libvorbisenc documentation</p></td>
+<td align=right><p class=tiny>libvorbisenc version 1.1.2.2 - 20001106</p></td>
+</tr>
+</table>
+
+
+</body>
+
+</html>
projects / platform / upstream / libvorbis.git / commitdiff