Jump to content

API Sound.GetVolume: Difference between revisions

From Flowcode Help
No edit summary
No edit summary
Line 25: Line 25:
* 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 examples</span>''

Revision as of 11:55, 16 January 2023

GetVolume
Gets the volume of playbacks for this sound in the range 0 to 1 
- HANDLE Sounds
The handle of the sound object to read 
- FLOAT Return


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)