Class Instrument

java.lang.Object
javax.sound.midi.SoundbankResource
javax.sound.midi.Instrument
public abstract class Instrument extends SoundbankResource
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.
See Also:

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Instrument(Soundbank soundbank, Patch patch, String name, Class<?> dataClass)
    Constructs a new MIDI instrument from the specified Patch.

  • Method Summary

    Modifier and Type
    Method
    Description
    Patch
    getPatch()
    Obtains the Patch object that indicates the bank and program numbers where this instrument is to be stored in the synthesizer.

    Methods declared in class SoundbankResource

    getData, getDataClass, getName, getSoundbank
    Modifier and Type
    Method
    Description
    abstract Object
    getData()
    Obtains the sampled audio that is stored in this SoundbankResource.
    Class<?>
    getDataClass()
    Obtains the class used by this sample to represent its data.
    String
    getName()
    Obtains the name of the resource.
    Soundbank
    getSoundbank()
    Obtains the sound bank that contains this SoundbankResource.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • Instrument

      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
      See Also:

  • Method Details

    • getPatch

      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:
      this instrument's patch