Difference between revisions of "API Sound.SetVolume"
From Flowcode Help
Jump to navigationJump to search (XML import of updated API docs) |
|||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | + | |- | |
| − | + | | 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 | |
| − | === | + | |- |
| − | [[ | + | |- |
| − | : | + | | 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 | |
| − | == | + | |- |
| − | [[ | + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT |
| − | + | | width="90%" | Volume | |
| − | + | |- | |
| − | [[ | + | | colspan="2" | A value from 0=off to 1=full |
| − | + | |- | |
| − | + | | 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'' | |
| − | == | + | |} |
| − | '' | ||
==Detailed description== | ==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. | |
| Line 30: | 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> | ||
| − | |||
| − | |||
Latest revision as of 11:55, 16 January 2023
|
SetVolume |
| Sets the volume of playbacks for this sound | |
 - HANDLE
|
Sounds |
| The handle of the sound object to set the volume for | |
 - FLOAT
|
Volume |
| A value from 0=off to 1=full | |
 - 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)
