Home Information Classes Download Usage Mail List Requirements Links FAQ Tutorial
STK chorus effect class. More...
#include <Chorus.h>
Public Member Functions | |
Chorus (StkFloat baseDelay=6000) | |
Class constructor, taking the median desired delay length. | |
void | clear (void) |
Reset and clear all internal state. | |
void | setModDepth (StkFloat depth) |
Set modulation depth. | |
void | setModFrequency (StkFloat frequency) |
Set modulation frequency. | |
StkFloat | lastOut (unsigned int channel=0) |
Return the specified channel value of the last computed stereo frame. | |
StkFloat | tick (StkFloat input, unsigned int channel=0) |
Input one sample to the effect and return the specified channel value of the computed stereo frame. | |
StkFrames & | tick (StkFrames &frames, unsigned int channel=0) |
Take a channel of the StkFrames object as inputs to the effect and replace with stereo outputs. | |
StkFrames & | tick (StkFrames &iFrames, StkFrames &oFrames, unsigned int iChannel=0, unsigned int oChannel=0) |
Take a channel of the iFrames object as inputs to the effect and write stereo outputs to the oFrames object. |
STK chorus effect class.
This class implements a chorus effect. It takes a monophonic input signal and produces a stereo output signal.
by Perry R. Cook and Gary P. Scavone, 1995 - 2010.
stk::Chorus::Chorus | ( | StkFloat | baseDelay = 6000 |
) |
Class constructor, taking the median desired delay length.
An StkError can be thrown if the rawwave path is incorrect.
StkFloat stk::Chorus::lastOut | ( | unsigned int | channel = 0 |
) | [inline] |
Return the specified channel value of the last computed stereo frame.
Use the lastFrame() function to get both values of the last computed stereo frame. The channel
argument must be 0 or 1 (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an StkError exception.
StkFloat stk::Chorus::tick | ( | StkFloat | input, | |
unsigned int | channel = 0 | |||
) | [inline] |
Input one sample to the effect and return the specified channel
value of the computed stereo frame.
Use the lastFrame() function to get both values of the computed stereo output frame. The channel
argument must be 0 or 1 (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an StkError exception.
Take a channel of the StkFrames object as inputs to the effect and replace with stereo outputs.
The StkFrames argument reference is returned. The stereo outputs are written to the StkFrames argument starting at the specified channel
. Therefore, the channel
argument must be less than ( channels() - 1 ) of the StkFrames argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an StkError exception.
StkFrames & stk::Chorus::tick | ( | StkFrames & | iFrames, | |
StkFrames & | oFrames, | |||
unsigned int | iChannel = 0 , |
|||
unsigned int | oChannel = 0 | |||
) | [inline] |
Take a channel of the iFrames
object as inputs to the effect and write stereo outputs to the oFrames
object.
The iFrames
object reference is returned. The iChannel
argument must be less than the number of channels in the iFrames
argument (the first channel is specified by 0). The oChannel
argument must be less than ( channels() - 1 ) of the oFrames
argument. However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an StkError exception.
The Synthesis ToolKit in C++ (STK) |
©1995-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved. |