WrappedAFX 2.0
Abstraction over RackAFX audio and GUI Processor
Loading...
Searching...
No Matches
AuxPort::Effect< sample, knob > Class Template Reference

This class abstracts the creation of an effect plugin on RackAFX and provides easy to use functions to interact with the RackAFX Audio and GUI processor. More...

#include <WrappedFX.h>

Public Member Functions

 Effect ()=default
 
 ~Effect ()=default
 
 Effect (const Effect &kernel)=default
 
void push (const std::vector< PluginParameter * > parameterList)
 
void updateParametersBySample ()
 
void updateParametersByBuffer ()
 
void reset (uint32_t sampleRate)
 
void run (Frame< sample > &frame)
 

Detailed Description

template<class sample, class knob>
class AuxPort::Effect< sample, knob >

This class abstracts the creation of an effect plugin on RackAFX and provides easy to use functions to interact with the RackAFX Audio and GUI processor.

The idea is to limit the user to just one file to write their DSP Logic....which is awesome for prototyping. The class provides interfaces that the users can write logic to

  1. update DSP parameters per sample : updateParametersBySample()
  2. update DSP parameters per buffer : updateParameterByBuffers()
  3. Reset the effect : reset(uint32_t sampleRate)
  4. Process a Mono/Stereo Frame : run(Frame& frame);
  5. Query a parameter of a GUI Control : getParameter(controlID controlid);
  6. Update a value of a GUI Meter : setMeterValue(double value, controlID controlid);

Constructor & Destructor Documentation

◆ Effect() [1/2]

template<class sample , class knob >
AuxPort::Effect< sample, knob >::Effect ( )
default

◆ ~Effect()

template<class sample , class knob >
AuxPort::Effect< sample, knob >::~Effect ( )
default

◆ Effect() [2/2]

template<class sample , class knob >
AuxPort::Effect< sample, knob >::Effect ( const Effect< sample, knob > & kernel)
default

Member Function Documentation

◆ push()

template<class sample , class knob >
void AuxPort::Effect< sample, knob >::push ( const std::vector< PluginParameter * > parameterList)
inline

◆ reset()

template<class sample , class knob >
void AuxPort::Effect< sample, knob >::reset ( uint32_t sampleRate)
inline

◆ run()

template<class sample , class knob >
void AuxPort::Effect< sample, knob >::run ( Frame< sample > & frame)
inline

◆ updateParametersByBuffer()

template<class sample , class knob >
void AuxPort::Effect< sample, knob >::updateParametersByBuffer ( )
inline

◆ updateParametersBySample()

template<class sample , class knob >
void AuxPort::Effect< sample, knob >::updateParametersBySample ( )
inline

The documentation for this class was generated from the following file: