1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="Microsoft FrontPage 5.0">
7<META http-equiv="Content-Style-Type" content="text/css">
8<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
9<title>THPSimpleSetVolume</title>
10</head>
11
12<body>
13
14<h1>THPSimpleSetVolume</h1>
15
16<h2>C Specification</h2>
17
18<dl>
19<dd><pre><code>#include &quot;THPSimple.h&quot;</code></pre>
20  </dd>
21<dd><pre><CODE>BOOL THPSimpleSetVolume(s32 vol, s32 time);</CODE></pre>
22  </dd>
23</dl>
24
25<h2>Arguments</h2>
26<table border="1" cellpadding="3" cellspacing="0.1">
27  <tr>
28<td width="120" bgcolor="#ffffe8"><strong><em><CODE>vol</CODE></em></strong></td>
29<td width="520">The new volume value.</td>
30  </tr>
31  <tr>
32<td width="120" bgcolor="#ffffe8"><CODE><strong><em>time</em></strong></CODE></td>
33<td width="520">Time to transition from the current volume to the new volume (in msec).</td>
34  </tr>
35</table>
36
37<h2>Return Values</h2>
38<p>Returns <CODE>TRUE</CODE> if successful; <CODE>FALSE</CODE> otherwise.</p>
39
40<H2>Description</H2>
41<p>This function sets the THP audio data's playback volume.
42</p>
43
44<p>The simple player changes the volume of the THP audio player from the current value to the value specified by <code>vol</code>, and takes the amount of time specified by <CODE>time</CODE>. <code>vol</code> takes values in a range from 0 to 127. <code>time</code> is in milliseconds in a range from 0 to 60,000. </p>
45
46<p>Be aware that when the <a href="THPSimpleOpen.html"><code>THPSimpleOpen</code> function</a> is called, volume is initialized to 127.</p>
47
48
49<H2>See Also</H2>
50<P><a href="THPSimpleOpen.html"><code>THPSimpleOpen</code></a></P>
51
52<H2>Revision History</H2>
53<P>03/01/2006 Initial version.</P>
54</body>
55</html>