Difference between revisions of "API Sound.SetVolume"

From Flowcode Help
Jump to navigationJump to search
 
Line 29: Line 29:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Sound.SetVolume(sounds, volume)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Sound.SetVolume(sounds, volume)</pre>
 
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png SetVolume
Sets the volume of playbacks for this sound 
Fc9-h32-icon.png - HANDLE Sounds
The handle of the sound object to set the volume for 
Fc9-f32-icon.png - FLOAT Volume
A value from 0=off to 1=full 
Fc9-void-icon.png - NONE Return


Detailed description

This sets the volume for all sounds played through the given channel. The effects are instant - a sound part way through being played will have its volume affected, as will any sounds being queued.


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Sound.SetVolume(sounds, volume)