API Sound.GetVolume: 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|GetVolume]] | :[[API Sound|GetVolume]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==Parameters== | ||
[[Variable types|HANDLE]] ''Sounds'' | |||
:The handle of the sound object to read | :The handle of the sound object to read | ||
| Line 18: | Line 19: | ||
==Detailed description== | ==Detailed description== | ||
''No additional information'' | ''<span style="color:red;">No additional information</span>'' | ||
==Examples== | ==Examples== | ||
| Line 24: | Line 26: | ||
* Declare a variable 'result' of type FLOAT | * Declare a variable 'result' of type FLOAT | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.GetVolume(sounds)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.GetVolume(sounds)</pre> | ||
''<span style="color:red;">No additional information</span>'' | |||
Revision as of 22:09, 11 May 2013
<sidebar>API contents</sidebar> Gets the volume of playbacks for this sound in the range 0 to 1
Parameters
HANDLE Sounds
- The handle of the sound object to read
Return value
Returns the volume of playbacks for this sound in the range 0 to 1
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type FLOAT
- Add to a calculation icon:
result = ::Sound.GetVolume(sounds)
No additional information