Known Direct Subclasses
|
Known Indirect Subclasses
|
Class Overview
An instrument is a sound-synthesis algorithm with certain parameter
settings, usually designed to emulate a specific real-world
musical instrument or to achieve a specific sort of sound effect.
Instruments are typically stored in collections called soundbanks.
Before the instrument can be used to play notes, it must first be loaded
onto a synthesizer, and then it must be selected for use on
one or more channels, via a program-change command. MIDI notes
that are subsequently received on those channels will be played using
the sound of the selected instrument.
Summary
Public Methods |
Patch
|
getPatch()
Obtains the Patch object that indicates the bank and program
numbers where this instrument is to be stored in the synthesizer.
|
[Expand]
Inherited Methods |
From class
javax.sound.midi.SoundbankResource
|
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object .
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait()
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object.
|
final
void
|
wait(long timeout, int nanos)
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object, or
some other thread interrupts the current thread, or a certain
amount of real time has elapsed.
|
final
void
|
wait(long timeout)
Causes the current thread to wait until either another thread invokes the
notify() method or the
notifyAll() method for this object, or a
specified amount of time has elapsed.
|
|
Protected Constructors
protected
Instrument
(Soundbank soundbank, Patch patch, String name, Class<?> dataClass)
Constructs a new MIDI instrument from the specified Patch
.
When a subsequent request is made to load the
instrument, the sound bank will search its contents for this instrument's Patch
,
and the instrument will be loaded into the synthesizer at the
bank and program location indicated by the Patch
object.
Parameters
soundbank
| sound bank containing the instrument |
patch
| the patch of this instrument |
name
| the name of this instrument |
dataClass
| the class used to represent the sample's data. |
Public Methods
public
Patch
getPatch
()
Obtains the Patch
object that indicates the bank and program
numbers where this instrument is to be stored in the synthesizer.