Difference between revisions of "API Sound.GetVolume"

From Flowcode Help
Jump to navigationJump to search
(XML import of updated API docs)
Line 23: Line 23:
  
 
==Detailed description==
 
==Detailed description==
''<span style="color:red;">No additional information</span>''
+
The volume returned is specific to the specified handle, and affects all sounds played through this channel.
  
  

Revision as of 16:24, 7 August 2013


<sidebar>API contents</sidebar> Gets the volume of playbacks for this sound in the range 0 to 1

Class hierarchy

Sound

GetVolume

Parameters

HANDLE Sounds

The handle of the sound object to read


Return value

FLOAT

Returns the volume of playbacks for this sound in the range 0 to 1


Detailed description

The volume returned is specific to the specified handle, and affects all sounds played through this channel.


Examples

Calling in a calculation

  • Declare a variable 'result' of type FLOAT
  • Add to a calculation icon:
    result = ::Sound.GetVolume(sounds)

No additional examples