EffectType

Available since LÖVE 11.0

This enum is not supported in earlier versions.

The different types of effects supported by love.audio.setEffect.

Constants

chorus: Plays multiple copies of the sound with slight pitch and time variation. Used to make sounds sound "fuller" or "thicker".
compressor: Decreases the dynamic range of the sound, making the loud and quiet parts closer in volume, producing a more uniform amplitude throughout time.
distortion: Alters the sound by amplifying it until it clips, shearing off parts of the signal, leading to a compressed and distorted sound.
echo: Decaying feedback based effect, on the order of seconds. Also known as delay; causes the sound to repeat at regular intervals at a decreasing volume.
equalizer: Adjust the frequency components of the sound using a 4-band (low-shelf, two band-pass and a high-shelf) equalizer.
flanger: Plays two copies of the sound; while varying the phase, or equivalently delaying one of them, by amounts on the order of milliseconds, resulting in phasing sounds.
reverb: Decaying feedback based effect, on the order of milliseconds. Used to simulate the reflection off of the surroundings.
ringmodulator: An implementation of amplitude modulation; multiplies the source signal with a simple waveform, to produce either volume changes, or inharmonic overtones.

Full documentation for the underlying API (OpenAL) can be found in this PDF file.

Parameter	Units	Range	Default
`EffectWaveform waveform`			"triangle"
`number phase`	Degrees	[-180, 180]	90
`number rate`	Hz	[0, 10]	1.1
`number depth`		[0, 1]	0.1
`number feedback`		[-1, 1]	0.25
`number delay`	Seconds	[0, 0.016]	0.016

Parameter	Units	Range	Default
`boolean enable`			true

Parameter	Units	Range	Default
`number gain`		[0.01, 1]	0.2
`number edge`		[0, 1]	0.2
`number lowcut`	Hz	[80, 24000]	8000
`number center`	Hz	[80, 24000]	3600
`number bandwidth`	Hz	[80, 24000]	3600

Parameter	Units	Range	Default
`number delay`	Seconds	[0, 0.207]	0.1
`number tapdelay`	Seconds	[0, 0.404]	0.1
`number damping`		[0, 0.99]	0.5
`number feedback`		[0, 1]	0.5
`number spread`		[-1, 1]	-1

Parameter	Units	Range	Default
`number lowgain`		[0.126, 7.943]	1
`number lowcut`	Hz	[50, 800]	200
`number lowmidgain`		[0.126, 7.943]	1
`number lowmidfrequency`	Hz	[200, 3000]	500
`number lowmidbandwidth`		[0.01, 1]	1
`number highmidgain`		[0.126, 7.943]	1
`number highmidfrequency`	Hz	[1000, 8000]	3000
`number highmidbandwidth`		[0.01, 1]	1
`number highgain`		[0.126, 7.943]	1
`number highcut`	Hz	[4000, 16000]	6000

Parameter	Units	Range	Default
`EffectWaveform waveform`			"triangle"
`number phase`	Degrees	[-180, 180]	0
`number rate`	Hz	[0, 10]	0.27
`number depth`		[0, 1]	1
`number feedback`		[-1, 1]	-.5
`number delay`	Seconds	[0, 0.004]	0.002

Parameter	Units	Range	Default
`number gain`		[0, 1]	0.32
`number highgain`		[0, 1]	0.89
`number density`		[0, 1]	1
`number diffusion`		[0, 1]	1
`number decaytime`	Seconds	[0.1, 20]	1.49
`number decayhighratio`		[0.1, 2]	0.83
`number earlygain`		[0, 3.16]	0.05
`number earlydelay`	Seconds	[0, 0.3]	0.05
`number lategain`		[0, 10]	1.26
`number latedelay`	Seconds	[0, 0.1]	0.011
`number roomrolloff`		[0, 10]	0
`number airabsorption`		[0.892, 1]	0.994
`boolean highlimit`			true

Parameter	Units	Range	Default
`EffectWaveform waveform`			"sine"
`number frequency`	Hz	[0, 8000]	440
`number highcut`	Hz	[0, 24000]	800