Libraries.Sound.Playable Documentation

This class represents any kind of playable event in a music track. Playable events include any event that will sound one or more notes on the track. A Playable object has many properties, including: Pitch bends: A pitch bend can be constant, or occur before a note is played. Pitch bends are described using cents in the positive or negative direction. Bends between -200 and +200 cents are supported. Start time: The time at which the playing begins for this particular event. Start times are given using the constants defined in the Music class. In this implementation, start times are given as a delta time. In other words, it is the time *after* the last note was entered. For example, if we enter one note at time music:quarterNote and another at time music:wholeNote, the second note will be played at time music:quarterNote + music:wholeNote after the first one. Length: The duration that this note will sound. Lengths are also specified using the constants defined in the Music class. Volume: How loud the sound is (also known as velocity in MIDI terms). Volume is specified as a number between 0.0 and 1.0, inclusive.

Inherits from: Libraries.Language.Object, Libraries.Sound.MusicEvent

Summary

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.
GetConstantPitchBend()Get the constant pitch bend of this event in cents.
GetEventType()Returns the event type for this event.
GetHashCode()This action gets the hash code for an object.
GetLength()Get the length of the note.
GetPrePitchBend()Get the pre pitch bend of this event in cents.
GetPrePitchBendLength()Get the duration of pre pitch bend.
GetStartTime()Get the start time of the note.
GetVolume()Get the volume of the note.
SetConstantPitchBend(integer constantBend)Sets the constant pitch bend of this event in cents.
SetEventType(integer eventType)Set the event type for this event.
SetLength(number len)Set the length of the note.
SetPrePitchBend(integer preBend)Sets the pre pitch bend of this event in cents.
SetPrePitchBendLength(integer preBendLength)Set the duration of the pre pitch bend.
SetStartTime(integer time)Set the start time of the note.
SetVolume(number vol)Set the volume of the note.

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.

Return

Libraries.Language.Object: the new Playable

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.

GetConstantPitchBend()

Get the constant pitch bend of this event in cents.

Return

integer: the pitch bend

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.

GetLength()

Get the length of the note.

Return

number: the length

GetPrePitchBend()

Get the pre pitch bend of this event in cents.

Return

integer: the pre pitch bend in cents.

GetPrePitchBendLength()

Get the duration of pre pitch bend. The duration specifies how long it takes the bend to reach its target note.

Return

integer: the duration of the pre pitch bend.

GetStartTime()

Get the start time of the note.

Return

integer: the start time

GetVolume()

Get the volume of the note.

Return

number: the volume of the note.

SetConstantPitchBend(integer constantBend)

Sets the constant pitch bend of this event in cents.

Parameters

SetEventType(integer eventType)

Set the event type for this event.

Example Code

use Libraries.Sound.MusicEvent

        MusicEvent event
        event:SetEventType(0)

Parameters

SetLength(number len)

Set the length of the note.

Parameters

SetPrePitchBend(integer preBend)

Sets the pre pitch bend of this event in cents.

Parameters

SetPrePitchBendLength(integer preBendLength)

Set the duration of the pre pitch bend. The duration specifies how long it takes the bend to reach its target note.

Parameters

SetStartTime(integer time)

Set the start time of the note.

Parameters

SetVolume(number vol)

Set the volume of the note.

Parameters