HISE Docs

SlotFX



Class methods

clear

Clears the slot (loads a unity gain module).

SlotFX.clear()



exists

Checks if the Object exists and prints a error message on the console if not.

SlotFX.exists()



getCurrentEffect

Returns a reference to the currently loaded effect.

SlotFX.getCurrentEffect()



getCurrentEffectId

Returns the ID of the effect that is currently loaded.

SlotFX.getCurrentEffectId()



getModuleList

Returns the list of all available modules that you can load into the slot (might be empty if there is no compiled dll present).

SlotFX.getModuleList()



getParameterProperties

Returns a JSON object containing all parameters with their range properties.

SlotFX.getParameterProperties()



setBypassed

Bypasses the effect. This uses the soft bypass feature of the SlotFX module.

SlotFX.setBypassed(bool shouldBeBypassed)



setEffect

Loads the effect with the given name and returns a reference to it.

SlotFX.setEffect(String effectName)



swap

Swaps the effect with the other slot.

SlotFX.swap(var otherSlot)