Effect
Class methods
addGlobalModulator
Adds a and connects a receiver modulator for the given global modulator.
Effect.addGlobalModulator(var chainIndex, var globalMod, String modName)addModulator
Adds a modulator to the given chain and returns a reference.
Effect.addModulator(var chainIndex, var typeName, var modName)addStaticGlobalModulator
Adds and connects a receiving static time variant modulator for the given global modulator.
Effect.addStaticGlobalModulator(var chainIndex, var timeVariantMod, String modName)exists
Checks if the Object exists and prints a error message on the console if not.
Effect.exists()exportScriptControls
Export the control values (without the script).
Effect.exportScriptControls()exportState
Exports the state as base64 string.
Effect.exportState()getAttribute
Returns the attribute with the given index.
Effect.getAttribute(int index)getAttributeId
Returns the ID of the attribute with the given index.
Effect.getAttributeId(int index)getAttributeIndex
Returns the index of the attribute with the given ID.
Effect.getAttributeIndex(String id)getCurrentLevel
Returns the current peak level for the given channel.
Effect.getCurrentLevel(bool leftChannel)getId
Returns the ID of the effect.
Effect.getId()getModulatorChain
Returns the Modulator chain with the given index.
Effect.getModulatorChain(var chainIndex)getNumAttributes
Returns the number of attributes.
Effect.getNumAttributes()isBypassed
Checks if the effect is bypassed.
Effect.isBypassed()isSuspended
Checks if the effect is currently suspended (= no audio running through it and suspension enabled).
Effect.isSuspended()restoreScriptControls
Restores the control values for scripts (without recompiling).
Effect.restoreScriptControls(String base64Controls)restoreState
Restores the state from a base64 string.
Effect.restoreState(String base64State)setAttribute
Changes one of the Parameter. Look in the manual for the index numbers of each effect.
Effect.setAttribute(int parameterIndex, float newValue)setBypassed
Bypasses the effect.
Effect.setBypassed(bool shouldBeBypassed)