Source:setEffect

Available since LÖVE 11.0
This function is not supported in earlier versions.

Applies an audio effect to the Source.

The effect must have been previously defined using love.audio.setEffect.

Function

Applies the given previously defined effect to this Source.

Synopsis

success = Source:setEffect( name, enable )

Arguments

string name
The name of the effect previously set up with love.audio.setEffect.
boolean enable (true)
If false and the given effect name was previously enabled on this Source, disables the effect.

Returns

boolean success
Whether the effect was successfully applied to this Source.

Function

Applies the given previously defined effect to this Source, and applies a filter to the Source which affects the sound fed into the effect.

Synopsis

success = Source:setEffect( name, filtersettings )

Arguments

string name
The name of the effect previously set up with love.audio.setEffect.
table filtersettings
The filter settings to apply prior to the effect, with the following fields:
FilterType type
The type of filter to use.
number volume
The overall volume of the audio. Must be between 0 and 1.
number highgain
Volume of high-frequency audio. Only applies to low-pass and band-pass filters. Must be between 0 and 1.
number lowgain
Volume of low-frequency audio. Only applies to high-pass and band-pass filters. Must be between 0 and 1.

Returns

boolean success
Whether the effect and filter were successfully applied to this Source.

Notes

Audio effect functionality is not supported on iOS.

See Also

© 2006–2020 LÖVE Development Team
Licensed under the GNU Free Documentation License, Version 1.3.
https://love2d.org/wiki/Source:setEffect