GetSoundEffectParameters

This function gets parameters of a sound effect.

Syntax

table getSoundEffectParameters ( element sound, string effectName )

OOP Syntax Help! I don't understand this!

Method: sound:getEffectParameters(...)

Required Arguments

• sound: the sound element.
• effectName: the effect name.

Returns

Returns a table with the parameter names as the keys, and their values. If the specified effect name is not valid, an error is raised.

Requirements

This template will be deleted.

Example

Click to collapse [-]

Client

local soundEchoParams = getSoundEffectParameters(sound, "echo")

See Also

• getRadioChannel
• getRadioChannelName
• getSFXStatus
• getSoundBPM
• getSoundBufferLength
• getSoundEffectParameters
• getSoundEffects
• getSoundFFTData
• getSoundLength
• getSoundLevelData
• getSoundMaxDistance
• getSoundMetaTags
• getSoundMinDistance
• getSoundPan
• getSoundPosition
• getSoundProperties
• getSoundSpeed
• getSoundVolume
• getSoundWaveData
• isSoundLooped
• isSoundPanningEnabled
• isSoundPaused
• playSFX3D
• playSFX
• playSound3D
• playSound
• setRadioChannel
• setSoundEffectEnabled
• setSoundEffectParameter
• setSoundLooped
• setSoundMaxDistance
• setSoundMinDistance
• setSoundPan
• setSoundPanningEnabled
• setSoundPaused
• setSoundPosition
• setSoundProperties
• setSoundSpeed
• setSoundVolume
• stopSound


• Shared
• playSoundFrontEnd