Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   Tutorial


Chorus Class Reference

#include <Chorus.h>

Inheritance diagram for Chorus:

Effect Stk List of all members.

Detailed Description

STK chorus effect class.

This class implements a chorus effect.

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

Definition at line 18 of file Chorus.h.

Public Member Functions

 Chorus (StkFloat baseDelay=6000)
 Class constructor, taking the median desired delay length.

 ~Chorus ()
 Class destructor.

void clear ()
 Reset and clear all internal state.

void setModDepth (StkFloat depth)
 Set modulation depth.

void setModFrequency (StkFloat frequency)
 Set modulation frequency.

StkFloat tick (StkFloat input)
 Compute one output sample.

StkFloat * tick (StkFloat *vector, unsigned int vectorSize)
 Take vectorSize inputs, compute the same number of outputs and return them in vector.

StkFramestick (StkFrames &frames, unsigned int channel=1)
 Take a channel of the StkFrames object as inputs to the effect and replace with corresponding outputs.


Constructor & Destructor Documentation

Chorus::Chorus StkFloat  baseDelay = 6000  ) 
 

Class constructor, taking the median desired delay length.

An StkError can be thrown if the rawwave path is incorrect.


Member Function Documentation

StkFrames& Chorus::tick StkFrames frames,
unsigned int  channel = 1
[virtual]
 

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

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

Reimplemented from Effect.


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