Libraries.Sound.Instrument Documentation
This class represents a MIDI instrument. A MIDI instrument consists of a number and a name. For a complete list of MIDI instruments specified by the General MIDI standard, see: http://www.midi.org/techspecs/gm1sound.php On most systems, these will be the only instruments available.
Example Code
use Libraries.Sound.Instrument
use Libraries.Sound.Music
Music music
Instrument piano = music:GetInstrument(0)
output piano:GetName()
output piano:GetValue()
Inherits from: Libraries.Language.Object
Summary
Actions Summary Table
Actions | Description |
---|---|
Compare(Libraries.Language.Object object) | This action compares two object hash codes and returns an integer. |
Equals(Libraries.Language.Object object) | This action determines if two objects are equal based on their hash code values. |
GetHashCode() | This action gets the hash code for an object. |
GetName() | Get the name of the instrument. |
GetValue() | Get the number of this instrument. |
SetName(text name) | Sets the name of the instrument. |
SetValue(integer value) | Sets the number of this instrument. |
Actions Documentation
Compare(Libraries.Language.Object object)
This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.
Example Code
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)
Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: The Compare result, Smaller, Equal, or Larger.
Equals(Libraries.Language.Object object)
This action determines if two objects are equal based on their hash code values.
Example Code
use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)
Parameters
- Libraries.Language.Object: The to be compared.
Return
boolean: True if the hash codes are equal and false if they are not equal.
GetHashCode()
This action gets the hash code for an object.
Example Code
Object o
integer hash = o:GetHashCode()
Return
integer: The integer hash code of the object.
GetName()
Get the name of the instrument.
Example Code
use Libraries.Sound.Instrument
use Libraries.Sound.Music
Music music
Instrument piano = music:GetInstrument(0)
output piano:GetName()
output piano:GetValue()
Return
text: the name of the instrument.
GetValue()
Get the number of this instrument.
Example Code
use Libraries.Sound.Instrument
use Libraries.Sound.Music
Music music
Instrument piano = music:GetInstrument(0)
output piano:GetName()
output piano:GetValue()
Return
integer: the number of this instrument.
SetName(text name)
Sets the name of the instrument. This should only be called by helper music classes.
Example Code
use Libraries.Sound.Instrument
use Libraries.Sound.Music
Music music
Instrument piano = music:GetInstrument(0)
piano:SetName("piano")
Parameters
- text name: the name to set.
SetValue(integer value)
Sets the number of this instrument. This should only be called by helper music classes.
Example Code
use Libraries.Sound.Instrument
use Libraries.Sound.Music
Music music
Instrument piano = music:GetInstrument(0)
piano:SetValue(0)
Parameters
- integer value: the number to set.