This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
javax.sound.midi
class Patch
public class Patch
extends Object
A Patch
object represents a location, on a MIDI
synthesizer, into which a single instrument is stored (loaded).
Every Instrument
object has its own Patch
object that specifies the memory location
into which that instrument should be loaded. The
location is specified abstractly by a bank index and a program number (not by
any scheme that directly refers to a specific address or offset in RAM).
This is a hierarchical indexing scheme: MIDI provides for up to 16384 banks,
each of which contains up to 128 program locations. For example, a
minimal sort of synthesizer might have only one bank of instruments, and
only 32 instruments (programs) in that bank.
To select what instrument should play the notes on a particular MIDI
channel, two kinds of MIDI message are used that specify a patch location:
a bank-select command, and a program-change channel command. The Java Sound
equivalent is the
{@link MidiChannel#programChange(int, int) programChange(int, int)}
method of MidiChannel
.
Constructor Summary |
Patch(int bank, int program)
Constructs a new patch object from the specified bank and program
numbers.
|
Method Summary |
int |
Returns the number of the bank that contains the instrument
whose location this Patch specifies.
|
int |
Returns the index, within
a bank, of the instrument whose location this Patch specifies.
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Patch
public Patch(int bank,
int program)
-
Constructs a new patch object from the specified bank and program
numbers.
- Parameters:
bank
- the bank index (in the range from 0 to 16383)
program
- the program index (in the range from 0 to 127)
getBank
public int getBank()
-
Returns the number of the bank that contains the instrument
whose location this
Patch
specifies.
- Returns:
- the bank number, whose range is from 0 to 16383
getProgram
public int getProgram()
-
Returns the index, within
a bank, of the instrument whose location this
Patch
specifies.
- Returns:
- the instrument's program number, whose range is from 0 to 127
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.