HISE Docs

SlotFX

The SlotFX class gives you access to the Effect Slot FX, with which you can swap effects in a programmatic way.

const var EffectSlot1 = Synth.getSlotFX("Effect Slot1");


Class methods

clear

Clears the slot (loads a unity gain module). Edit on GitHub

SlotFX.clear()



exists

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

SlotFX.exists()



getCurrentEffect

Returns a reference to the currently loaded effect. Edit on GitHub

SlotFX.getCurrentEffect()



getCurrentEffectId

Returns the ID of the effect that is currently loaded. Edit on GitHub

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). Edit on GitHub

SlotFX.getModuleList()



getParameterProperties

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

SlotFX.getParameterProperties()



setBypassed

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

SlotFX.setBypassed(bool shouldBeBypassed)



setEffect

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

SlotFX.setEffect(String effectName)



swap

Swaps the effect with the other slot. Edit on GitHub

SlotFX.swap(var otherSlot)