API Sound.SetVolume: Difference between revisions
XML import |
XML import |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
===Class hierarchy===[[API Sound|Sound]] | ====Class hierarchy==== | ||
[[API Sound|Sound]] | |||
:[[API Sound|SetVolume]] | :[[API Sound|SetVolume]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==Parameters== | ||
[[Variable types|HANDLE]] ''Sounds'' | |||
:The handle of the sound object to set the volume for | :The handle of the sound object to set the volume for | ||
[[Variable types|FLOAT]] ''Volume'' | |||
:A value from 0=off to 1=full | :A value from 0=off to 1=full | ||
| Line 19: | Line 20: | ||
==Detailed description== | ==Detailed description== | ||
''No additional information'' | ''<span style="color:red;">No additional information</span>'' | ||
==Examples== | ==Examples== | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::Sound.SetVolume(sounds, volume)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Sound.SetVolume(sounds, volume)</pre> | ||
''<span style="color:red;">No additional information</span>'' | |||
Revision as of 22:09, 11 May 2013
<sidebar>API contents</sidebar> Sets the volume of playbacks for this sound
Parameters
HANDLE Sounds
- The handle of the sound object to set the volume for
FLOAT Volume
- A value from 0=off to 1=full
Return value
This call does not return a value
Detailed description
No additional information
Examples
Calling in a calculation
- Add to a calculation icon:
::Sound.SetVolume(sounds, volume)
No additional information