HISE Docs

ChildSynth


Class methods

addGlobalModulator

Adds a and connects a receiver modulator for the given global modulator.

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



addModulator

Adds a modulator to the given chain and returns a reference.

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



addStaticGlobalModulator

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

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



asSampler

Returns a reference as Sampler or undefined if no Sampler.

ChildSynth.asSampler()



exists

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

ChildSynth.exists()



exportState

Exports the state as base64 string.

ChildSynth.exportState()



getAttribute

Returns the attribute with the given index.

ChildSynth.getAttribute(int index)



getAttributeId

Returns the attribute with the given index.

ChildSynth.getAttributeId(int index)



getAttributeIndex

Returns the index of the attribute with the given ID.

ChildSynth.getAttributeIndex(String id)



getChildSynthByIndex

Returns the child synth with the given index.

ChildSynth.getChildSynthByIndex(int index)



getCurrentLevel

Returns the current peak level for the given channel.

ChildSynth.getCurrentLevel(bool leftChannel)



getId

Returns the ID of the synth.

ChildSynth.getId()



getModulatorChain

Returns the modulator chain with the given index.

ChildSynth.getModulatorChain(var chainIndex)



getNumAttributes

Returns the number of attributes.

ChildSynth.getNumAttributes()



getRoutingMatrix

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

ChildSynth.getRoutingMatrix()



isBypassed

Checks if the synth is bypassed.

ChildSynth.isBypassed()



restoreState

Restores the state from a base64 string.

ChildSynth.restoreState(String base64State)



setAttribute

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

ChildSynth.setAttribute(int parameterIndex, float newValue)



setBypassed

Bypasses the synth.

ChildSynth.setBypassed(bool shouldBeBypassed)