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

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

addModulator

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

Modulator.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

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

Modulator.asTableProcessor()

connectToGlobalModulator

Connects a receive modulator to a global modulator. Edit on GitHub

Modulator.connectToGlobalModulator(String globalModulationContainerId, String modulatorId)

exists

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

Modulator.exists()

exportScriptControls

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

Modulator.exportScriptControls()

exportState

Exports the state as base64 string. Edit on GitHub

Modulator.exportState()

getAttribute

Returns the attribute with the given index. Edit on GitHub

Modulator.getAttribute(int index)

getAttributeId

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

Modulator.getAttributeId(int index)

getAttributeIndex

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

Modulator.getAttributeIndex(String id)

getCurrentLevel

Returns the current peak value of the modulator. Edit on GitHub

Modulator.getCurrentLevel()

getGlobalModulatorId

Returns the id of the global modulation container and global modulator this modulator is connected to Edit on GitHub

Modulator.getGlobalModulatorId()

getId

Returns the ID of the modulator. Edit on GitHub

Modulator.getId()

getIntensity

Returns the intensity of the Modulator. Ranges: Gain: 0...1, Pitch: -12...12. Edit on GitHub

Modulator.getIntensity()

getModulatorChain

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

Modulator.getModulatorChain(var chainIndex)

getNumAttributes

Returns the number of attributes. Edit on GitHub

Modulator.getNumAttributes()

getType

Returns the Type of the modulator. Edit on GitHub

Modulator.getType()

isBipolar

Returns true if the modulator works in bipolar mode. Edit on GitHub

Modulator.isBipolar()

isBypassed

Checks if the modulator is bypassed. Edit on GitHub

Modulator.isBypassed()

restoreScriptControls

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

Modulator.restoreScriptControls(String base64Controls)

restoreState

Restores the state from a base64 string. Edit on GitHub

Modulator.restoreState(String base64State)

setAttribute

Sets the attribute of the Modulator. You can look up the specific parameter indexes in the manual. Edit on GitHub

Modulator.setAttribute(int index, float value)

setBypassed

Bypasses the Modulator. Edit on GitHub

Modulator.setBypassed(bool shouldBeBypassed)

setIntensity

Changes the Intensity of the Modulator. Ranges: Gain Mode 0 ... 1, PitchMode -12 ... 12. Edit on GitHub

Modulator.setIntensity(float newIntensity)

setIsBipolar

Sets the modulator to a bipolar range (if applicable). Edit on GitHub

Modulator.setIsBipolar(bool shouldBeBipolar)