ddf.minim.signals
Class SineWave

java.lang.Object
  extended by ddf.minim.signals.Oscillator
      extended by ddf.minim.signals.SineWave
All Implemented Interfaces:
AudioSignal

public class SineWave
extends Oscillator

A sine wave is a smooth curve that oscillates between -1 and 1.

Author:
Damien Di Fede
See Also:
Sine Wave

Field Summary
 
Fields inherited from class ddf.minim.signals.Oscillator
TWO_PI
 
Constructor Summary
SineWave(float frequency, float amplitude, float sampleRate)
          Constructs a sine wave with the given frequency, amplitude and sample rate.
 
Method Summary
protected  float value(float step)
          Returns the value of the waveform at step.
 
Methods inherited from class ddf.minim.signals.Oscillator
amplitude, frequency, generate, generate, noPortamento, pan, period, portamento, sampleRate, setAmp, setAudioListener, setFreq, setPan, setPanNoGlide
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SineWave

public SineWave(float frequency,
                float amplitude,
                float sampleRate)
Constructs a sine wave with the given frequency, amplitude and sample rate.

Parameters:
frequency - the frequency of the pulse wave
amplitude - the amplitude of the pulse wave
sampleRate - the sample rate of the pulse wave
Method Detail

value

protected float value(float step)
Description copied from class: Oscillator
Returns the value of the waveform at step. To take advantage of all of the work that Oscillator does, you can create your own periodic waveforms by extending Oscillator and implementing this function. All of the oscillators included with Minim were created in this way.

Specified by:
value in class Oscillator
Parameters:
step - an offset from the beginning of the waveform's period
Returns:
the value of the waveform at step