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="IBM WebSphere Studio Homepage Builder Version 6.5.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
9<title>THPPlayerSetVolume</title>
10</head>
11
12<body>
13
14<h1>THPPlayerSetVolume</h1>
15<h2>C Specification</h2>
16
17<dl>
18<dd><pre><code>#include &quot;THPPlayer.h&quot;</code></pre>
19  </dd>
20<dd><pre><CODE>BOOL THPPlayerSetVolume(s32 vol, s32 time);</CODE></pre>
21  </dd>
22</dl>
23
24<h2>Arguments</h2>
25<table border="1" cellpadding="3" cellspacing="0.1">
26  <tr>
27<td width="120" bgcolor="#ffffe8"><strong><em><FONT face="Courier New">vol</FONT></em></strong></td>
28<td width="520">New volume value.</td>
29  </tr>
30  <tr>
31<td width="120" bgcolor="#ffffe8"><strong><em><FONT face="Courier New">time</FONT></em></strong></td>
32<td width="520">Time to transition from the current volume to the new volume (in msec).</td>
33  </tr>
34</table>
35
36<h2>Return Values</h2>
37<p>Returns <CODE>TRUE</CODE> if successful; <CODE>FALSE</CODE> otherwise.</p>
38
39<H2>Description</H2>
40<p>This function sets the playback volume of the THP audio data. </p>
41
42<p>The player changes the playback volume of the THP audio player in <STRONG><EM><code>time</code></EM></STRONG> msec from the current value to the value that <STRONG><EM><code>vol</code></EM></STRONG> specifies. 0 through 127 can be specified for <code><STRONG><EM>vol</EM></STRONG></code>. <code><EM><STRONG>time</STRONG></EM></code> is in units of msec and range from 0 to 60000. </p>
43
44<p>When the <a href="THPPlayerOpen.html"><code>THPPlayerOpen</code> function</a> is called, the volume is initialized to 127. </p>
45
46
47<H2>See Also</H2>
48<P><a href="THPPlayerOpen.html"><code>THPPlayerOpen</code></a></P>
49
50<H2>Revision History</H2>
51<P>03/01/2006 Initial version.</P>
52
53</body>
54</html>
55