love.audio.setEffect

Available since LÖVE 11.0

This function is not supported in earlier versions.

Defines an effect that can be applied to a Source.

Function

Synopsis

love.audio.setEffect(name, settings)

Arguments

string name

The name of the effect.

table settings

The settings to use for this effect, with the following fields:

string type

The type of effect to use.

number volume

The volume of the effect.

number ...

Effect-specific settings (listed below).

Returns

boolean success

Whether the effect was successfully created.

Function

Synopsis

love.audio.setEffect(name, enabled)

Arguments

string name

The name of the effect.

boolean enabled (true)

If false and the given effect name was previously set, disables the effect.

Returns

boolean success

Whether the effect was successfully disabled.

Available effects and corresponding settings

reverb

number gain

number highgain

number density

number diffusion

number decaytime

number decayhighratio

number earlygain

number earlydelay

number lategain

number latedelay

number roomrolloff

number airabsorption

number highlimit

chorus

string waveform

number phase

number rate

number depth

number feedback

number delay

distortion

number gain

number edge

number lowcut

number center

number bandwidth

echo

number delay

number tapdelay

number damping

number feedback

number spread

flanger

string waveform

number phase

number rate

number depth

number feedback

number delay

ringmodulator

string waveform

number frequency

number highcut

compressor

boolean enable

equalizer

number lowgain

number lowcut

number lowmidgain

number lowmidfrequency

number lowmidbandwidth

number highmidgain

number highmidfrequency

number highmidbandwidth

number highgain

number highcut

Examples

Playing music with added reverb

love.audio.setEffect('myEffect', {type = 'reverb'})
local source = love.audio.newSource('music.ogg', 'stream')
source:setEffect('myEffect')
source:play()

Playing music with distortion

love.audio.setEffect('myEffect', {
	type = 'distortion',
	gain = .5,
	edge = .25,
})
local source = love.audio.newSource('music.ogg', 'stream')
source:setEffect('myEffect')
source:play()

See Also

• love.audio
• Source:setEffect