|
jlscp v0.8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.linuxsampler.lscp.AbstractInstrument
org.linuxsampler.lscp.MidiInstrumentInfo
public class MidiInstrumentInfo
Provides information about a MIDI instrument.
Nested Class Summary | |
---|---|
static class |
MidiInstrumentInfo.LoadMode
|
Constructor Summary | |
---|---|
MidiInstrumentInfo()
Creates a new instance of MidiInstrumentInfo |
|
MidiInstrumentInfo(int mapId,
MidiInstrumentEntry entry)
Creates a new instance of MidiInstrumentInfo . |
|
MidiInstrumentInfo(int mapId,
MidiInstrumentEntry entry,
java.lang.String[] resultSet)
Creates a new instance of MidiInstrumentInfo and parses the
provided information about this instrument. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
Determines whether the specified object is of type MidiInstrumentInfo and has equal map ID, MIDI bank and MIDI program. |
java.lang.String |
getEngine()
Gets the name of the sampler engine to be used to load the instrument. |
MidiInstrumentEntry |
getEntry()
Gets the position of the MIDI instrument in a MIDI instrument map. |
java.lang.String |
getInstrumentName()
Gets the name of the loaded instrument as reflected by its file. |
MidiInstrumentInfo.LoadMode |
getLoadMode()
Gets the load mode of this MIDI instrument. |
int |
getMapId()
Gets the ID of the map containing this instrument. |
int |
getMidiBank()
Gets the index of the MIDI bank, containing this instrument. |
int |
getMidiProgram()
Gets the MIDI program number of this instrument. |
double |
getVolume()
Returns the volume, specified for this instrument, where a value < 1.0 means attenuation and a value > 1.0 means amplification. |
boolean |
parse(java.lang.String s)
Parses a line of text. |
void |
setEngine(java.lang.String engine)
Sets the name of the sampler engine to be used to load the instrument. |
void |
setLoadMode(MidiInstrumentInfo.LoadMode loadMode)
Sets the load mode of this MIDI instrument. |
void |
setVolume(double volume)
Sets the volume level for this instrument, where a value < 1.0 means attenuation and a value > 1.0 means amplification. |
Methods inherited from class org.linuxsampler.lscp.AbstractInstrument |
---|
getDescription, getFilePath, getFormatFamily, getFormatVersion, getInstrumentIndex, getKeyMapping, getKeyswitchMapping, getName, setFilePath, setInstrumentIndex, setName |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MidiInstrumentInfo()
MidiInstrumentInfo
public MidiInstrumentInfo(int mapId, MidiInstrumentEntry entry)
MidiInstrumentInfo
.
mapId
- The ID of the map containing this instrument.entry
- The instrument position in the map.public MidiInstrumentInfo(int mapId, MidiInstrumentEntry entry, java.lang.String[] resultSet) throws LscpException
MidiInstrumentInfo
and parses the
provided information about this instrument.
mapId
- The ID of the map containing this instrument.entry
- Provides the position of the MIDI instrument in the MIDI instrument map.resultSet
- An array with information categories about a MIDI instrument.
LscpException
- If the parse fails.Method Detail |
---|
public MidiInstrumentEntry getEntry()
public int getMapId()
public int getMidiBank()
public int getMidiProgram()
public java.lang.String getEngine()
getEngine
in interface Instrument
public void setEngine(java.lang.String engine)
engine
- The name of the sampler engine to be used to load the instrument.public java.lang.String getInstrumentName()
public double getVolume()
public void setVolume(double volume)
public MidiInstrumentInfo.LoadMode getLoadMode()
public void setLoadMode(MidiInstrumentInfo.LoadMode loadMode)
loadMode
- Specifies the load mode for this MIDI instrument.public boolean parse(java.lang.String s) throws LscpException
parse
in interface Parseable
parse
in class AbstractInstrument
s
- The string to be parsed.
true
if the line has been processed, false
otherwise.
LscpException
- If some error occurs.public boolean equals(java.lang.Object obj)
MidiInstrumentInfo
and has equal map ID, MIDI bank and MIDI program.
equals
in class java.lang.Object
obj
- The reference object with which to compare.
true
if the specified object is of type
MidiInstrumentInfo
and has equal map ID, MIDI bank and MIDI program.
|
jlscp v0.8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |