APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.media.sound

public final Class DLSInstrument

extends ModelInstrument
Class Inheritance
Imports
java.util.ArrayList, .Arrays, .HashMap, .List, .Map, javax.sound.midi.Patch
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.
Author
Karl Helgason

Field Summary

Modifier and TypeField and Description
pack-priv int
bank

pack-priv boolean
druminstrument

pack-priv byte[]
guid

pack-priv DLSInfo
info

pack-priv List<DLSModulator>
modulators

pack-priv int
preset

pack-priv List<DLSRegion>
regions

Constructor Summary

AccessConstructor and Description
public
DLSInstrument()

public
DLSInstrument(DLSSoundbank soundbank)

Method Summary

Modifier and TypeMethod and Description
private ModelConnectionBlock
convertToModel(DLSModulator mod)

private ModelIdentifier
convertToModelDest(int dest)

private ModelIdentifier
convertToModelSrc(int src)

public Object
getData()

Implements abstract javax.sound.midi.SoundbankResource.getData.

Obtains the sampled audio that is stored in this SoundbankResource.

public byte[]
getGuid()

public DLSInfo
getInfo()

public List<DLSModulator>
getModulators()

public String
getName()

Overrides javax.sound.midi.SoundbankResource.getName.

Obtains the name of the resource.

public ModelPatch
getPatch()

Overrides javax.sound.midi.Instrument.getPatch.

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

public ModelPerformer[]
getPerformers()

Overrides com.sun.media.sound.ModelInstrument.getPerformers.

public List<DLSRegion>
getRegions()

public void
setGuid(byte[] guid)

public void
setName(String name)

public void
setPatch(Patch patch)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from com.sun.media.sound.ModelInstrument:
getChannelMixergetChannelsgetDirectorgetKeysgetPatchAlias

Field Detail

bankback to summary
pack-priv int bank
druminstrumentback to summary
pack-priv boolean druminstrument
guidback to summary
pack-priv byte[] guid
infoback to summary
pack-priv DLSInfo info
modulatorsback to summary
pack-priv List<DLSModulator> modulators
presetback to summary
pack-priv int preset
regionsback to summary
pack-priv List<DLSRegion> regions

Constructor Detail

DLSInstrumentback to summary
public DLSInstrument()
DLSInstrumentback to summary
public DLSInstrument(DLSSoundbank soundbank)

Method Detail

convertToModelback to summary
private ModelConnectionBlock convertToModel(DLSModulator mod)
convertToModelDestback to summary
private ModelIdentifier convertToModelDest(int dest)
convertToModelSrcback to summary
private ModelIdentifier convertToModelSrc(int src)
getDataback to summary
public Object getData()

Implements abstract javax.sound.midi.SoundbankResource.getData.

Doc from javax.sound.midi.SoundbankResource.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.

Annotations
@Override
getGuidback to summary
public byte[] getGuid()
getInfoback to summary
public DLSInfo getInfo()
getModulatorsback to summary
public List<DLSModulator> getModulators()
getNameback to summary
public String getName()

Overrides javax.sound.midi.SoundbankResource.getName.

Doc from javax.sound.midi.SoundbankResource.getName.

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

Annotations
@Override
getPatchback to summary
public ModelPatch getPatch()

Overrides javax.sound.midi.Instrument.getPatch.

Doc from javax.sound.midi.Instrument.getPatch.

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

Annotations
@Override
getPerformersback to summary
public ModelPerformer[] getPerformers()

Overrides com.sun.media.sound.ModelInstrument.getPerformers.

Annotations
@Override
getRegionsback to summary
public List<DLSRegion> getRegions()
setGuidback to summary
public void setGuid(byte[] guid)
setNameback to summary
public void setName(String name)
setPatchback to summary
public void setPatch(Patch patch)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override