net.kreatious.pianoleopard.midi.event

Class NoteEvent

java.lang.Object

net.kreatious.pianoleopard.midi.event.Event

net.kreatious.pianoleopard.midi.event.NoteEvent

public class NoteEvent
extends Event

Represents a note on or off event that is associated with a particular key (note) number.

Author:

Jay-R Studer

Constructor Summary

Constructors

Constructor and Description
NoteEvent(int key, boolean on, long time) Constructs a new NoteEvent with the specified data.

Method Summary

Modifier and Type	Method and Description
NoteEvent	createOff(long offTime) Creates a new off event of the same type and slot with the specified timestamp.
int	getKey() Returns the note number associated with this event.
Slot	getSlot() Gets a slot that uniquely identifies which interval events belong to.
int	getVelocity() Returns the velocity associated with this event.
boolean	isOn() Gets if this event is an off to on transition.
boolean	isSharp() Returns if this note is considered sharp or not.

Methods inherited from class net.kreatious.pianoleopard.midi.event.Event

getChannel, getTime, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NoteEvent

public NoteEvent(int key,
                 boolean on,
                 long time)

Constructs a new NoteEvent with the specified data.

The channel will be 0 and velocity will be 127.

Parameters:

key - the raw MIDI key (note) for this event, between 0 and 127 inclusive

on - true if this event is a note on event, otherwise false

time - the time that this event occurs, in microseconds

Method Detail

getKey

public int getKey()

Returns the note number associated with this event.

MIDI note numbers range from 0 to 127, inclusive. Note C4 is number 60.

Returns:

the raw key (note) number associated with this event

getVelocity

public int getVelocity()

Returns the velocity associated with this event.

Velocity ranges from 0 to 127, inclusive.

Returns:

the velocity (loudness) associated with this event.

isSharp

public boolean isSharp()

Returns if this note is considered sharp or not.

Returns:

true if this note event is a sharp note, false otherwise.

isOn

public boolean isOn()

Description copied from class: Event

Gets if this event is an off to on transition.

Note that an event can transition from off to on multiple times before an on to off transition occurs.

Specified by:

isOn in class Event

Returns:

true if this event marks the start of an interval, false otherwise

getSlot

public Slot getSlot()

Description copied from class: Event

Gets a slot that uniquely identifies which interval events belong to.

Equal slots are events occurring for the same channel and key.

Specified by:

getSlot in class Event

Returns:

a uniquely identifying slot for this event

createOff

public NoteEvent createOff(long offTime)

Description copied from class: Event

Creates a new off event of the same type and slot with the specified timestamp.

Specified by:

createOff in class Event

Parameters:

offTime - the off time of the created event measured in microseconds

Returns:

a new event that is off but with the specified timestamp