javax.sound.midi

Interface Synthesizer

All Superinterfaces:
AutoCloseable, MidiDevice

public interface Synthesizer
extends MidiDevice

Interface for MIDI audio synthesizer devices.
Since:
1.3

Method Summary

Instrument[]
getAvailableInstruments()
Get an array containing all instruments in this synthesizer.
MidiChannel[]
getChannels()
Get the set of MIDI channels controlled by this synth.
Soundbank
getDefaultSoundbank()
Get the default Soundbank for this synth.
long
getLatency()
The processing latency for this synth in microseconds.
Instrument[]
getLoadedInstruments()
Get an array containing all instruments loaded in this synthesizer.
int
getMaxPolyphony()
Get the maximum number of notes that the synth can play at once.
VoiceStatus[]
getVoiceStatus()
Get the current status for the voices produced by this synth.
boolean
isSoundbankSupported(Soundbank soundbank)
Returns true is this synth is capable of loading soundbank.
boolean
loadAllInstruments(Soundbank soundbank)
Load all soundbank instruments into this synthesizer.
boolean
loadInstrument(Instrument instrument)
Load an instrument into this synth.
boolean
loadInstruments(Soundbank soundbank, Patch[] patchList)
Load a subset of soundbank instruments into this synthesizer.
boolean
remapInstrument(Instrument from, Instrument to)
Move an intrument from one place to another.
void
unloadAllInstruments(Soundbank soundbank)
Unload all soundbank instruments from this synthesizer.
void
unloadInstrument(Instrument instrument)
Unload an instrument from this synth.
void
unloadInstruments(Soundbank soundbank, Patch[] patchList)
Unload a subset of soundbank instruments from this synthesizer.

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface javax.sound.midi.MidiDevice

close, getDeviceInfo, getMaxReceivers, getMaxTransmitters, getMicrosecondPosition, getReceiver, getTransmitter, isOpen, open

Method Details

getAvailableInstruments

public Instrument[] getAvailableInstruments()
Get an array containing all instruments in this synthesizer.
Returns:
an array containing all instruments in this synthesizer

getChannels

public MidiChannel[] getChannels()
Get the set of MIDI channels controlled by this synth.
Returns:
an array of MIDI channels controlled by this synth

getDefaultSoundbank

public Soundbank getDefaultSoundbank()
Get the default Soundbank for this synth. Return null if there is no default.
Returns:
the default Soundbank for this synth, possibly null.

getLatency

public long getLatency()
The processing latency for this synth in microseconds.
Returns:
the processing latency for this synth in microseconds

getLoadedInstruments

public Instrument[] getLoadedInstruments()
Get an array containing all instruments loaded in this synthesizer.
Returns:
an array containing all instruments loaded in this synthesizer

getMaxPolyphony

public int getMaxPolyphony()
Get the maximum number of notes that the synth can play at once.
Returns:
the maximum number of notes that the synth can play at once

getVoiceStatus

public VoiceStatus[] getVoiceStatus()
Get the current status for the voices produced by this synth.
Returns:
an array of VoiceStatus objects, getMaxPolyphony() in length

isSoundbankSupported

public boolean isSoundbankSupported(Soundbank soundbank)
Returns true is this synth is capable of loading soundbank.
Parameters:
soundbank - the Soundbank to examine
Returns:
true if soundbank can be loaded, false otherwise

loadAllInstruments

public boolean loadAllInstruments(Soundbank soundbank)
Load all soundbank instruments into this synthesizer.
Parameters:
soundbank - the Soundbank from which to load instruments
Returns:
true if all instruments were loaded, false othewise
Throws:
IllegalArgumentException - if the soundbank isn't supported by this

loadInstrument

public boolean loadInstrument(Instrument instrument)
Load an instrument into this synth. The instrument must be part of a supported soundbank.
Parameters:
instrument - the Instrument to load
Returns:
true if the instrument was loaded and false otherwise
Throws:
IllegalArgumentException - if this synth doesn't support instrument

loadInstruments

public boolean loadInstruments(Soundbank soundbank,
                               Patch[] patchList)
Load a subset of soundbank instruments into this synthesizer. The subset is defined by an array of Patch objects.
Parameters:
soundbank - the Soundbank from which to load instruments
patchList - the array of patches identifying instruments to load
Returns:
true if instruments were loaded, false otherwise
Throws:
IllegalArgumentException - if the soundbank isn't supported by this

remapInstrument

public boolean remapInstrument(Instrument from,
                               Instrument to)
Move an intrument from one place to another. The instrument at the target location is unloaded.
Parameters:
from - the instrument source
to - the instrument target
Returns:
if from was remapped

unloadAllInstruments

public void unloadAllInstruments(Soundbank soundbank)
Unload all soundbank instruments from this synthesizer.
Parameters:
soundbank - the Soundbank containing the instruments to unload
Throws:
IllegalArgumentException - if the soundbank isn't supported by this

unloadInstrument

public void unloadInstrument(Instrument instrument)
Unload an instrument from this synth.
Parameters:
instrument - the Instrument to unload
Throws:
IllegalArgumentException - if this synth doesn't support instrument

unloadInstruments

public void unloadInstruments(Soundbank soundbank,
                              Patch[] patchList)
Unload a subset of soundbank instruments from this synthesizer.
Parameters:
soundbank - the Soundbank containing the instruments to unload
patchList - the array of patches identifying instruments to unload
Throws:
IllegalArgumentException - if the soundbank isn't supported by this

Synthesizer.java -- A MIDI audio synthesizer interface Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.