API Sound.GetVolume: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
Gets the volume of playbacks for this sound in the range 0 to 1 | Gets the volume of playbacks for this sound in the range 0 to 1 | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:Sound | |||
::GetVolume | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|HANDLE]] Sounds'' | ''[[Variable types|HANDLE]] Sounds'' | ||
:The handle of the sound object to read | :The handle of the sound object to read | ||
==Return value== | |||
[[Variable types|FLOAT]] | [[Variable types|FLOAT]] | ||
Returns the volume of playbacks for this sound in the range 0 to 1 | Returns the volume of playbacks for this sound in the range 0 to 1 | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==Examples== | |||
===Calling in a calculation=== | |||
* Declare a variable 'result' of type FLOAT | * Declare a variable 'result' of type FLOAT | ||
* Add to a calculation icon: <pre class="brush:[ | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.GetVolume(sounds)</pre> | ||
Revision as of 16:48, 11 May 2013
<sidebar>API contents</sidebar> Gets the volume of playbacks for this sound in the range 0 to 1
Class hierarchy
- Sound
- GetVolume
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)