Difference between revisions of "API Sound.SetVolume"

From Flowcode Help
Jump to navigationJump to search
(XML import of updated API docs)
Line 24: Line 24:
  
 
==Detailed description==
 
==Detailed description==
''<span style="color:red;">No additional information</span>''
+
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.
  
  

Revision as of 19:22, 4 August 2013


<sidebar>API contents</sidebar> Sets the volume of playbacks for this sound

Class hierarchy

Sound

SetVolume

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