HISE Docs

DspModule


Class methods

DspInstance

Creates a new instance from the given Factory with the supplied name.

DspModule.DspInstance( DspFactory *f,  String moduleName_)



getConstant

Returns the constant at the given index.

DspModule.getConstant(int index)



getConstantId

Returns the name of the constant.

DspModule.getConstantId(int index)



getInfo

Returns an informative String.

DspModule.getInfo()



getNumConstants

Returns the number of constants.

DspModule.getNumConstants()



getNumParameters

Returns the number of parameters.

DspModule.getNumParameters()



getParameter

Returns the parameter with the given index.

DspModule.getParameter(int index)



getStringParameter

Gets the string value.

DspModule.getStringParameter(int index)



isBypassed

Checks if the processing is enabled.

DspModule.isBypassed()



operator >>

Applies the module on the data.

DspModule.operator >>( var data)



operator<<

Applies the module on the data.

DspModule.operator<<( var data)



prepareToPlay

Calls the setup method of the external module.

DspModule.prepareToPlay(double sampleRate, int samplesPerBlock)



processBlock

Calls the processMethod of the external module.

DspModule.processBlock( var data)



setBypassed

Enables / Disables the processing.

DspModule.setBypassed(bool shouldBeBypassed)



setParameter

Sets the float parameter with the given index.

DspModule.setParameter(int index, float newValue)



setStringParameter

Sets a String value.

DspModule.setStringParameter(int index, String value)