File: setMusicVolume.html

package info (click to toggle)
sludge 2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 6,820 kB
  • sloc: cpp: 31,960; sh: 1,037; xml: 874; makefile: 672
file content (68 lines) | stat: -rwxr-xr-x 1,527 bytes parent folder | download | duplicates (7)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>setMusicVolume</TITLE>
  <link rel="stylesheet" type="text/css" href="style.css" />
</head>
<BODY>
<HR>
<div align="center"><img id="headerGraphic" src="images/sludge300.png" alt="SLUDGE"/></div>
<h2>setMusicVolume</h2>
<HR>

<H3>Syntax:</H3>

<P>
<pre class="syntax">setMusicVolume (<i>volume, channel)</i>;</pre>
</P>

<H3>Purpose:</H3>

<P>
Changes the volume level for the specified <i>channel</i> of music. If there is no music currently playing on the specified channel the code will have no effect. The <i>volume</i> parameter must be a number between 0 and 255 inclusive, and changes take effect immediately.
</P>

<H3>Return value:</H3>

<P>
No return value.
</P>

<H3>Example:</H3>

<P>
<pre>setDefaultMusicVolume (200);
startMusic ('mytune.xm', 0);

# Starts music playing on channel 0 at volume 200

pause (100);
setMusicVolume (50, 0);

# Music on channel 0 is now playing at volume 50</pre>
</P>

<H3>See also:</H3>

<P>
<a href="Using_Audio_in_SLUDGE.html">Using Audio in SLUDGE</a>
</P>

<P>
<a href="setDefaultMusicVolume.html">setDefaultMusicVolume</a>
</P>

<P>
<a href="startMusic.html">startMusic</a>
</P>

<P>
<a href="stopMusic.html">stopMusic</a>
</P>

<P class="copyright-notice">SLUDGE and this SLUDGE documentation are <A HREF="Copyright.html">copyright</A> Hungry Software and contributors 2000-2012
</P>

<HR>
</BODY>
</html>