API Sound.GetVolume

From Flowcode Help
Jump to navigationJump to search

<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

Retrieved from "https://www.matrixtsl.com/wikiv7/index.php?title=API_Sound.GetVolume&oldid=13893"