Difference between revisions of "API Sound.GetVolume"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
(15 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | <sidebar>API Contents</sidebar> | |
− | + | Gets the volume of playbacks for this sound in the range 0 to 1 | |
− | + | <div style="width:25%; float:right" class="toc"> | |
− | + | ====Class hierarchy==== | |
+ | [[API Sound|Sound]] | ||
+ | :[[API Sound|GetVolume]] | ||
+ | </div> | ||
+ | __TOC__ | ||
− | + | ==Parameters== | |
− | + | [[Variable Types|HANDLE]] ''Sounds'' | |
:The handle of the sound object to read | :The handle of the sound object to read | ||
− | + | ||
− | [[Variable | + | ==Return value== |
+ | [[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 | ||
− | |||
− | |||
− | ===Examples | + | ==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 | * Declare a variable 'result' of type FLOAT | ||
− | * Add to a calculation icon: result = ::Sound.GetVolume(sounds) | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.GetVolume(sounds)</pre> |
+ | |||
+ | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets the volume of playbacks for this sound in the range 0 to 1
Contents
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