API Sound.GetVolume: Difference between revisions
XML import of updated API docs |
No edit summary |
||
| Line 23: | Line 23: | ||
==Detailed description== | ==Detailed description== | ||
The volume returned is specific to the specified handle, and affects all sounds played through this channel. | |||
Revision as of 16:24, 7 August 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
The volume returned is specific to the specified handle, and affects all sounds played through this channel.
Examples
Calling in a calculation
- Declare a variable 'result' of type FLOAT
- Add to a calculation icon:
result = ::Sound.GetVolume(sounds)
No additional examples