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
16<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &quot;THPPlayer.h&quot;
19
20BOOL THPPlayerSetVolume(s32 vol, s32 time);
21</pre></dd></dl>
22
23<h2>Arguments</h2>
24<TABLE class="arguments" border="1" >
25  <tr>
26<th>vol</th>
27<td>New volume value.</td>
28  </tr>
29  <tr>
30<th><code><EM><STRONG>time</STRONG></EM></code></th>
31<td>Time to transition from the current volume to the new volume. (msec)</td>
32  </tr>
33</table>
34
35<h2>Return Values</h2>
36<p>Returns <code>TRUE</code> if successful, <code>FALSE</code> otherwise.</p>
37
38<H2>Description</H2>
39<p>The <code>THPPlayerSetVolume</code> function sets the THP audio data's playback volume. </p>
40
41<p>The player changes the volume of the THP audio player from the present volume to the volume specified by <SPAN class="argument">vol</SPAN>, taking the amount of time specified by <SPAN class="argument">time</SPAN>. Values from 0 through 127 can be specified for <SPAN class="argument">vol</SPAN>. <SPAN class="argument">time</SPAN> is specified in milliseconds in the range from 0 to 60,000.</p>
42
43<p>Note that when the <a href="THPPlayerOpen.html"><code>THPPlayerOpen</code></a> function is called, the volume value is initialized to 127.</p>
44
45<H2>See Also</H2>
46<P class="reference">
47<a href="THPPlayerOpen.html">THPPlayerOpen</a>
48</P>
49
50<H2>Revision History</H2>
51<P>
522006/03/01 Initial version.<br>
53</P>
54
55<hr><p>CONFIDENTIAL</p></body>
56</html>
57