net.kreatious.pianoleopard.midi.event

Enum Pedal

java.lang.Object

java.lang.Enum<Pedal>

net.kreatious.pianoleopard.midi.event.Pedal

All Implemented Interfaces:

Serializable, Comparable<Pedal>

public enum Pedal
extends Enum<Pedal>

Represents the various foot pedal

Author:

Jay-R Studer

Enum Constant Summary

Enum Constants

Enum Constant and Description
PORTAMENTO Portamento pedal.
SOFT Soft pedal.
SOSTENUTO Sostenuto pedal.
SUSTAIN Sustain pedal.

Method Summary

Modifier and Type	Method and Description
int	getData() Returns the raw MIDI data value associated with a control change message.
static Optional<Pedal>	lookup(int data) Determines the pedal enum associated with a MIDI data value.
static Pedal	valueOf(String name) Returns the enum constant of this type with the specified name.
static Pedal[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUSTAIN

public static final Pedal SUSTAIN

Sustain pedal.

While this pedal is pressed, played notes decay slowly. This sounds as if note off messages are ignored.

SOSTENUTO

public static final Pedal SOSTENUTO

Sostenuto pedal.

When this pedal is pressed, only the notes currently being played are sustained. Commonly abbreviated as S.P.

PORTAMENTO

public static final Pedal PORTAMENTO

Portamento pedal.

While this pedal is pressed, notes glide continuously in pitch from one to the next.

SOFT

public static final Pedal SOFT

Soft pedal.

While this pedal is pressed, notes are much quieter.

Method Detail

values

public static Pedal[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Pedal c : Pedal.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Pedal valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getData

public int getData()

Returns the raw MIDI data value associated with a control change message.

Returns:

the data1 value for a control change message using this pedal

lookup

public static Optional<Pedal> lookup(int data)

Determines the pedal enum associated with a MIDI data value.

Parameters:

data - the MIDI data1 value associated with a control change message

Returns:

an optional containing the pedal associated with the data, or empty