Difference between revisions of "API Sound.SetVolume"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Sets the volume of playbacks for this sound
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetVolume'''
 +
|-
 +
| colspan="2" | Sets the volume of playbacks for this sound&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Sounds
 +
|-
 +
| colspan="2" | The handle of the sound object to set the volume for&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Volume
 +
|-
 +
| colspan="2" | A value from 0=off to 1=full&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
===Parameters===
+
==Detailed description==
−
''[[Variable types|HANDLE]] Sounds''
+
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.
−
:The handle of the sound object to set the volume for
 
  
−
''[[Variable types|FLOAT]] Volume''
 
−
:A value from 0=off to 1=full
 
  
−
===Return value===
+
==Examples==
−
''This call does not return a value''
+
===Calling in a calculation===
−
 
+
* Add to a calculation icon: <pre class="brush:[cpp]">::Sound.SetVolume(sounds, volume)</pre>
−
===Detailed description===
 
−
''No additional information''
 
−
 
 
−
===Examples===
 
−
====Calling in a calculation====
 
−
* Add to a calculation icon: <pre class="brush:[C]">::Sound.SetVolume(sounds, volume)</pre>
 

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)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Sound.SetVolume&oldid=30240"