A Synthesizer generates sound. This usually happens when one of the Synthesizer's MidiChannel objects receives a noteOn message, either directly or via the Synthesizer object. Many Synthesizers support Receivers, through which MIDI events can be delivered to the Synthesizer. In such cases, the Synthesizer typically responds by sending a corresponding message to the appropriate MidiChannel, or by processing the event itself if the event isn't one of the MIDI channel messages.

The Synthesizer interface includes methods for loading and unloading instruments from soundbanks. An instrument is a specification for synthesizing a certain type of sound, whether that sound emulates a traditional instrument or is some kind of sound effect or other imaginary sound. A soundbank is a collection of instruments, organized by bank and program number (via the instrument's Patch object). Different Synthesizer classes might implement different sound-synthesis techniques, meaning that some instruments and not others might be compatible with a given synthesizer. Also, synthesizers may have a limited amount of memory for instruments, meaning that not every soundbank and instrument can be used by every synthesizer, even if the synthesis technique is compatible. To see whether the instruments from a certain soundbank can be played by a given synthesizer, invoke the isSoundbankSupported method of Synthesizer.

"Loading" an instrument means that that instrument becomes available for synthesizing notes. The instrument is loaded into the bank and program location specified by its Patch object. Loading does not necessarily mean that subsequently played notes will immediately have the sound of this newly loaded instrument. For the instrument to play notes, one of the synthesizer's MidiChannel objects must receive (or have received) a program-change message that causes that particular instrument's bank and program number to be selected.

Closes the device, indicating that the device should now release any system resources it is using.

All Receiver and Transmitter instances open from this device are closed. This includes instances retrieved via MidiSystem.

See Also
Obtains a list of instruments that come with the synthesizer. These instruments might be built into the synthesizer, or they might be part of a default soundbank provided with the synthesizer, etc.

Note that you don't use this method to find out which instruments are currently loaded onto the synthesizer; for that purpose, you use getLoadedInstruments(). Nor does the method indicate all the instruments that can be loaded onto the synthesizer; it only indicates the subset that come with the synthesizer. To learn whether another instrument can be loaded, you can invoke isSoundbankSupported(), and if the instrument's Soundbank is supported, you can try loading the instrument.

Return
list of available instruments.
Obtains the set of MIDI channels controlled by this synthesizer. Each non-null element in the returned array is a MidiChannel that receives the MIDI messages sent on that channel number.

The MIDI 1.0 specification provides for 16 channels, so this method returns an array of at least 16 elements. However, if this synthesizer doesn't make use of all 16 channels, some of the elements of the array might be null, so you should check each element before using it.

Return
an array of the MidiChannel objects managed by this Synthesizer. Some of the array elements may be null.
Obtains the default soundbank for the synthesizer, if one exists. (Some synthesizers provide a default or built-in soundbank.) If a synthesizer doesn't have a default soundbank, instruments must be loaded explicitly from an external soundbank.
Return
default soundbank, or null if one does not exist.
Obtains information about the device, including its Java class and Strings containing its name, vendor, and description.
Return
device info
Obtains the processing latency incurred by this synthesizer, expressed in microseconds. This latency measures the worst-case delay between the time a MIDI message is delivered to the synthesizer and the time that the synthesizer actually produces the corresponding result.

Although the latency is expressed in microseconds, a synthesizer's actual measured delay may vary over a wider range than this resolution suggests. For example, a synthesizer might have a worst-case delay of a few milliseconds or more.

Return
the worst-case delay, in microseconds
Obtains a list of the instruments that are currently loaded onto this Synthesizer.
Return
a list of currently loaded instruments
Obtains the maximum number of notes that this synthesizer can sound simultaneously.
Return
the maximum number of simultaneous notes
Obtains the maximum number of MIDI IN connections available on this MIDI device for receiving MIDI data.
Return
maximum number of MIDI IN connections, or -1 if an unlimited number of connections is available.
Obtains the maximum number of MIDI OUT connections available on this MIDI device for transmitting MIDI data.
Return
maximum number of MIDI OUT connections, or -1 if an unlimited number of connections is available.
Obtains the current time-stamp of the device, in microseconds. If a device supports time-stamps, it should start counting at 0 when the device is opened and continue incrementing its time-stamp in microseconds until the device is closed. If it does not support time-stamps, it should always return -1.
Return
the current time-stamp of the device in microseconds, or -1 if time-stamping is not supported by the device.
Obtains a MIDI IN receiver through which the MIDI device may receive MIDI data. The returned receiver must be closed when the application has finished using it.

Obtaining a Receiver with this method does not open the device. To be able to use the device, it has to be opened explicitly by calling #open . Also, closing the Receiver does not close the device. It has to be closed explicitly by calling #close .

Return
a receiver for the device.
Throws
MidiUnavailableExceptionthrown if a receiver is not available due to resource restrictions
Returns all currently active, non-closed receivers connected with this MidiDevice. A receiver can be removed from the device by closing it.
Return
an unmodifiable list of the open receivers
@since
1.5
Obtains a MIDI OUT connection from which the MIDI device will transmit MIDI data The returned transmitter must be closed when the application has finished using it.

Obtaining a Transmitter with this method does not open the device. To be able to use the device, it has to be opened explicitly by calling #open . Also, closing the Transmitter does not close the device. It has to be closed explicitly by calling #close .

Return
a MIDI OUT transmitter for the device.
Throws
MidiUnavailableExceptionthrown if a transmitter is not available due to resource restrictions
Returns all currently active, non-closed transmitters connected with this MidiDevice. A transmitter can be removed from the device by closing it.
Return
an unmodifiable list of the open transmitters
@since
1.5
Obtains the current status of the voices produced by this synthesizer. If this class of Synthesizer does not provide voice information, the returned array will always be of length 0. Otherwise, its length is always equal to the total number of voices, as returned by getMaxPolyphony(). (See the VoiceStatus class description for an explanation of synthesizer voices.)
Return
an array of VoiceStatus objects that supply information about the corresponding synthesizer voices
Reports whether the device is open.
Return
true if the device is open, otherwise false
See Also
Informs the caller whether this synthesizer is capable of loading instruments from the specified soundbank. If the soundbank is unsupported, any attempts to load instruments from it will result in an IllegalArgumentException.
Parameters
soundbanksoundbank for which support is queried
Return
true if the soundbank is supported, otherwise false
Loads onto the Synthesizer all instruments contained in the specified Soundbank.
Parameters
soundbankthe Soundbank whose are instruments are to be loaded
Return
true if the instruments are all successfully loaded (or already had been), false if any instrument could not be loaded (for example, if the Synthesizer had insufficient memory)
Throws
IllegalArgumentExceptionif the requested soundbank is incompatible with this synthesizer.
Makes a particular instrument available for synthesis. This instrument is loaded into the patch location specified by its Patch object, so that if a program-change message is received (or has been received) that causes that patch to be selected, subsequent notes will be played using the sound of instrument. If the specified instrument is already loaded, this method does nothing and returns true.

The instrument must be part of a soundbank that this Synthesizer supports. (To make sure, you can use the getSoundbank method of Instrument and the isSoundbankSupported method of Synthesizer.)

Parameters
instrumentinstrument to load
Return
true if the instrument is successfully loaded (or already had been), false if the instrument could not be loaded (for example, if the synthesizer has insufficient memory to load it)
Throws
IllegalArgumentExceptionif this Synthesizer doesn't support the specified instrument's soundbank
Loads the instruments referenced by the specified patches, from the specified Soundbank. Each of the Patch objects indicates a bank and program number; the Instrument that has the matching Patch is loaded into that bank and program location.
Parameters
soundbankthe Soundbank containing the instruments to load
patchListlist of patches for which instruments should be loaded
Return
true if the instruments are all successfully loaded (or already had been), false if any instrument could not be loaded (for example, if the Synthesizer had insufficient memory)
Throws
IllegalArgumentExceptionthrown if the soundbank is not supported.
Opens the device, indicating that it should now acquire any system resources it requires and become operational.

An application opening a device explicitly with this call has to close the device by calling #close . This is necessary to release system resources and allow applications to exit cleanly.

Note that some devices, once closed, cannot be reopened. Attempts to reopen such a device will always result in a MidiUnavailableException.

Throws
MidiUnavailableExceptionthrown if the device cannot be opened due to resource restrictions.
SecurityExceptionthrown if the device cannot be opened due to security restrictions.
See Also
Remaps an instrument. Instrument to takes the place of instrument from. For example, if from was located at bank number 2, program number 11, remapping causes that bank and program location to be occupied instead by to. Instrument from is unloaded.
Parameters
frominstrument to be replaced
tonew instrument to be used in place of the old instrument
Return
true if the instrument could be remapped, false otherwise
Throws
IllegalArgumentExceptionif the soundbank is not supported
Unloads all instruments contained in the specified Soundbank.
Parameters
soundbanksoundbank containing instruments to unload
Throws
IllegalArgumentExceptionthrown if the soundbank is not supported.
Unloads a particular instrument.
Parameters
instrumentinstrument to unload
Throws
IllegalArgumentExceptionif this Synthesizer doesn't support the specified instrument's soundbank
Unloads the instruments referenced by the specified patches, from the MIDI sound bank specified.
Parameters
soundbanksoundbank containing instruments to unload
patchListlist of patches for which instruments should be unloaded
Throws
IllegalArgumentExceptionthrown if the soundbank is not supported.