Instrument (javamod 2.2 API)

java.lang.Object
- de.quippy.javamod.multimedia.mod.loader.instrument.Instrument

```
public class Instrument
extends Object
```
Since:

19.06.2006

Author:

Daniel Becker

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`defaultPan`
`String`	`dosFileName`
`int`	`dublicateNoteAction`
`int`	`dublicateNoteCheck`
`int`	`globalVolume`
`int`	`initialFilterCutoff`
`int`	`initialFilterResonance`
`String`	`name`
`int`	`NNA`
`int[]`	`noteIndex`
`Envelope`	`panningEnvelope`
`Envelope`	`pitchEnvelope`
`int`	`pitchPanCenter`
`int`	`pitchPanSeparation`
`int`	`randomPanningVariation`
`int`	`randomVolumeVariation`
`int[]`	`sampleIndex`
`Envelope`	`volumeEnvelope`
`int`	`volumeFadeOut`

Constructor Summary

Constructors
Constructor and Description

Instrument()
Constructor for Instrument

Constructors
Constructor and Description
`Instrument()` Constructor for Instrument

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getNoteIndex(int noteIndex)`
`int`	`getSampleIndex(int noteIndex)`
`void`	`setDefaultPan(int defaultPan)`
`void`	`setDosFileName(String dosFileName)`
`void`	`setDublicateNoteAction(int dublicateNoteAction)`
`void`	`setDublicateNoteCheck(int dublicateNoteCheck)`
`void`	`setGlobalVolume(int globalVolume)`
`void`	`setIndexArray(int[] sampleIndexArray)` Sets the Samplearray
`void`	`setInitialFilterCutoff(int initialFilterCutoff)`
`void`	`setInitialFilterResonance(int initialFilterResonance)`
`void`	`setName(String name)`
`void`	`setNNA(int nna)`
`void`	`setNoteArray(int[] noteIndexArray)`
`void`	`setPanningEnvelope(Envelope panningEnvelope)`
`void`	`setPitchEnvelope(Envelope pitchEnvelope)`
`void`	`setPitchPanCenter(int pitchPanCenter)`
`void`	`setPitchPanSeparation(int pitchPanSeparation)`
`void`	`setRandomPanningVariation(int randomPanningVariation)`
`void`	`setRandomVolumeVariation(int randomVolumeVariation)`
`void`	`setVolumeEnvelope(Envelope volumeEnvelope)`
`void`	`setVolumeFadeOut(int volumeFadeOut)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sampleIndex
```
public int[] sampleIndex
```

noteIndex
```
public int[] noteIndex
```

volumeEnvelope
```
public Envelope volumeEnvelope
```

panningEnvelope
```
public Envelope panningEnvelope
```

volumeFadeOut
```
public int volumeFadeOut
```

name
```
public String name
```

pitchEnvelope
```
public Envelope pitchEnvelope
```

dosFileName
```
public String dosFileName
```

dublicateNoteCheck
```
public int dublicateNoteCheck
```

dublicateNoteAction
```
public int dublicateNoteAction
```

NNA
```
public int NNA
```

pitchPanSeparation
```
public int pitchPanSeparation
```

pitchPanCenter
```
public int pitchPanCenter
```

globalVolume
```
public int globalVolume
```

defaultPan
```
public int defaultPan
```

randomVolumeVariation
```
public int randomVolumeVariation
```

randomPanningVariation
```
public int randomPanningVariation
```

initialFilterCutoff
```
public int initialFilterCutoff
```

initialFilterResonance
```
public int initialFilterResonance
```

Constructor Detail
- Instrument
```
public Instrument()
```
  Constructor for Instrument

Method Detail
- setIndexArray
```
public void setIndexArray(int[] sampleIndexArray)
```
  Sets the Samplearray
  
  Parameters:
  sampleIndexArray -
  Since:
  
  19.06.2006
- setNoteArray
```
public void setNoteArray(int[] noteIndexArray)
```
- getSampleIndex
```
public int getSampleIndex(int noteIndex)
```
- getNoteIndex
```
public int getNoteIndex(int noteIndex)
```
- setPanningEnvelope
```
public void setPanningEnvelope(Envelope panningEnvelope)
```
- setVolumeEnvelope
```
public void setVolumeEnvelope(Envelope volumeEnvelope)
```
- setPitchEnvelope
```
public void setPitchEnvelope(Envelope pitchEnvelope)
```
- setName
```
public void setName(String name)
```
  Parameters:
  name - The name to set.
- setDosFileName
```
public void setDosFileName(String dosFileName)
```
  Parameters:
  dosFileName - the dosFileName to set
- setVolumeFadeOut
```
public void setVolumeFadeOut(int volumeFadeOut)
```
  Parameters:
  volumeFadeOut - The volumeFadeOut to set.
- setDublicateNoteCheck
```
public void setDublicateNoteCheck(int dublicateNoteCheck)
```
  Parameters:
  dublicateNoteCheck - the dublicateNoteCheck to set
- setDublicateNoteAction
```
public void setDublicateNoteAction(int dublicateNoteAction)
```
  Parameters:
  dublicateNodeAction - the dublicateNodeAction to set
- setNNA
```
public void setNNA(int nna)
```
  Parameters:
  nna - the NewNoteAction to set
- setPitchPanSeparation
```
public void setPitchPanSeparation(int pitchPanSeparation)
```
  Parameters:
  pitchPanSeparation - the pitchPanSeparation to set
- setPitchPanCenter
```
public void setPitchPanCenter(int pitchPanCenter)
```
  Parameters:
  pitchPanCenter - the pitchPanCenter to set
- setGlobalVolume
```
public void setGlobalVolume(int globalVolume)
```
  Parameters:
  globalVolume - the globalVolume to set
- setDefaultPan
```
public void setDefaultPan(int defaultPan)
```
  Parameters:
  defaultPan - the defaultPan to set
- setRandomVolumeVariation
```
public void setRandomVolumeVariation(int randomVolumeVariation)
```
  Parameters:
  randomVolumeVariation - the randomVolumeVariation to set
- setRandomPanningVariation
```
public void setRandomPanningVariation(int randomPanningVariation)
```
  Parameters:
  randomPanningVariation - the randomPanningVariation to set
- setInitialFilterCutoff
```
public void setInitialFilterCutoff(int initialFilterCutoff)
```
  Parameters:
  initialFilterCutoff - the initialFilterCutoff to set
- setInitialFilterResonance
```
public void setInitialFilterResonance(int initialFilterResonance)
```
  Parameters:
  initialFilterResonance - the initialFilterResonance to set
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
  
  Returns:
  See Also:
  Object.toString()

Class Instrument

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sampleIndex

noteIndex

volumeEnvelope

panningEnvelope

volumeFadeOut

name

pitchEnvelope

dosFileName

dublicateNoteCheck

dublicateNoteAction

NNA

pitchPanSeparation

pitchPanCenter

globalVolume

defaultPan

randomVolumeVariation

randomPanningVariation

initialFilterCutoff

initialFilterResonance

Constructor Detail

Instrument

Method Detail

setIndexArray

setNoteArray

getSampleIndex

getNoteIndex

setPanningEnvelope

setVolumeEnvelope

setPitchEnvelope

setName

setDosFileName

setVolumeFadeOut

setDublicateNoteCheck

setDublicateNoteAction

setNNA

setPitchPanSeparation

setPitchPanCenter

setGlobalVolume

setDefaultPan

setRandomVolumeVariation

setRandomPanningVariation

setInitialFilterCutoff

setInitialFilterResonance

toString