com.softsynth.jsyn
Class SynthSampleQueue

java.lang.Object
  extended by com.softsynth.jsyn.SynthPort
      extended by com.softsynth.jsyn.SynthDataQueue
          extended by com.softsynth.jsyn.SynthSampleQueue

public class SynthSampleQueue
extends SynthDataQueue

SynthSampleQueue class for Java Audio Synthesis This class doesn't do much except generate compile-time errors if you accidentally try to queue envelope data on a sample queue.

Author:
(C) 1997 Phil Burk, SoftSynth.com, All Rights Reserved

Method Summary
 void queue(int time, SynthSample sample)
           
 void queue(int time, SynthSample sample, int startFrame, int numFrames)
          Queue all or a portion of this sample to be played once by this SynthUnit.
 void queue(SynthSample sample)
           
 void queue(SynthSample sample, int startFrame, int numFrames)
           
 void queue(SynthSample sample, int startFrame, int numFrames, int flags)
          Queue all or a portion of this data to be played once on this SynthSampleQueue.
 void queueLoop(int time, SynthSample sample)
           
 void queueLoop(int time, SynthSample sample, int startFrame, int numFrames)
          Queue all or a portion of this sample to be played in a loop by this SynthUnit.
 void queueLoop(SynthSample sample)
           
 void queueLoop(SynthSample sample, int startFrame, int numFrames)
          Queue all or a portion of this sample to be played by this SynthUnit in a loop.
 void queueOff(int time, SynthSample sample)
           
 void queueOff(int time, SynthSample sample, boolean ifStop)
          Convenience method that will queue the decay portion of a sample, or the gap and release loop portions if they exist.
 void queueOff(SynthSample sample)
           
 void queueOn(int time, SynthSample sample)
          Convenience method that will queue the attack portion of a sample and the sustain loop if it exists.
 void queueOn(SynthSample sample)
           
 
Methods inherited from class com.softsynth.jsyn.SynthDataQueue
clear, clear, getNumFramesMoved, getNumFramesMoved, queue, queue, queue, queue, queueLoop, queueLoop, queueOff, queueOff, queueOff, queueOn, queueOn
 
Methods inherited from class com.softsynth.jsyn.SynthPort
getAlias, getName, getNumParts, getSignalType, getSignalType, getSound, setAlias, setSignalType, setSignalType, setSignalType, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

queue

public void queue(SynthSample sample,
                  int startFrame,
                  int numFrames,
                  int flags)
           throws SynthException
Queue all or a portion of this data to be played once on this SynthSampleQueue.

Throws:
SynthException - If queue name is not recognized, or frames are out of range.

queue

public void queue(SynthSample sample,
                  int startFrame,
                  int numFrames)
           throws SynthException
Throws:
SynthException

queue

public void queue(SynthSample sample)
           throws SynthException
Throws:
SynthException

queueLoop

public void queueLoop(SynthSample sample,
                      int startFrame,
                      int numFrames)
               throws SynthException
Queue all or a portion of this sample to be played by this SynthUnit in a loop. If there is any sample data after this in the queue then this portion will not be played.

Throws:
SynthException - If queue name is not recognized, or frames are out of range.

queueLoop

public void queueLoop(SynthSample sample)
               throws SynthException
Throws:
SynthException

queue

public void queue(int time,
                  SynthSample sample,
                  int startFrame,
                  int numFrames)
           throws SynthException
Queue all or a portion of this sample to be played once by this SynthUnit. The request will be placed in the queue at the specified time. The data will then be played when it reaches the front of the queue.

Throws:
SynthException - If queue name is not recognized, or frames are out of range.

queue

public void queue(int time,
                  SynthSample sample)
           throws SynthException
Throws:
SynthException

queueLoop

public void queueLoop(int time,
                      SynthSample sample,
                      int startFrame,
                      int numFrames)
               throws SynthException
Queue all or a portion of this sample to be played in a loop by this SynthUnit. The request will be placed in the queue at the specified time. The data will then be played when it reaches the front of the queue.

Throws:
SynthException - If queue name is not recognized, or frames are out of range.

queueLoop

public void queueLoop(int time,
                      SynthSample sample)
               throws SynthException
Throws:
SynthException

queueOn

public void queueOn(int time,
                    SynthSample sample)
             throws SynthException
Convenience method that will queue the attack portion of a sample and the sustain loop if it exists. This could be used to implement a NoteOn method.

Throws:
SynthException - TBD

queueOn

public void queueOn(SynthSample sample)
             throws SynthException
Throws:
SynthException

queueOff

public void queueOff(int time,
                     SynthSample sample,
                     boolean ifStop)
              throws SynthException
Convenience method that will queue the decay portion of a sample, or the gap and release loop portions if they exist. This could be used to implement a NoteOff method. If ifStop is true Synth.FLAG_AUTO_STOP flag will be used to stop the circuit when the sample is finished.

Parameters:
ifStop - if true then use Synth.FLAG_AUTO_STOP
Throws:
SynthException - TBD

queueOff

public void queueOff(int time,
                     SynthSample sample)
              throws SynthException
Throws:
SynthException

queueOff

public void queueOff(SynthSample sample)
              throws SynthException
Throws:
SynthException