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

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.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetName()

Get the name of the instrument.

Return

text: the name of the instrument.

Example

use Libraries.Sound.Instrument
use Libraries.Sound.Music

Music music
Instrument piano = music:GetInstrument(0)

output piano:GetName()
output piano:GetValue()

GetValue()

Get the number of this instrument.

Return

integer: the number of this instrument.

Example

use Libraries.Sound.Instrument
use Libraries.Sound.Music

Music music
Instrument piano = music:GetInstrument(0)

output piano:GetName()
output piano:GetValue()

SetName(text name)

Sets the name of the instrument. This should only be called by helper music classes.

Parameters

  • text name: the name to set.

Example

use Libraries.Sound.Instrument
use Libraries.Sound.Music

Music music
Instrument piano = music:GetInstrument(0)

piano:SetName("piano")

SetValue(integer value)

Sets the number of this instrument. This should only be called by helper music classes.

Parameters

  • integer value: the number to set.

Example

use Libraries.Sound.Instrument
use Libraries.Sound.Music

Music music
Instrument piano = music:GetInstrument(0)

piano:SetValue(0)