Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   FAQ   Tutorial


Effect Class Reference

#include <Effect.h>

Inheritance diagram for Effect:

Stk Chorus Echo JCRev NRev PitShift PRCRev List of all members.

Detailed Description

STK abstract effects parent class.

This class provides common functionality for STK effects subclasses.

by Perry R. Cook and Gary P. Scavone, 1995 - 2007.


Public Member Functions

 Effect ()
 Class constructor.
virtual ~Effect ()
 Class destructor.
virtual void clear ()=0
 Reset and clear all internal state.
void setEffectMix (StkFloat mix)
 Set the mixture of input and "effected" levels in the output (0.0 = input only, 1.0 = reverb only).
StkFloat lastOut () const
 Return the last output value.
StkFloat lastOutLeft () const
 Return the last left output value.
StkFloat lastOutRight () const
 Return the last right output value.
StkFloat tick (StkFloat input)
 Take one sample input and compute one sample of output.
StkFramestick (StkFrames &frames, unsigned int channel=0)
 Take a channel of the StkFrames object as inputs to the effect and replace with corresponding outputs.


Member Function Documentation

StkFrames& Effect::tick StkFrames frames,
unsigned int  channel = 0
 

Take a channel of the StkFrames object as inputs to the effect and replace with corresponding outputs.

The channel argument should be zero or greater (the first channel is specified by 0). An StkError will be thrown if the channel argument is equal to or greater than the number of channels in the StkFrames object.


The documentation for this class was generated from the following file:
The Synthesis ToolKit in C++ (STK)
©1995-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved.