Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   Tutorial


Mandolin Class Reference

#include <Mandolin.h>

Inheritance diagram for Mandolin:

PluckTwo Instrmnt Stk List of all members.

Detailed Description

STK mandolin instrument model class.

This class inherits from PluckTwo and uses "commuted synthesis" techniques to model a mandolin instrument.

This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others. Commuted Synthesis, in particular, is covered by patents, granted, pending, and/or applied-for. All are assigned to the Board of Trustees, Stanford University. For information, contact the Office of Technology Licensing, Stanford University.

Control Change Numbers:

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

Definition at line 36 of file Mandolin.h.

Public Member Functions

 Mandolin (StkFloat lowestFrequency)
 Class constructor, taking the lowest desired playing frequency.

 ~Mandolin ()
 Class destructor.

void pluck (StkFloat amplitude)
 Pluck the strings with the given amplitude (0.0 - 1.0) using the current frequency.

void pluck (StkFloat amplitude, StkFloat position)
 Pluck the strings with the given amplitude (0.0 - 1.0) and position (0.0 - 1.0).

void noteOn (StkFloat frequency, StkFloat amplitude)
 Start a note with the given frequency and amplitude (0.0 - 1.0).

void setBodySize (StkFloat size)
 Set the body size (a value of 1.0 produces the "default" size).

StkFloat tick ()
 Compute one output sample.

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

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

void controlChange (int number, StkFloat value)
 Perform the control change specified by number and value (0.0 - 128.0).


Member Function Documentation

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

Implements PluckTwo.


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.