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

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
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 a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Object o
        Object t
        CompareResult result = o:Compare(t)

Parameters

Return

Libraries.Language.Support.CompareResult: 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

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

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