SoundChannel:setEffect

Available since: Gideros 2022.6
Class: SoundChannel

Description

Sets effects on a sound channel.

SoundChannel:setEffect(effect,params)

Available effects are:

• "equalizer"
• "biquad"

Available parameters for equalizer are:

• AL_EQUALIZER_LOW_GAIN 0x0001
• AL_EQUALIZER_LOW_CUTOFF 0x0002
• AL_EQUALIZER_MID1_GAIN 0x0003
• AL_EQUALIZER_MID1_CENTER 0x0004
• AL_EQUALIZER_MID1_WIDTH 0x0005
• AL_EQUALIZER_MID2_GAIN 0x0006
• AL_EQUALIZER_MID2_CENTER 0x0007
• AL_EQUALIZER_MID2_WIDTH 0x0008
• AL_EQUALIZER_HIGH_GAIN 0x0009
• AL_EQUALIZER_HIGH_CUTOFF 0x000A

Parameters

effect: (String) the effect to set new values to
params: (number) the new values of the effect

Example

local sndcoin = Sound.new("audio/sfx/sfx_coin_double1.wav")
local channel = sndcoin:play()
-- audioChannel:setEffect("equalizer",{ equalizer settings })
channel:setEffect("equalizer", {AL_EQUALIZER_HIGH_GAIN, 10})
--  audioChannel:setEffect("biquad",{ biquad coefficients })
channel:setEffect("biquad", {2,1,12})

---

• SoundChannel

• SoundChannel:getPitch
• SoundChannel:getPosition
• SoundChannel:getStreamId
• SoundChannel:getVolume
• SoundChannel:isLooping
• SoundChannel:isPaused
• SoundChannel:isPlaying
• SoundChannel:setEffect
• SoundChannel:setLooping
• SoundChannel:setPaused
• SoundChannel:setPitch
• SoundChannel:setPosition
• SoundChannel:setVolume
• SoundChannel:setWorldPosition
• SoundChannel:stop

• SoundChannel Event.COMPLETE

---

---

• Main Page
• Lua API
• Main API
• Plugins