APIdia Launch Partner
Top Description Fields Constructors Methods
javax.sound.midi

public abstract Class Instrument

extends SoundbankResource
Class Inheritance
Known Direct Subclasses
com.sun.media.sound.ModelInstrument, com.sun.media.sound.SoftInstrument
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.
Author
Kara Kytle
See Also
Soundbank, Soundbank#getInstruments, Patch, Synthesizer#loadInstrument(Instrument), MidiChannel#programChange(int, int)

Field Summary

Modifier and TypeField and Description
private final Patch
patch

Instrument patch.

Constructor Summary

AccessConstructor and Description
protected
Instrument(Soundbank
sound bank containing the instrument
soundbank, Patch
the patch of this instrument
patch, String
the name of this instrument
name, Class<?>
the class used to represent the sample's data
dataClass)

Constructs a new MIDI instrument from the specified Patch.

Method Summary

Modifier and TypeMethod and Description
public Patch

Returns:

this instrument's patch
getPatch()

Obtains the Patch object that indicates the bank and program numbers where this instrument is to be stored in the synthesizer.

Inherited from javax.sound.midi.SoundbankResource:
getDatagetDataClassgetNamegetSoundbank

Field Detail

patchback to summary
private final Patch patch

Instrument patch.

Constructor Detail

Instrumentback to summary
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:Soundbank

sound bank containing the instrument

patch:Patch

the patch of this instrument

name:String

the name of this instrument

dataClass:Class<?>

the class used to represent the sample's data

See Also
Synthesizer#loadInstrument(Instrument)

Method Detail

getPatchback to summary
public Patch getPatch()

Obtains the Patch object that indicates the bank and program numbers where this instrument is to be stored in the synthesizer.

Returns:Patch

this instrument's patch