With the ChildSynth object you can refer to any Sound Generator in the HISE audio hierarchy and modify its properties.

As in:

// Right click the top bar of a module and click "Create generic script reference" to auto-generate this line.
const var SineWaveGenerator1 = Synth.getChildSynth("Sine Wave Generator1");

Class methods

addGlobalModulator

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

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

addModulator

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

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

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

asSampler

Returns a reference as Sampler or undefined if no Sampler. Edit on GitHub

ChildSynth.asSampler()

exists

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

ChildSynth.exists()

exportState

Exports the state as base64 string. Edit on GitHub

ChildSynth.exportState()

getAttribute

Returns the attribute with the given index. Edit on GitHub

ChildSynth.getAttribute(int index)

getAttributeId

Returns the attribute with the given index. Edit on GitHub

ChildSynth.getAttributeId(int index)

getAttributeIndex

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

ChildSynth.getAttributeIndex(String id)

getChildSynthByIndex

Returns the child synth with the given index. Edit on GitHub

ChildSynth.getChildSynthByIndex(int index)

getCurrentLevel

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

ChildSynth.getCurrentLevel(bool leftChannel)

getId

Returns the ID of the synth. Edit on GitHub

ChildSynth.getId()

getModulatorChain

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

ChildSynth.getModulatorChain(var chainIndex)

getNumAttributes

Returns the number of attributes. Edit on GitHub

ChildSynth.getNumAttributes()

getRoutingMatrix

Returns a reference to the routing matrix object of the sound generator. Edit on GitHub

ChildSynth.getRoutingMatrix()

isBypassed

Checks if the synth is bypassed. Edit on GitHub

ChildSynth.isBypassed()

restoreState

Restores the state from a base64 string. Edit on GitHub

ChildSynth.restoreState(String base64State)

setAttribute

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

ChildSynth.setAttribute(int parameterIndex, float newValue)

setBypassed

Bypasses the synth. Edit on GitHub

ChildSynth.setBypassed(bool shouldBeBypassed)