Difference between revisions of "API Sound.GetVolume"

From Flowcode Help
Jump to navigationJump to search
(XML import of updated API docs)
(XML import)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
+
<sidebar>API Contents</sidebar>
 
 
<sidebar>API contents</sidebar>
 
 
Gets the volume of playbacks for this sound in the range 0 to 1
 
Gets the volume of playbacks for this sound in the range 0 to 1
  
Line 23: Line 21:
  
 
==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.
  
  

Latest revision as of 15:57, 16 January 2014

<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