summaryrefslogtreecommitdiffhomepage
path: root/contrib/vorbis/doc/libvorbis/vorbis_synthesis_halfrate.html
blob: fefe8d3545a3a3f3b633718d987a009e47d6efb6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<html>

<head>
<title>libvorbis - function - vorbis_synthesis_halfrate</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>libvorbis documentation</p></td>
<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
</tr>
</table>

<h1>vorbis_synthesis_halfrate</h1>

<p><i>declared in "vorbis/codec.h";</i></p>

<p>This function puts the Vorbis decoder into or out of half-rate
mode. In half-rate mode, the audio is decoded to only half its original
sampling rate. Half-rate mode speeds up decoding at the expense of
decoded audio quality.</p>

<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
	<td>
<pre><b>
extern int      vorbis_synthesis_halfrate(vorbis_info *v,int flag);
</b></pre>
	</td>
</tr>
</table>

<h3>Parameters</h3>
<dl>
<dt><i>v</i></dt>
<dd>The <a href="vorbis_info.html">vorbis_info</a> structure for the
decoder instance.</dd>
<dt><i>flag</i></dt>
<dd>Whether half-rate mode is to be turned on or off. Zero turns it off;
nonzero turns it on.</dd>
</dl>


<h3>Return Values</h3>
<blockquote>
<li>0 on success.</li>
<li>-1 if half-rate mode could not be set.</li>
</blockquote>
<p>

<br><br>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
<td><p class=tiny>copyright &copy; 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>libvorbis documentation</p></td>
<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
</tr>
</table>


</body>

</html>