File: setSoundVolume.html

package info (click to toggle)
sludge 2.2.2-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,852 kB
  • sloc: cpp: 32,432; sh: 1,237; makefile: 634; xml: 284
file content (62 lines) | stat: -rwxr-xr-x 1,474 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>setSoundVolume</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>setSoundVolume</h2>
<HR>

<H3>Syntax:</H3>

<P>
<pre class="syntax">setSoundVolume (<i>soundFile, newVolume</i>);</pre>
</P>

<H3>Purpose:</H3>

<P>
Changes the volume of any occurrences of the sampled sound <i>soundFile</i> which are currently playing. The volume of each occurrence is set to <i>newVolume</i>, which should be a number from 0 (silence) to 255 (full).
</P>

<P>
This function cannot be used to change the volume of track-based music files. For that, use the <a href="setMusicVolume.html">setMusicVolume</a> function.
</P>

<H3>Return value:</H3>

<P>
No return value.
</P>

<H3>See also:</H3>

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

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

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

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

<P>
<a href="stopSound.html">stopSound</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>