Synthesizer

All Known Implementing Classes:

SynthesisEngine
```
public interface Synthesizer
```
A synthesizer used by JSyn to generate audio. The synthesizer executes a network of unit generators to create an audio signal.

Author:

Phil Burk (C) 2010 Mobileer Inc

Field Summary

Fields
Modifier and Type Field and Description

static int FRAMES_PER_BLOCK

Fields
Modifier and Type	Field and Description
`static int`	`FRAMES_PER_BLOCK`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`add(UnitGenerator ugen)` Add a unit generator to the synthesizer so it can be played.
`void`	`addAudioTask(java.lang.Runnable task)` Add a task that will get run on the Audio Thread before it generates a new block of Audio.
`void`	`clearCommandQueue()` Clear all scheduled commands from the queue.
`TimeStamp`	`createTimeStamp()` Create a TimeStamp using the current audio time.
`AudioDeviceManager`	`getAudioDeviceManager()` An AudioDeviceManager is an interface to audio hardware.
`double`	`getCurrentTime()`
`long`	`getFrameCount()` This count is not reset if you stop and restart.
`double`	`getFramePeriod()`
`int`	`getFrameRate()`
`double`	`getUsage()`
`java.lang.String`	`getVersion()`
`int`	`getVersionCode()`
`boolean`	`isRealTime()` Is JSyn running in real-time mode?
`boolean`	`isRunning()`
`void`	`queueCommand(ScheduledCommand command)` Queue a command to be processed as soon as possible in the background audio thread.
`void`	`remove(UnitGenerator ugen)` Removes a unit generator added using add().
`void`	`removeAudioTask(java.lang.Runnable task)`
`void`	`scheduleCommand(double time, ScheduledCommand command)` Queue a command to be processed at a specific time in the background audio thread.
`void`	`scheduleCommand(TimeStamp timeStamp, ScheduledCommand command)` Queue a command to be processed at a specific time in the background audio thread.
`void`	`setRealTime(boolean realTime)` If set true then the synthesizer will generate audio in real-time.
`void`	`sleepFor(double duration)` Sleep for the specified audio time duration.
`void`	`sleepUntil(double time)` Sleep until the specified audio time is reached.
`void`	`start()` Starts a background thread that generates audio using the default frame rate of 44100 and two stereo output channels.
`void`	`start(int frameRate)` Starts a background thread that generates audio using the specified frame rate and two stereo output channels.
`void`	`start(int frameRate, int inputDeviceID, int numInputChannels, int ouputDeviceID, int numOutputChannels)` Starts the synthesizer using specific audio devices.
`void`	`startUnit(UnitGenerator unit)` The startUnit and stopUnit methods are mainly for internal use.
`void`	`startUnit(UnitGenerator unit, double time)` Start a unit generator at the specified time.
`void`	`startUnit(UnitGenerator unit, TimeStamp timeStamp)`
`void`	`stop()` Stops the background thread that generates the audio.
`void`	`stopUnit(UnitGenerator unit)` The startUnit and stopUnit methods are mainly for internal use.
`void`	`stopUnit(UnitGenerator unit, double time)`
`void`	`stopUnit(UnitGenerator unit, TimeStamp timeStamp)`

- Field Detail
  - FRAMES_PER_BLOCK
```
static final int FRAMES_PER_BLOCK
```
    See Also:
    
    Constant Field Values
- Method Detail
  - start
```
void start()
```
    Starts a background thread that generates audio using the default frame rate of 44100 and two stereo output channels.
  - start
```
void start(int frameRate)
```
    Starts a background thread that generates audio using the specified frame rate and two stereo output channels.
    
    Parameters:
    
    frameRate - in Hertz
  - start
```
void start(int frameRate,
           int inputDeviceID,
           int numInputChannels,
           int ouputDeviceID,
           int numOutputChannels)
```
    Starts the synthesizer using specific audio devices.
    
    Parameters:
    
    frameRate - in Hertz
    
    inputDeviceID - obtained from an AudioDeviceManager or pass AudioDeviceManager.USE_DEFAULT_DEVICE
    
    numInputChannels - 1 for mono, 2 for stereo, etcetera
    
    ouputDeviceID - obtained from an AudioDeviceManager or pass AudioDeviceManager.USE_DEFAULT_DEVICE
    
    numOutputChannels - 1 for mono, 2 for stereo, etcetera
  - getVersion
```
java.lang.String getVersion()
```
    Returns:
    
    JSyn version as a string
  - getVersionCode
```
int getVersionCode()
```
    Returns:
    
    version as an integer that always increases
  - stop
```
void stop()
```
    Stops the background thread that generates the audio.
  - getAudioDeviceManager
```
AudioDeviceManager getAudioDeviceManager()
```
    An AudioDeviceManager is an interface to audio hardware. It might be implemented using JavaSound or a wrapper around PortAudio.
    
    Returns:
    
    audio device manager being used by the synthesizer.
  - getFrameRate
```
int getFrameRate()
```
    Returns:
    
    the frame rate in samples per second
  - add
```
void add(UnitGenerator ugen)
```
    Add a unit generator to the synthesizer so it can be played. This is required before starting or connecting a unit generator into a network.
    
    Parameters:
    
    ugen - a unit generator to be executed by the synthesizer
  - remove
```
void remove(UnitGenerator ugen)
```
    Removes a unit generator added using add().
  - getCurrentTime
```
double getCurrentTime()
```
    Returns:
    
    the current audio time in seconds
  - startUnit
```
void startUnit(UnitGenerator unit,
               double time)
```
    Start a unit generator at the specified time. This is not needed if a unit generator's output is connected to other units. Typically you only need to start units that have no outputs, for example LineOut.
  - startUnit
```
void startUnit(UnitGenerator unit,
               TimeStamp timeStamp)
```
  - startUnit
```
void startUnit(UnitGenerator unit)
```
    The startUnit and stopUnit methods are mainly for internal use. Please call unit.start() or unit.stop() instead.
    
    Parameters:
    
    unit -
  - stopUnit
```
void stopUnit(UnitGenerator unit,
              double time)
```
  - stopUnit
```
void stopUnit(UnitGenerator unit,
              TimeStamp timeStamp)
```
  - stopUnit
```
void stopUnit(UnitGenerator unit)
```
    The startUnit and stopUnit methods are mainly for internal use. Please call unit.start() or unit.stop() instead.
    
    Parameters:
    
    unit -
  - sleepUntil
```
void sleepUntil(double time)
         throws java.lang.InterruptedException
```
    Sleep until the specified audio time is reached. In non-real-time mode, this will enable the synthesizer to run.
    
    Throws:
    
    java.lang.InterruptedException
  - sleepFor
```
void sleepFor(double duration)
       throws java.lang.InterruptedException
```
    Sleep for the specified audio time duration. In non-real-time mode, this will enable the synthesizer to run.
    
    Throws:
    
    java.lang.InterruptedException
  - setRealTime
```
void setRealTime(boolean realTime)
```
    If set true then the synthesizer will generate audio in real-time. Set it true for live audio. If false then JSyn will run in non-real-time mode. This can be used to generate audio to be written to a file. The default is true.
    
    Parameters:
    
    realTime -
  - isRealTime
```
boolean isRealTime()
```
    Is JSyn running in real-time mode?
  - createTimeStamp
```
TimeStamp createTimeStamp()
```
    Create a TimeStamp using the current audio time.
  - getUsage
```
double getUsage()
```
    Returns:
    
    the current CPU usage as a fraction between 0.0 and 1.0
  - getFramePeriod
```
double getFramePeriod()
```
    Returns:
    
    inverse of frameRate, to avoid expensive divides
  - getFrameCount
```
long getFrameCount()
```
    This count is not reset if you stop and restart.
    
    Returns:
    
    number of frames synthesized
  - scheduleCommand
```
void scheduleCommand(TimeStamp timeStamp,
                     ScheduledCommand command)
```
    Queue a command to be processed at a specific time in the background audio thread.
  - scheduleCommand
```
void scheduleCommand(double time,
                     ScheduledCommand command)
```
    Queue a command to be processed at a specific time in the background audio thread.
  - queueCommand
```
void queueCommand(ScheduledCommand command)
```
    Queue a command to be processed as soon as possible in the background audio thread.
  - clearCommandQueue
```
void clearCommandQueue()
```
    Clear all scheduled commands from the queue. Commands will be discarded.
  - isRunning
```
boolean isRunning()
```
    Returns:
    
    true if the Synthesizer has been started
  - addAudioTask
```
void addAudioTask(java.lang.Runnable task)
```
    Add a task that will get run on the Audio Thread before it generates a new block of Audio. This task must be very quick and should not perform any blocking operations. If you are not certain that you need an Audio rate task then don't use this.
    
    Parameters:
    
    task -
  - removeAudioTask
```
void removeAudioTask(java.lang.Runnable task)
```

Interface Synthesizer

Field Summary

Method Summary

Field Detail

FRAMES_PER_BLOCK

Method Detail

start

start

start

getVersion

getVersionCode

stop

getAudioDeviceManager

getFrameRate

add

remove

getCurrentTime

startUnit

startUnit

startUnit

stopUnit

stopUnit

stopUnit

sleepUntil

sleepFor

setRealTime

isRealTime

createTimeStamp

getUsage

getFramePeriod

getFrameCount

scheduleCommand

scheduleCommand

queueCommand

clearCommandQueue

isRunning

addAudioTask

removeAudioTask