libvorbis-1.0.1/doc/vorbisenc/overview.html

   1 <html>
   2
   3 <head>
   4 <title>libvorbisenc - API Overview</title>
   5 <link rel=stylesheet href="style.css" type="text/css">
   6 </head>
   7
   8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
   9 <table border=0 width=100%>
  10 <tr>
  11 <td><p class=tiny>libvorbisenc documentation</p></td>
  12 <td align=right><p class=tiny>libvorbisenc version 1.1.2.2 - 20001104</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>Libvorbisenc API Overview</h1>
  17
  18 <p>The current version of libvorbisenc is very simple.  It contains an initialization function to set up the encoding engine properly.
  19 It also contains a control function to be used in the future to tweak encoder settings.
  20 <p>
  21 All the <b>libvorbisenc</b> routines are declared in "vorbis/vorbisenc.h".
  22
  23 <p>
  24 <table border=1 color=black width=50% cellspacing=0 cellpadding=7>
  25 <tr bgcolor=#cccccc>
  26         <td><b>function</b></td>
  27         <td><b>purpose</b></td>
  28 </tr>
  29 <tr valign=top>
  30         <td><a href="vorbis_encode_init.html">vorbis_encode_init</a></td>
  31         <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>
  32 </tr>
  33 <tr valign=top>
  34 <td><a href="vorbis_encode_init_vbr.html">vorbis_encode_init_vbr</a></td>
  35 <td>This function takes a <a href="vorbis_info.html">vorbis_info</a> struct
  36 and encoding parameters for VBR encoding.</td>
  37 </tr>
  38 <tr valign=top>
  39         <td><a href="vorbis_encode_ctl.html">vorbis_encode_ctl</a></td>
  40         <td>Function in progress, to be used in future versions of this API.</td>
  41 </tr>
  42 </table>
  43
  44 <br><br>
  45 <hr noshade>
  46 <table border=0 width=100%>
  47 <tr valign=top>
  48 <td><p class=tiny>copyright &copy; 2000 vorbis team</p></td>
  49 <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>
  50 </tr><tr>
  51 <td><p class=tiny>vorbisfile documentation</p></td>
  52 <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  53 </tr>
  54 </table>
  55
  56 </body>
  57
  58 </html>