Difference between revisions of "GetSoundProperty"
From The Official Visionaire Studio: Adventure Game Engine Wiki
| Line 11: | Line 11: | ||
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
<div>Properties currently available: | <div>Properties currently available: | ||
| − | <pre>volume, balance, offset, duration, paused & loop</pre></div> | + | <pre>volume, balance, offset, duration, playing, paused & loop</pre></div> |
</div></div> | </div></div> | ||
| Line 37: | Line 37: | ||
-- let's store the duration of the linked sound into a variable! | -- let's store the duration of the linked sound into a variable! | ||
local soundDur = getSoundProperty(soundID, "duration") | local soundDur = getSoundProperty(soundID, "duration") | ||
| + | |||
| + | --let's check if the linked sound is playing & store the result into a variable! | ||
| + | local soundPlaying = getSoundProperty(soundID, "playing") | ||
--let's check if the linked sound is paused & store the result into a variable! | --let's check if the linked sound is paused & store the result into a variable! | ||
| Line 57: | Line 60: | ||
* offset: returns current playing time of the linked sound.id as an integer value (ms) | * offset: returns current playing time of the linked sound.id as an integer value (ms) | ||
* duration: returns duration of the linked sound.id as an integer value (ms) | * duration: returns duration of the linked sound.id as an integer value (ms) | ||
| + | * playing: returns a boolean value of true or false depending on if linked sound is playing or paused | ||
* paused: returns a boolean value of true or false depending on if linked sound is paused or playing | * paused: returns a boolean value of true or false depending on if linked sound is paused or playing | ||
* loop: returns a boolean value of true or false depending on if linked sound.id is set to loop or not | * loop: returns a boolean value of true or false depending on if linked sound.id is set to loop or not | ||
Revision as of 23:33, 3 April 2013
Command History
Available since v3.8
Allows you to obtain various property values for the linked sound ID.
Additional Info
Properties currently available:
volume, balance, offset, duration, playing, paused & loop
Syntax:
getSoundProperty(id, "property")
Example:
-- let's store the sound.id into a variable!
local soundID = getSoundId("sounds/example.ogg")
-- let's store the current volume for the linked sound into a variable!
local soundVol = getSoundProperty(soundID, "volume")
-- let's store the current audio balance for the linked sound into a variable!
local soundBal = getSoundProperty(soundID, "balance")
-- let's store the current playtime of the linked sound into a variable!
local soundOffset = getSoundProperty(soundID, "offset")
-- let's store the duration of the linked sound into a variable!
local soundDur = getSoundProperty(soundID, "duration")
--let's check if the linked sound is playing & store the result into a variable!
local soundPlaying = getSoundProperty(soundID, "playing")
--let's check if the linked sound is paused & store the result into a variable!
local soundPaused = getSoundProperty(soundID, "paused")
--let's check if the linked sound is looping & store the result into a variable!
local soundLoop = getSoundProperty(soundID, "loop")
Arguments
id: integer (number)
The id for the currently playing audio file! ("sound.id")
property: "string"
- volume: returns the volume level of the linked sound.id as an integer value
- balance: returns the left/right audio balance of the linked sound.id as an integer value
- offset: returns current playing time of the linked sound.id as an integer value (ms)
- duration: returns duration of the linked sound.id as an integer value (ms)
- playing: returns a boolean value of true or false depending on if linked sound is playing or paused
- paused: returns a boolean value of true or false depending on if linked sound is paused or playing
- loop: returns a boolean value of true or false depending on if linked sound.id is set to loop or not
Flags
none
Return
property
The requested property value
|
日本語 – 正體中文 – 한국어 – Dansk – Deutsch – English – Español – Français – Italiano – Nederlands – Polski – Português – Svenska – Русский |
| Relevant Pages: getSoundId - setSoundProperty - startSound - stopSound - toggleSoundPause |
