Difference between revisions of "API Sound.SetVolume"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <sidebar>API Contents</sidebar> | |
| − | + | Sets the volume of playbacks for this sound | |
| − | + | <div style="width:25%; float:right" class="toc"> | |
| − | + | ====Class hierarchy==== | |
| + | [[API Sound|Sound]] | ||
| + | :[[API Sound|SetVolume]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|HANDLE]] ''Sounds'' | |
:The handle of the sound object to set the volume for | :The handle of the sound object to set the volume for | ||
| − | + | [[Variable Types|FLOAT]] ''Volume'' | |
:A value from 0=off to 1=full | :A value from 0=off to 1=full | ||
| − | + | ||
| + | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
| − | |||
| − | |||
| − | ===Examples | + | ==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. | |
| − | * Add to a calculation icon: ::Sound.SetVolume(sounds, volume) | + | |
| + | |||
| + | ==Examples== | ||
| + | ===Calling in a calculation=== | ||
| + | * 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 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Sets the volume of playbacks for this sound
Contents
Parameters
HANDLE Sounds
- The handle of the sound object to set the volume for
FLOAT Volume
- A value from 0=off to 1=full
Return value
This call does not return a value
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)
No additional examples
