View source for EffectType

{{newin|[[11.0]]|110|type=enum}}
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.

== Parameters ==
Full documentation for the underlying API (OpenAL) can be found in [https://nrgcore.com/docs/manual/en-us/effects_extension_guide.pdf this PDF file].

=== chorus ===
{| class="wikitable" |-
!scope=col|Parameter!!scope=col|Units!!scope=col|Range!!scope=col|Default
|-
|'''<code>[[EffectWaveform]] waveform</code>'''|| || ||"triangle"
|-
|'''<code>[[number]] phase</code>'''||Degrees||[-180, 180]||90
|-
|'''<code>[[number]] rate</code>'''||Hz||[0, 10]||1.1
|-
|'''<code>[[number]] depth</code>'''|| ||[0, 1]||0.1
|-
|'''<code>[[number]] feedback</code>'''|| ||[-1, 1]||0.25
|-
|'''<code>[[number]] delay</code>'''||Seconds||[0, 0.016]||0.016
|}

=== compressor ===
{| class="wikitable" |-
!scope=col|Parameter!!scope=col|Units!!scope=col|Range!!scope=col|Default
|-
|'''<code>[[boolean]] enable</code>'''|| || ||true
|}

=== distortion ===
{| class="wikitable" |-
!scope=col|Parameter!!scope=col|Units!!scope=col|Range!!scope=col|Default
|-
|'''<code>[[number]] gain</code>'''|| ||[0.01, 1]||0.2
|-
|'''<code>[[number]] edge</code>'''|| ||[0, 1]||0.2
|-
|'''<code>[[number]] lowcut</code>'''||Hz||[80, 24000]||8000
|-
|'''<code>[[number]] center</code>'''||Hz||[80, 24000]||3600
|-
|'''<code>[[number]] bandwidth</code>'''||Hz||[80, 24000]||3600
|}

=== echo ===
{| class="wikitable" |-
!scope=col|Parameter!!scope=col|Units!!scope=col|Range!!scope=col|Default
|-
|'''<code>[[number]] delay</code>'''||Seconds||[0, 0.207]||0.1
|-
|'''<code>[[number]] tapdelay</code>'''||Seconds||[0, 0.404]||0.1
|-
|'''<code>[[number]] damping</code>'''|| ||[0, 0.99]||0.5
|-
|'''<code>[[number]] feedback</code>'''|| ||[0, 1]||0.5
|-
|'''<code>[[number]] spread</code>'''|| ||[-1, 1]||-1
|}

=== equalizer ===
{| class="wikitable" |-
!scope=col|Parameter!!scope=col|Units!!scope=col|Range!!scope=col|Default
|-
|'''<code>[[number]] lowgain</code>'''|| ||[0.126, 7.943]||1
|-
|'''<code>[[number]] lowcut</code>'''||Hz||[50, 800]||200
|-
|'''<code>[[number]] lowmidgain</code>'''|| ||[0.126, 7.943]||1
|-
|'''<code>[[number]] lowmidfrequency</code>'''||Hz||[200, 3000]||500
|-
|'''<code>[[number]] lowmidbandwidth</code>'''|| ||[0.01, 1]||1
|-
|'''<code>[[number]] highmidgain</code>'''|| ||[0.126, 7.943]||1
|-
|'''<code>[[number]] highmidfrequency</code>'''||Hz||[1000, 8000]||3000
|-
|'''<code>[[number]] highmidbandwidth</code>'''|| ||[0.01, 1]||1
|-
|'''<code>[[number]] highgain</code>'''|| ||[0.126, 7.943]||1
|-
|'''<code>[[number]] highcut</code>'''||Hz||[4000, 16000]||6000
|}

=== flanger ===
{| class="wikitable" |-
!scope=col|Parameter!!scope=col|Units!!scope=col|Range!!scope=col|Default
|-
|'''<code>[[EffectWaveform]] waveform</code>'''|| || ||"triangle"
|-
|'''<code>[[number]] phase</code>'''||Degrees||[-180, 180]||0
|-
|'''<code>[[number]] rate</code>'''||Hz||[0, 10]||0.27
|-
|'''<code>[[number]] depth</code>'''|| ||[0, 1]||1
|-
|'''<code>[[number]] feedback</code>'''|| ||[-1, 1]||-.5
|-
|'''<code>[[number]] delay</code>'''||Seconds||[0, 0.004]||0.002
|}

=== reverb ===
{| class="wikitable" |-
!scope=col|Parameter!!scope=col|Units!!scope=col|Range!!scope=col|Default
|-
|'''<code>[[number]] gain</code>'''|| ||[0, 1]||0.32
|-
|'''<code>[[number]] highgain</code>'''|| ||[0, 1]||0.89
|-
|'''<code>[[number]] density</code>'''|| ||[0, 1]||1
|-
|'''<code>[[number]] diffusion</code>'''|| ||[0, 1]||1
|-
|'''<code>[[number]] decaytime</code>'''||Seconds||[0.1, 20]||1.49
|-
|'''<code>[[number]] decayhighratio</code>'''|| ||[0.1, 2]||0.83
|-
|'''<code>[[number]] earlygain</code>'''|| ||[0, 3.16]||0.05
|-
|'''<code>[[number]] earlydelay</code>'''||Seconds||[0, 0.3]||0.05
|-
|'''<code>[[number]] lategain</code>'''|| ||[0, 10]||1.26
|-
|'''<code>[[number]] latedelay</code>'''||Seconds||[0, 0.1]||0.011
|-
|'''<code>[[number]] roomrolloff</code>'''|| ||[0, 10]||0
|-
|'''<code>[[number]] airabsorption</code>'''|| ||[0.892, 1]||0.994
|-
|'''<code>[[boolean]] highlimit</code>'''|| || ||true
|}

=== ringmodulator ===
{| class="wikitable" |-
!scope=col|Parameter!!scope=col|Units!!scope=col|Range!!scope=col|Default
|-
|'''<code>[[EffectWaveform]] waveform</code>'''|| || ||"sine"
|-
|'''<code>[[number]] frequency</code>'''||Hz||[0, 8000]||440
|-
|'''<code>[[number]] highcut</code>'''||Hz||[0, 24000]||800
|}

== See Also ==
* [[parent::love.audio]]
* [[love.audio.setEffect]]

== Other Languages ==
{{i18n|EffectType}}

[[Category:Enums]]
{{#set:Description=Different types of audio effects.}}