Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   Tutorial


Echo Class Reference

#include <Echo.h>

Inheritance diagram for Echo:

Effect Stk List of all members.

Detailed Description

STK echo effect class.

This class implements an echo effect.

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

Definition at line 17 of file Echo.h.

Public Member Functions

 Echo (unsigned long maximumDelay=(unsigned long) Stk::sampleRate())
 Class constructor, taking the longest desired delay length (one second default value).

 ~Echo ()
 Class destructor.

void clear ()
 Reset and clear all internal state.

void setMaximumDelay (unsigned long delay)
 Set the maximum delay line length in samples.

void setDelay (unsigned long delay)
 Set the delay line length in samples.

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

Echo::Echo unsigned long  maximumDelay = (unsigned long) Stk::sampleRate()  ) 
 

Class constructor, taking the longest desired delay length (one second default value).

The default delay value is set to 1/2 the maximum delay length.


Member Function Documentation

StkFrames& Echo::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.