00001 <html>
00002
00003 <head>
00004 <title>libvorbisenc - function - vorbis_encode_init_vbr</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>libvorbisenc documentation</p></td>
00012 <td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
00013 </tr>
00014 </table>
00015
00016 <h1>vorbis_encode_init_vbr</h1>
00017
00018 <p><i>declared in "vorbis/libvorbisenc.h";</i></p>
00019
00020 <p>This is the primary function within libvorbisenc for setting up variable bitrate ("quality" based) modes.
00021 <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.
00022 <p>
00023 <br><br>
00024 <table border=0 color=black cellspacing=0 cellpadding=7>
00025 <tr bgcolor=#cccccc>
00026 <td>
00027 <pre><b>
00028 extern int vorbis_encode_init_vbr(<a href="vorbis_info.html">vorbis_info</a> *vi,
00029 long channels,
00030 long rate,
00031
00032 float base_quality);
00033
00034 </b></pre>
00035 </td>
00036 </tr>
00037 </table>
00038
00039 <h3>Parameters</h3>
00040 <dl>
00041 <dt><i>vi</i></dt>
00042 <dd>File pointer to an initialized <a href="vorbis_info.html">vorbis_info</a> struct.</dd>
00043 <dt><i>channels</i></dt>
00044 <dd>The number of channels to be encoded.</dd>
00045 <dt><i>rate</i></dt>
00046 <dd>The sampling rate of the source audio.</dd>
00047 <dt><i>base_quality</i></dt>
00048 <dd>Desired quality level, currently from -0.1 to 1.0 (lo to hi).</dd>
00049 </dl>
00050
00051
00052 <h3>Return Values</h3>
00053 <blockquote>
00054 <li>
00055 0 for success</li>
00056
00057 <li>less than zero for failure:</li>
00058 <ul>
00059 <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
00060 <li>OV_EINVAL - Invalid setup request, eg, out of range argument. </li>
00061 <li>OV_EIMPL - Unimplemented mode; unable to comply with quality level request.</li>
00062 </ul>
00063 </blockquote>
00064 <p>
00065
00066 <br><br>
00067 <hr noshade>
00068 <table border=0 width=100%>
00069 <tr valign=top>
00070 <td><p class=tiny>copyright © 2004 xiph.org</p></td>
00071 <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>
00072 </tr><tr>
00073 <td><p class=tiny>libvorbisenc documentation</p></td>
00074 <td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
00075 </tr>
00076 </table>
00077
00078
00079 </body>
00080
00081 </html>
