jp.kshoji.javax.sound.midi

Interface Synthesizer

All Superinterfaces:

MidiDevice

public interface Synthesizer
extends MidiDevice

Interface for MIDI Synthesizer

Author:

K.Shoji

Nested Class Summary

Nested classes/interfaces inherited from interface jp.kshoji.javax.sound.midi.MidiDevice

MidiDevice.Info

Method Summary

Modifier and Type	Method and Description
Instrument[]	getAvailableInstruments() Get the all available Instruments
MidiChannel[]	getChannels() Get the all of MidiChannels
Soundbank	getDefaultSoundbank() Get the default Soundbank
long	getLatency() Get the latency in microseconds
Instrument[]	getLoadedInstruments() Get the all loaded Instruments
int	getMaxPolyphony() Get the maximum count of polyphony
VoiceStatus[]	getVoiceStatus() Get the current VoiceStatus of the Synthesizer
boolean	isSoundbankSupported(Soundbank soundbank) Check if the specified Soundbank is supported
boolean	loadAllInstruments(Soundbank soundbank) Load all instruments belongs specified Soundbank
boolean	loadInstrument(Instrument instrument) Load the specified Instrument
boolean	loadInstruments(Soundbank soundbank, Patch[] patchList) Load all instruments belongs specified Soundbank and Patches
boolean	remapInstrument(Instrument from, Instrument to) Remap an Instrument
void	unloadAllInstruments(Soundbank soundbank) Unload all instruments belongs specified Soundbank
void	unloadInstrument(Instrument instrument) Unload the specified Instrument
void	unloadInstruments(Soundbank soundbank, Patch[] patchList) Unload all instruments belongs specified Soundbank and Patches

Methods inherited from interface jp.kshoji.javax.sound.midi.MidiDevice

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

Method Detail

getChannels

@NonNull
MidiChannel[] getChannels()

Get the all of MidiChannels

Returns:

the array of MidiChannel

getLatency

long getLatency()

Get the latency in microseconds

Returns:

the latency in microseconds

getMaxPolyphony

int getMaxPolyphony()

Get the maximum count of polyphony

Returns:

the maximum count of polyphony

getVoiceStatus

@NonNull
VoiceStatus[] getVoiceStatus()

Get the current VoiceStatus of the Synthesizer

Returns:

the array of VoiceStatus

getDefaultSoundbank

@Nullable
Soundbank getDefaultSoundbank()

Get the default Soundbank

Returns:

the Soundbank

isSoundbankSupported

boolean isSoundbankSupported(@NonNull
                             Soundbank soundbank)

Check if the specified Soundbank is supported

Parameters:

soundbank - the Soundbank

Returns:

true if the Soundbank is supported

getAvailableInstruments

@NonNull
Instrument[] getAvailableInstruments()

Get the all available Instruments

Returns:

the array of Instrument

getLoadedInstruments

@NonNull
Instrument[] getLoadedInstruments()

Get the all loaded Instruments

Returns:

the array of Instrument

remapInstrument

boolean remapInstrument(@NonNull
                        Instrument from,
                        @NonNull
                        Instrument to)

Remap an Instrument

Parameters:

from - to be replaced

to - the new Instrument

Returns:

true if succeed to remap

loadAllInstruments

boolean loadAllInstruments(@NonNull
                           Soundbank soundbank)

Load all instruments belongs specified Soundbank

Parameters:

soundbank - the Soundbank

Returns:

true if succeed to load

unloadAllInstruments

void unloadAllInstruments(@NonNull
                          Soundbank soundbank)

Unload all instruments belongs specified Soundbank

Parameters:

soundbank - the Soundbank

loadInstrument

boolean loadInstrument(@NonNull
                       Instrument instrument)

Load the specified Instrument

Parameters:

instrument - the instrument

Returns:

true if succeed to load

unloadInstrument

void unloadInstrument(@NonNull
                      Instrument instrument)

Unload the specified Instrument

Parameters:

instrument - the instrument

loadInstruments

boolean loadInstruments(@NonNull
                        Soundbank soundbank,
                        @NonNull
                        Patch[] patchList)

Load all instruments belongs specified Soundbank and Patches

Parameters:

soundbank - the the Soundbank

patchList - the array of Patch

Returns:

true if succeed to load

unloadInstruments

void unloadInstruments(@NonNull
                       Soundbank soundbank,
                       @NonNull
                       Patch[] patchList)

Unload all instruments belongs specified Soundbank and Patches

Parameters:

soundbank - the the Soundbank

patchList - the array of Patch