Difference between revisions of "API Sound.SetVolume"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen)  | 
				 (XML import)  | 
				||
| Line 2: | Line 2: | ||
Sets the volume of playbacks for this sound  | Sets the volume of playbacks for this sound  | ||
| + | <div style="width:25%; float:right" class="toc">  | ||
| + | ===Class hierarchy===  | ||
| + | :Sound  | ||
| + | ::SetVolume  | ||
| + | </div>  | ||
| + | __TOC__  | ||
| − | + | ==Parameters==  | |
''[[Variable types|HANDLE]] Sounds''  | ''[[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  | ||
| Line 10: | Line 16: | ||
: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''  | ||
| − | + | ==Detailed description==  | |
''No additional information''  | ''No additional information''  | ||
| − | + | ==Examples==  | |
| − | + | ===Calling in a calculation===  | |
| − | * Add to a calculation icon: <pre class="brush:[  | + | * Add to a calculation icon: <pre class="brush:[cpp]">::Sound.SetVolume(sounds, volume)</pre>  | 
Revision as of 16:48, 11 May 2013
<sidebar>API contents</sidebar> Sets the volume of playbacks for this sound
Class hierarchy
- Sound
- SetVolume
 
 
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
No additional information
Examples
Calling in a calculation
- Add to a calculation icon: 
::Sound.SetVolume(sounds, volume)