public class

DLSInstrument

extends ModelInstrument
java.lang.Object
   ↳ javax.sound.midi.SoundbankResource
     ↳ javax.sound.midi.Instrument
       ↳ com.sun.media.sound.ModelInstrument
         ↳ com.sun.media.sound.DLSInstrument

Class Overview

This class is used to store information to describe instrument. It contains list of regions and modulators. It is stored inside a "ins " List Chunk inside DLS files. In the DLS documentation a modulator is called articulator.

Summary

Fields
protected int bank
protected boolean druminstrument
protected byte[] guid
protected DLSInfo info
protected List<DLSModulator> modulators
protected int preset
protected List<DLSRegion> regions
Public Constructors
DLSInstrument()
DLSInstrument(DLSSoundbank soundbank)
Public Methods
Object getData()
Obtains the sampled audio that is stored in this SoundbankResource.
byte[] getGuid()
DLSInfo getInfo()
List<DLSModulator> getModulators()
String getName()
Obtains the name of the resource.
ModelPatch getPatch()
Obtains the Patch object that indicates the bank and program numbers where this instrument is to be stored in the synthesizer.
ModelPerformer[] getPerformers()
List<DLSRegion> getRegions()
void setGuid(byte[] guid)
void setName(String name)
void setPatch(Patch patch)
String toString()
Returns a string representation of the object.
[Expand]
Inherited Methods
From class com.sun.media.sound.ModelInstrument
From class javax.sound.midi.Instrument
From class javax.sound.midi.SoundbankResource
From class java.lang.Object

Fields

protected int bank

protected boolean druminstrument

protected byte[] guid

protected DLSInfo info

protected List<DLSModulator> modulators

protected int preset

protected List<DLSRegion> regions

Public Constructors

public DLSInstrument ()

public DLSInstrument (DLSSoundbank soundbank)

Public Methods

public Object getData ()

Obtains the sampled audio that is stored in this SoundbankResource. The type of object returned depends on the implementation of the concrete class, and may be queried using getDataClass.

Returns
  • an object containing the sampled audio data

public byte[] getGuid ()

public DLSInfo getInfo ()

public List<DLSModulator> getModulators ()

public String getName ()

Obtains the name of the resource. This should generally be a string descriptive of the resource.

Returns
  • the instrument's name

public ModelPatch 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

public ModelPerformer[] getPerformers ()

public List<DLSRegion> getRegions ()

public void setGuid (byte[] guid)

public void setName (String name)

public void setPatch (Patch patch)

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: 

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
  • a string representation of the object.