net.kreatious.pianoleopard.midi

Class InputModel

java.lang.Object

net.kreatious.pianoleopard.midi.InputModel

All Implemented Interfaces:

AutoCloseable, ParsedTrack

public class InputModel
extends Object
implements AutoCloseable, ParsedTrack

Model for the MIDI input keyboard, allows controllers to listen for events.

Author:

Jay-R Studer

Method Summary

Modifier and Type	Method and Description
void	addInputDeviceListener(Consumer<? super MidiDevice.Info> listener) Adds a listener to notify when the input device has changed.
void	addInputListener(Consumer<? super Event> listener) Adds a listener to notify when the user has pressed a key
void	close()
static InputModel	create(OutputModel outputModel) Constructs a new InputModel with the specified initial state.
Iterable<EventPair<NoteEvent>>	getNotePairs(long low, long high) Gets the note event pairs overlapping with the specified interval
Iterable<EventPair<PedalEvent>>	getPedalPairs(long low, long high) Gets the pedal event pairs overlapping with the specified interval
void	setInputDevice(MidiDevice input) Reconnects the input to a different MIDI input device.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static InputModel create(OutputModel outputModel)
                         throws MidiUnavailableException

Constructs a new InputModel with the specified initial state.

After construction, the input model is not connected to any actual devices. It is expected that the consumer will change the input device.

Parameters:

outputModel - the output model to coordinate with

Returns:

a new instance of InputModel. The caller is responsible for releasing the resource.

Throws:

MidiUnavailableException - if the MIDI system is unavailable.

setInputDevice

public void setInputDevice(MidiDevice input)
                    throws MidiUnavailableException

Reconnects the input to a different MIDI input device.

Parameters:

input - the new input MIDI device to reconnect to

Throws:

MidiUnavailableException - if the MIDI system is unavailable.

addInputDeviceListener

public void addInputDeviceListener(Consumer<? super MidiDevice.Info> listener)

Adds a listener to notify when the input device has changed.

Parameters:

listener - the listener to add

addInputListener

public void addInputListener(Consumer<? super Event> listener)

Adds a listener to notify when the user has pressed a key

Parameters:

listener - the listener to add

close

public void close()

Specified by:

close in interface AutoCloseable

getNotePairs

public Iterable<EventPair<NoteEvent>> getNotePairs(long low,
                                                   long high)

Description copied from interface: ParsedTrack

Gets the note event pairs overlapping with the specified interval

Specified by:

getNotePairs in interface ParsedTrack

Parameters:

low - the lower inclusive bound to return events for in microseconds

high - the upper inclusive bound to return events for in microseconds

Returns:

a read only view of the portion of events overlapping the specified interval.

getPedalPairs

public Iterable<EventPair<PedalEvent>> getPedalPairs(long low,
                                                     long high)

Description copied from interface: ParsedTrack

Gets the pedal event pairs overlapping with the specified interval

Specified by:

getPedalPairs in interface ParsedTrack

Parameters:

low - the lower inclusive bound to return events for in microseconds

high - the upper inclusive bound to return events for in microseconds

Returns:

a read only view of the portion of events overlapping the specified interval.