Modulator
Get a reference to Modulators with Synth.getModulator() to call its functions.
const var LFOModulator1 = Synth.getModulator("LFO Modulator1");
Class methods
addGlobalModulator
Adds a and connects a receiver modulator for the given global modulator.
Modulator.addGlobalModulator(var chainIndex, var globalMod, String modName)
addModulator
Adds a modulator to the given chain and returns a reference.
Modulator.addModulator(var chainIndex, var typeName, var modName)
addStaticGlobalModulator
Adds and connects a receiving static time variant modulator for the given global modulator.
Modulator.addStaticGlobalModulator(var chainIndex, var timeVariantMod, String modName)
asTableProcessor
Returns a reference as table processor to modify the table or undefined if no table modulator.
Modulator.asTableProcessor()
connectToGlobalModulator
Connects a receive modulator to a global modulator.
Modulator.connectToGlobalModulator(String globalModulationContainerId, String modulatorId)
exists
Checks if the Object exists and prints a error message on the console if not.
Modulator.exists()
exportScriptControls
Export the control values (without the script).
Modulator.exportScriptControls()
exportState
Exports the state as base64 string.
Modulator.exportState()
getAttribute
Returns the attribute with the given index.
Modulator.getAttribute(int index)
getAttributeId
Returns the ID of the attribute with the given index.
Modulator.getAttributeId(int index)
getAttributeIndex
Returns the index of the attribute with the given ID.
Modulator.getAttributeIndex(String id)
getCurrentLevel
Returns the current peak value of the modulator.
Modulator.getCurrentLevel()
getGlobalModulatorId
Returns the id of the global modulation container and global modulator this modulator is connected to
Modulator.getGlobalModulatorId()
getId
Returns the ID of the modulator.
Modulator.getId()
getIntensity
Returns the intensity of the Modulator. Ranges: Gain: 0...1, Pitch: -12...12.
Modulator.getIntensity()
getModulatorChain
Returns the Modulator chain with the given index.
Modulator.getModulatorChain(var chainIndex)
getNumAttributes
Returns the number of attributes.
Modulator.getNumAttributes()
getType
Returns the Type of the modulator.
Modulator.getType()
isBypassed
Checks if the modulator is bypassed.
Modulator.isBypassed()
restoreScriptControls
Restores the control values for scripts (without recompiling).
Modulator.restoreScriptControls(String base64Controls)
restoreState
Restores the state from a base64 string.
Modulator.restoreState(String base64State)
setAttribute
Sets the attribute of the Modulator. You can look up the specific parameter indexes in the manual.
Modulator.setAttribute(int index, float value)
setBypassed
Bypasses the Modulator.
Modulator.setBypassed(bool shouldBeBypassed)
setIntensity
Changes the Intensity of the Modulator. Ranges: Gain Mode 0 ... 1, PitchMode -12 ... 12.
Modulator.setIntensity(float newIntensity)