Libraries.Sound.MusicEvent Documentation

This class represents an event in a music track. This is the top level interface describing anything that can be put on a music track, such as Notes and Chords. This class defines constants to describe the various event types. Currently, the only event type supported is "noteOn", which is an event that will sound one or more notes.

Example Code

use Libraries.Sound.MusicEvent

    MusicEvent event
    event:SetEventType(0)

Inherits from: Libraries.Language.Object

Summary

Variable Summary Table

VariablesDescription
integer noteOnPublic constants. These represent the various event type

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
Copy()Perform a deep copy of this object.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetEventType()Returns the event type for this event.
GetHashCode()This action gets the hash code for an object.
SetEventType(integer eventType)Set the event type for this event.

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.

Copy()

Perform a deep copy of this object.

Example Code

use Libraries.Sound.MusicEvent

        MusicEvent event
        Object newEvent = event:Copy()

Return

Libraries.Language.Object: the new MusicEvent

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.

GetEventType()

Returns the event type for this event.

Example Code

use Libraries.Sound.MusicEvent

        MusicEvent event
        output event:GetEventType()

Return

integer: the event type.

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.

SetEventType(integer eventType)

Set the event type for this event.

Example Code

use Libraries.Sound.MusicEvent

        MusicEvent event
        event:SetEventType(0)

Parameters