GetSoundProperty: Difference between revisions

From The Official Visionaire Studio: Adventure Game Engine Wiki
Created page with "<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"> <b>Command History</b> <div class="mw-collapsible-co..."
 
No edit summary
Line 17: Line 17:
Syntax:
Syntax:
<syntaxhighlight>
<syntaxhighlight>
startSound("filename", {flags=1, properties})
getSoundProperty(id, {flags=1, property})
</syntaxhighlight>
</syntaxhighlight>


Line 23: Line 23:
Example:
Example:
<syntaxhighlight>
<syntaxhighlight>
startSound("sounds/example.ogg")
-- let's store the sound.id into a variable!
-- let's store the sound.id into a variable!
local soundID = getSoundId("sounds/example.ogg")
local soundID = getSoundId("sounds/example.ogg")


-- let's store the current volume for the linked sound into a variable!
-- let's store the current volume for the linked sound into a variable!
local soundVol = getSoundProperty({flags=1, volume})
local soundVol = getSoundProperty(soundID, {flags=1, volume})


-- let's store the current audio balance for the linked sound into a variable!
-- let's store the current audio balance for the linked sound into a variable!
local soundBal = getSoundProperty({flags=1, balance})
local soundBal = getSoundProperty(soundID, {flags=1, balance})


-- let's store the current playtime of the linked sound into a variable!
-- let's store the current playtime of the linked sound into a variable!
local soundOffset = getSoundProperty({flags=1, offset})
local soundOffset = getSoundProperty(soundID, {flags=1, offset})


-- 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({flags=1, duration})
local soundDur = getSoundProperty(soundID, {flags=1, duration})


--let's store the current loop value of the linked sound into a variable!
--let's store the current loop value of the linked sound into a variable!
local soundLoop = getSoundProperty({flags=1, loop})
local soundLoop = getSoundProperty(soundID, {flags=1, loop})
</syntaxhighlight>
</syntaxhighlight>


Line 54: Line 52:
<b><u>Flags</u></b>
<b><u>Flags</u></b>


<b>properties</b>
<b>property</b>
* volume: returns the volume level of the linked sound.id as an integer value
* 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
* balance: returns the left/right audio balance of the linked sound.id as an integer value
Line 63: Line 61:


<b><u>Return</u></b>
<b><u>Return</u></b>
see flags (above)
see flags (above)
{{i18n|GetSoundProperty}} <br/>
{{i18n|GetSoundProperty}} <br/>

Revision as of 17:24, 14 March 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 & loop


Syntax:

getSoundProperty(id, {flags=1, 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, {flags=1, volume})

-- let's store the current audio balance for the linked sound into a variable!
local soundBal = getSoundProperty(soundID, {flags=1, balance})

-- let's store the current playtime of the linked sound into a variable!
local soundOffset = getSoundProperty(soundID, {flags=1, offset})

-- let's store the duration of the linked sound into a variable!
local soundDur = getSoundProperty(soundID, {flags=1, duration})

--let's store the current loop value of the linked sound into a variable!
local soundLoop = getSoundProperty(soundID, {flags=1, loop})


Arguments

id: integer (number)
The id for the currently playing audio file! ("sound.id")


Flags

property

  • 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)
  • loop: returns a boolean value of true or false depending on if linked sound.id is set to loop or not


Return

see flags (above)


Relevant Pages: getSoundId - setSoundProperty - startSound - stopSound - toggleSoundPause