soundvolume(
IDENTIFIER
)
The soundvolume( function returns the current volume of the specified playing sound.
Parameters
This function has one parameter:
identifier – identifier for the sound (sound must already be playing).
Description
This function returns the current volume of the specified playing sound. The volume may range from 0 (completely muted) to 1 (full volume, as specified by the system volume control). For example, 0.5 is half of full volume.
Note: The volume can be set by the playsound statement and adjusted by the controlsound statement.
See Also
- controlsound -- controls playback of a sound file.
- info("sounds") -- returns a carriage return delimited list of all currently playing sounds.
- playsound -- starts playing a sound file.
- soundduration( -- returns the duration (in seconds) of the specified playing sound.
- sounddurationhhmmss( -- returns the duration (in hours:minutes:seconds) of the specified playing sound.
- soundinfo( -- returns a dictionary that contains all of the properties of a sound.
- soundplaying( -- returns true if the specified sound is currently playing, false if it is paused or not playing at all.
- soundposition( -- returns the current playback position (in seconds) of the specified playing sound.
- soundpositionhhmmss( -- returns the current playback position (in hours:minutes:seconds) of the specified playing sound.
- soundprogress( -- returns the progress of the played sound from 0 to 1.
- soundstatus( -- returns the status of the specified sound: stopped, playing or paused.
History
| 10.2 | New | New in this version. |