GetSoundProperty (CMS)

From The Official Visionaire Studio: Adventure Game Engine Wiki

Function 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("vispath: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")

-- let's print the sound properties to the log
print("volume=" .. soundVol .. ", balance=" .. soundBal .. ", offset=" .. soundOffset .. ", duration=" .. soundDur .. ", is playing=" .. soundPlaying .. ", is paused=" .. soundPaused .. ", is looping=" .. soundLoop)


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


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