Effect

Get access to an Effect 's script functions with Synth.getEffect() .

const var Delay1 = Synth.getEffect("Delay1");

Class methods

addGlobalModulator

Adds a and connects a receiver modulator for the given global modulator. Edit on GitHub

Effect.addGlobalModulator(var chainIndex, var globalMod, String modName)

addModulator

Adds a modulator to the given chain and returns a reference. Edit on GitHub

Effect.addModulator(var chainIndex, var typeName, var modName)

addStaticGlobalModulator

Adds and connects a receiving static time variant modulator for the given global modulator. Edit on GitHub

Effect.addStaticGlobalModulator(var chainIndex, var timeVariantMod, String modName)

exists

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

Effect.exists()

exportScriptControls

Export the control values (without the script). Edit on GitHub

Effect.exportScriptControls()

exportState

Exports the state as base64 string. Edit on GitHub

Effect.exportState()

getAttribute

Returns the attribute with the given index. Edit on GitHub

Effect.getAttribute(int index)

getAttributeId

Returns the ID of the attribute with the given index. Edit on GitHub

Effect.getAttributeId(int index)

getAttributeIndex

Returns the index of the attribute with the given ID. Edit on GitHub

Effect.getAttributeIndex(String id)

getCurrentLevel

Returns the current peak level for the given channel. Edit on GitHub

Effect.getCurrentLevel(bool leftChannel)

getId

Returns the ID of the effect. Edit on GitHub

Effect.getId()

getModulatorChain

Returns the Modulator chain with the given index. Edit on GitHub

Effect.getModulatorChain(var chainIndex)

getNumAttributes

Returns the number of attributes. Edit on GitHub

Effect.getNumAttributes()

isBypassed

Checks if the effect is bypassed. Edit on GitHub

Effect.isBypassed()

isSuspended

Checks if the effect is currently suspended (= no audio running through it and suspension enabled). Edit on GitHub

Effect.isSuspended()

restoreScriptControls

Restores the control values for scripts (without recompiling). Edit on GitHub

Effect.restoreScriptControls(String base64Controls)

restoreState

Restores the state from a base64 string. Edit on GitHub

Effect.restoreState(String base64State)

setAttribute

Changes one of the Parameter. Look in the manual for the index numbers of each effect. Edit on GitHub

Effect.setAttribute(int parameterIndex, float newValue)

setBypassed

Bypasses the effect. Edit on GitHub

Effect.setBypassed(bool shouldBeBypassed)