Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   Tutorial


Modulate Class Reference

#include <Modulate.h>

Inheritance diagram for Modulate:

Generator Stk List of all members.

Detailed Description

STK periodic/random modulator.

This class combines random and periodic modulations to give a nice, natural human modulation function.

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

Definition at line 21 of file Modulate.h.

Public Member Functions

 Modulate ()
 Class constructor.

 ~Modulate ()
 Class destructor.

void reset ()
 Reset internal state.

void setVibratoRate (StkFloat rate)
 Set the periodic (vibrato) rate or frequency in Hz.

void setVibratoGain (StkFloat gain)
 Set the periodic (vibrato) gain.

void setRandomGain (StkFloat gain)
 Set the random modulation gain.

StkFloat tick ()
 Compute one output sample.

StkFloat * tick (StkFloat *vector, unsigned int vectorSize)
 Compute vectorSize outputs and return them in vector.

StkFramestick (StkFrames &frames, unsigned int channel=1)
 Fill a channel of the StkFrames object with computed outputs.


Constructor & Destructor Documentation

Modulate::Modulate  ) 
 

Class constructor.

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


Member Function Documentation

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

Fill a channel of the StkFrames object with computed 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 Generator.


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.