Device (jsynthlib 1.1-SNAPSHOT API)

java.lang.Object
- org.jsynthlib.device.model.Device

Direct Known Subclasses:

AccessVirusDevice, AlesisA6Device, AlesisDM5Device, AlesisDMProDevice, AlesisQSDevice, BossDR660Device, CasioCZ1000Device, DX7FamilyDevice, EmuProteusDevice, EnsoniqVFXDevice, FCB1010Device, GenericDevice, KawaiK4Device, KawaiK5000Device, KorgER1Device, KorgWavestationDevice, KorgX3Device, Line6BassPodDevice, Line6Pod20Device, MIDIboxFMDevice, MIDIboxSIDDevice, NordLeadDevice, NovationNova1Device, NovationSBSDevice, NovationXioSynthDevice, OberheimMatrix1000Device, OberheimMatrix6Device, PeaveyPC1600Device, QuasimidiQuasarDevice, RocktronIntellifexDevice, RolandD10Device, RolandGP16Device, RolandJD800Device, RolandJV80Device, RolandMKS50Device, RolandMKS7Device, RolandMT32Device, RolandSPD11Device, RolandTD6Device, RolandVG88Device, RolandXV5080Device, SCIProphet600Device, TCElectronicGMajorDevice, TCElectronicM350Device, VAmp2Device, WaldorfMW2Device, WaldorfPulseDevice, XMLDevice, Yamaha01vDevice, YamahaCS2xDevice, YamahaDX100Device, YamahaFS1RDevice, YamahaMotifDevice, YamahaSY77Device, YamahaSY85Device, YamahaTG100Device, YamahaTG33Device, YamahaTX81zDevice, YamahaUB99Device
```
public abstract class Device
extends Object
```
Device class defines some informations for your synthsizer, such as a name of manufacturer, the model name, author(s) of drivers, etc. It also manages a list of Driver classes which provides actual functions.
Subclass must define two constructor, with no argument and with one argument, Preferences. Here is an example;
```
    import java.util.prefs.Preferences;
    ...
    // Constructor for DeviceListWriter.
    public KawaiK4Device() {
 super("Kawai", "K4/K4R", "F07E..0602400000040000000000f7",
       INFO_TEXT, "Brian Klock & Gerrit Gehnen");
    }

    // Constructor for for actual work.
    public KawaiK4Device(Preferences prefs) {
 this();
 this.prefs = prefs;

      addDriver(new KawaiK4BulkConverter());
      ...
    }
 
```
Compatibility Note: The following fields are now private. Use setter/getter method to access them.
```
 manufacturerName, modelName, inquiryID, infoText, authors,
 synthName, channel, inPort, port
 
```
Created on 5. Oktober 2001, 21:59
Version:

$Id: Device.java 1162 2011-09-24 16:02:04Z frankster $

Author:

Gerrit Gehnen

See Also:

IDriver

Field Summary

Fields
Modifier and Type Field and Description

protected Preferences prefs
Preferences node for storing configuration options.

Fields
Modifier and Type	Field and Description
`protected Preferences`	`prefs` Preferences node for storing configuration options.

Constructor Summary

Constructors
Constructor and Description
`Device(String manufacturerName, String modelName, String inquiryID, String infoText, String authors)` Creates a new `Device` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDriver(IDriver driver)` Add Driver.
`JPanel`	`config()` Create a configration panel.
`int`	`driverCount()` Size query for driverList.
`String`	`getAuthors()` Getter for property authors.
`int`	`getChannel()` Getter for property channel.
`int`	`getDeviceID()` Getter for property deviceID.
`String`	`getDeviceName()` Getter for DeviceName.
`int`	`getDeviceNum()` getter for device number.
`IDriver`	`getDriver(int i)` Indexed getter for driverList elements.
`protected List<IDriver>`	`getDriverList()`
`String`	`getInfoText()` Getter for property infoText.
`int`	`getInPort()` Getter for property inPort.
`String`	`getInquiryID()` Getter for property inquiryID.
`String`	`getManufacturerName()` Getter for property getManufacturerName.
`String`	`getModelName()` Getter for property modelName.
`String`	`getOutPortName()` Getter for property port (MIDI output port).
`Preferences`	`getPreferences()`
`String`	`getSynthName()` Getter for property synthName.
`void`	`send(MidiMessage message)` send MidiMessage to MIDI output.
`void`	`setChannel(int channel)` Setter for property channel which is used for playPatch, etc.
`void`	`setDeviceID(int deviceID)` Setter for property deviceID.
`void`	`setDeviceManager(DeviceManager deviceManager)`
`void`	`setInPort(int inPort)` Setter for property inPort, the MIDI input port number, where the cable to the device is connected.
`protected void`	`setMidiBufSize(int bufSize, int delay)` If the target MIDI device cannot handle a whole Sysex message and requires to divide the Sysex Message into several small messages, use this method.
`void`	`setMidiService(MidiService midiService)`
`void`	`setMidiSettings(MidiSettings midiSettings)`
`void`	`setOutPortName(String outPortName)` Setter for property port, the MIDI output port number, where the cable to the device is connected.
`void`	`setSynthName(String synthName)` Setter for property synthName.
`void`	`setup(Preferences preferences)` Called after Device(Preferences prefs) is called.
`void`	`showDetails(Frame owner)` Show a dialog for the details of the device.
`String`	`toString()` Same as `getDeviceName()`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - prefs
```
protected Preferences prefs
```
    Preferences node for storing configuration options.
- Constructor Detail
  - Device
```
public Device(String manufacturerName,
              String modelName,
              String inquiryID,
              String infoText,
              String authors)
```
    Creates a new Device instance.
    
    Parameters:
    
    manufacturerName - The company which made the Synthesizer.
    
    modelName - The fixed name of the model supported by this driver, as stated on the type plate of the engine. eg TG33/SY22
    
    inquiryID - The response to the Universal Inquiry Message. It can have wildcards (*). It can be up to 16 bytes. Ex. "F07E**0602413F01000000020000f7"
    
    infoText - Information about Device.
    
    authors - Authors of the device driver.
- Method Detail
  - setup
```
public void setup(Preferences preferences)
```
    Called after Device(Preferences prefs) is called.
    
    Parameters:
    
    preferences - TODO
  - getPreferences
```
public final Preferences getPreferences()
```
  - config
```
public JPanel config()
```
    Create a configration panel. Override this if your device supports a configration panel.
  - getManufacturerName
```
public final String getManufacturerName()
```
    Getter for property getManufacturerName.
    
    Returns:
    
    Value of property getManufacturerName.
  - getModelName
```
public final String getModelName()
```
    Getter for property modelName.
    
    Returns:
    
    Value of property modelName.
  - getInquiryID
```
public final String getInquiryID()
```
    Getter for property inquiryID.
    
    Returns:
    
    Value of property inquiryID.
  - getInfoText
```
public final String getInfoText()
```
    Getter for property infoText.
    
    Returns:
    
    Value of property infoText.
  - getAuthors
```
public final String getAuthors()
```
    Getter for property authors.
    
    Returns:
    
    Value of property authors.
  - getSynthName
```
public String getSynthName()
```
    Getter for property synthName.
    
    Returns:
    
    Value of property synthName.
  - setSynthName
```
public final void setSynthName(String synthName)
```
    Setter for property synthName. The synthName is your personal naming of the device. A user can change it in the first column of the Synth-Configuration dialog. modelName is used as default value. A synth driver should not use this.
    
    Parameters:
    
    synthName - New value of property synthName.
  - getChannel
```
public final int getChannel()
```
    Getter for property channel.
    
    Returns:
    
    Value of property channel.
  - setChannel
```
public final void setChannel(int channel)
```
    Setter for property channel which is used for playPatch, etc. The value must be 1 or greater than 1, and 16 or less than 16. A synth driver may use this method to set default value.
    Some old drivers use this for device ID. Use setDeviceID method to set device ID.
    
    Parameters:
    
    channel - The value must be 1 or greater than 1, and 16 or less than 16.
  - getDeviceID
```
public final int getDeviceID()
```
    Getter for property deviceID.
    
    Returns:
    
    Value of property deviceID.
  - setDeviceID
```
public final void setDeviceID(int deviceID)
```
    Setter for property deviceID. The value must be 1 or greater than 1, and 256 or less than 256. A synth driver may use this to set default device ID.
    For backward compatibility if this has the initial value (-1), The value of channel is used as device ID.
    
    Parameters:
    
    deviceID - The value must be 1 or greater than 1, and 256 or less than 256.
  - getOutPortName
```
public final String getOutPortName()
```
    Getter for property port (MIDI output port).
    
    Returns:
    
    Value of property port.
  - setOutPortName
```
public final void setOutPortName(String outPortName)
```
    Setter for property port, the MIDI output port number, where the cable to the device is connected. A synth driver should not use this.
    
    Parameters:
    
    outPortName - New value of property port.
  - setMidiBufSize
```
protected final void setMidiBufSize(int bufSize,
                                    int delay)
```
    If the target MIDI device cannot handle a whole Sysex message and requires to divide the Sysex Message into several small messages, use this method.
    
    Parameters:
    
    bufSize - MIDI message size. If zero, whole MIDI message is passed to lower MIDI driver.
    
    delay - delay (msec) after every MIDI message transfer.
  - send
```
public final void send(MidiMessage message)
```
    send MidiMessage to MIDI output. Called by Driver.send().
  - getInPort
```
public final int getInPort()
```
    Getter for property inPort.
    
    Returns:
    
    Value of property inPort.
  - setInPort
```
public final void setInPort(int inPort)
```
    Setter for property inPort, the MIDI input port number, where the cable to the device is connected. A synth driver should not use this.
    
    Parameters:
    
    inPort - New value of property inPort.
  - addDriver
```
public final void addDriver(IDriver driver)
```
    Add Driver. Usually a constructor of a subclass of Device calls this. Bulk converters must be added before simple drivers!
    
    Parameters:
    
    driver - IDriver to be added.
    
    See Also:
    
    IConverter
  - driverCount
```
public final int driverCount()
```
    Size query for driverList.
  - getDriver
```
public final IDriver getDriver(int i)
```
    Indexed getter for driverList elements.
  - getDeviceNum
```
public final int getDeviceNum()
```
    getter for device number.
  - getDeviceName
```
public String getDeviceName()
```
    Getter for DeviceName.
    
    Returns:
    
    String of Device Name with inPort and Channel.
  - toString
```
public String toString()
```
    Same as getDeviceName(). See #getDeviceName
    
    Overrides:
    
    toString in class Object
  - showDetails
```
public void showDetails(Frame owner)
```
    Show a dialog for the details of the device.
  - setMidiService
```
@Inject
public void setMidiService(MidiService midiService)
```
  - setMidiSettings
```
@Inject
public void setMidiSettings(MidiSettings midiSettings)
```
  - setDeviceManager
```
@Inject
public void setDeviceManager(DeviceManager deviceManager)
```
  - getDriverList
```
protected List<IDriver> getDriverList()
```

Class Device

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

prefs

Constructor Detail

Device

Method Detail

setup

getPreferences

config

getManufacturerName

getModelName

getInquiryID

getInfoText

getAuthors

getSynthName

setSynthName

getChannel

setChannel

getDeviceID

setDeviceID

getOutPortName

setOutPortName

setMidiBufSize

send

getInPort

setInPort

addDriver

driverCount

getDriver

getDeviceNum

getDeviceName

toString

showDetails

setMidiService

setMidiSettings

setDeviceManager

getDriverList