vorbis/doc/libvorbis/vorbis_synthesis_halfrate.html

   1 <html>
   2
   3 <head>
   4 <title>libvorbis - function - vorbis_synthesis_halfrate</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>libvorbis documentation</p></td>
  12 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>vorbis_synthesis_halfrate</h1>
  17
  18 <p><i>declared in "vorbis/codec.h";</i></p>
  19
  20 <p>This function puts the Vorbis decoder into or out of half-rate
  21 mode. In half-rate mode, the audio is decoded to only half its original
  22 sampling rate. Half-rate mode speeds up decoding at the expense of
  23 decoded audio quality.</p>
  24
  25 <table border=0 color=black cellspacing=0 cellpadding=7>
  26 <tr bgcolor=#cccccc>
  27         <td>
  28 <pre><b>
  29 extern int      vorbis_synthesis_halfrate(vorbis_info *v,int flag);
  30 </b></pre>
  31         </td>
  32 </tr>
  33 </table>
  34
  35 <h3>Parameters</h3>
  36 <dl>
  37 <dt><i>v</i></dt>
  38 <dd>The <a href="vorbis_info.html">vorbis_info</a> structure for the
  39 decoder instance.</dd>
  40 <dt><i>flag</i></dt>
  41 <dd>Whether half-rate mode is to be turned on or off. Zero turns it off;
  42 nonzero turns it on.</dd>
  43 </dl>
  44
  45
  46 <h3>Return Values</h3>
  47 <blockquote>
  48 <li>0 on success.</li>
  49 <li>-1 if half-rate mode could not be set.</li>
  50 </blockquote>
  51 <p>
  52
  53 <br><br>
  54 <hr noshade>
  55 <table border=0 width=100%>
  56 <tr valign=top>
  57 <td><p class=tiny>copyright &copy; 2010 Xiph.Org</p></td>
  58 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a></p></td>
  59 </tr><tr>
  60 <td><p class=tiny>libvorbis documentation</p></td>
  61 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  62 </tr>
  63 </table>
  64
  65
  66 </body>
  67
  68 </html>