View source for GetSoundEffectParameters

__NOTOC__ 
{{Client function}}
{{Added feature/item|1.5.9|1.5.8|20914|This function gets the parameters of a [[sound]] effect.}}

==Syntax== 
<syntaxhighlight lang="lua">table getSoundEffectParameters ( element sound, string effectName )</syntaxhighlight>
{{OOP||[[sound]]:getEffectParameters}}
===Required Arguments===
*'''sound''': The [[sound]] [[element]] to get the sound effect parameters of.
*'''effectName''': The name of the effect whose parameters you want to retrieve:
{{Sound_Effects}}
===Returns===
Returns a [[table]] with the parameter names as the keys, and their values. If the specified effect name is not valid, ''false'' is returned.
===Effects Parameters===
{{Sound_Effects_Parameters}}

==Example== 
<syntaxhighlight lang="lua">
local sound = playSound ("music.mp3")
setSoundEffectEnabled (sound, "echo", true)

local echoParams = getSoundEffectParameters (sound, "echo")
print (echoParams.feedback) -- 50
iprint (echoParams)
--[[
{
  feedback = 50,
  leftDelay = 500,
  panDelay = false,
  rightDelay = 500,
  wetDryMix = 50
}
]]
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.5.8-9.20914|}}

==See Also==
{{Audio_functions|client}}