All Classes Namespaces Functions Variables Enumerations Enumerator Modules Pages
Public Member Functions | List of all members
DspInstance Class Reference
Inheritance diagram for DspInstance:
AssignableObject

Public Member Functions

 DspInstance (const DspFactory *f, const String &moduleName_)
 
void prepareToPlay (double sampleRate, int samplesPerBlock)
 
void processBlock (const var &data)
 
void setParameter (int index, float newValue)
 
var getParameter (int index) const
 
var getNumParameters () const
 
var getNumConstants () const
 
var getConstantId (int index) const
 
var getConstant (int index) const
 
void setStringParameter (int index, String value)
 
String getStringParameter (int index)
 
void setBypassed (bool shouldBeBypassed)
 
bool isBypassed () const
 
void operator>> (const var &data)
 
void operator<< (const var &data)
 
var getInfo () const
 

Detailed Description

This objects is a wrapper around the actual DSP module that is loaded from a plugin.

It contains the glue code for accessing it per Javascript and is reference counted to manage the lifetime of the external module.

Constructor & Destructor Documentation

DspInstance ( const DspFactory *  f,
const String &  moduleName_ 
)

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

Member Function Documentation

var getConstant ( int  index) const

Returns the constant at the given index.

var getConstantId ( int  index) const

Returns the name of the constant.

var getInfo ( ) const

Returns an informative String.

var getNumConstants ( ) const

Returns the number of constants.

var getNumParameters ( ) const

Returns the number of parameters.

var getParameter ( int  index) const

Returns the parameter with the given index.

String getStringParameter ( int  index)

Gets the string value.

bool isBypassed ( ) const

Checks if the processing is enabled.

void operator<< ( const var &  data)

Applies the module on the data.

void operator>> ( const var &  data)

Applies the module on the data.

void prepareToPlay ( double  sampleRate,
int  samplesPerBlock 
)

Calls the setup method of the external module.

void processBlock ( const var &  data)

Calls the processMethod of the external module.

void setBypassed ( bool  shouldBeBypassed)

Enables / Disables the processing.

void setParameter ( int  index,
float  newValue 
)

Sets the float parameter with the given index.

void setStringParameter ( int  index,
String  value 
)

Sets a String value.

©2017 HISE. This documentation is autogenerated from the HISE source code using Doxygen.