Difference between revisions of "API Sound.GetVolume"

From Flowcode Help
Jump to navigationJump to search
(XML import API changes)
(XML Import to change Variable types into Variable Types)
Line 10: Line 10:
  
 
==Parameters==
 
==Parameters==
[[Variable types|HANDLE]] ''Sounds''
+
[[Variable Types|HANDLE]] ''Sounds''
 
:The handle of the sound object to read
 
:The handle of the sound object to read
  
  
 
==Return value==
 
==Return value==
[[Variable types|FLOAT]]
+
[[Variable Types|FLOAT]]
  
 
Returns the volume of playbacks for this sound in the range 0 to 1
 
Returns the volume of playbacks for this sound in the range 0 to 1

Revision as of 11:09, 10 June 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

No additional information


Examples

Calling in a calculation

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

No additional information