heronarts.lx.midi.surface

Class LXMidiSurface

java.lang.Object

heronarts.lx.midi.surface.LXMidiSurface

All Implemented Interfaces:

LXSerializable, LXMidiListener

Direct Known Subclasses:

APC40Mk2, DJM900nxs2

public abstract class LXMidiSurface
extends Object
implements LXMidiListener, LXSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LXMidiSurface.Bidirectional Marker interface for Midi Surface implementations which require an output to be functional.

Nested classes/interfaces inherited from interface heronarts.lx.LXSerializable

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field and Description
BooleanParameter	enabled
LXMidiInput	input The midi input device for this control surface.
static String	KEY_NAME
protected LX	lx
LXMidiOutput	output The midi output device for this control surface.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LXMidiSurface(LX lx, LXMidiInput input, LXMidiOutput output)

Method Summary

Modifier and Type	Method and Description
void	aftertouchReceived(MidiAftertouch aftertouch)
void	controlChangeReceived(MidiControlChange cc)
LXMidiInput	getInput()
String	getName()
LXMidiOutput	getOutput()
void	load(LX lx, JsonObject object) Restores this instance from a JSON object
void	noteOffReceived(MidiNote note)
void	noteOnReceived(MidiNoteOn note)
protected void	onEnable(boolean isOn) Subclasses may override, invoked automatically when surface is enabled/disabled
protected void	onReconnect() Subclasses may override, invoked when the control surface was disconnected but has now reconnected.
void	pitchBendReceived(MidiPitchBend pitchBend)
void	programChangeReceived(MidiProgramChange pc)
void	save(LX lx, JsonObject object) Serializes this instance into the JSON object
protected void	sendControlChange(int channel, int cc, int value)
protected void	sendNoteOn(int channel, int note, int velocity)

Methods inherited from class java.lang.Object

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

Field Detail

lx

protected final LX lx

input

public final LXMidiInput input

The midi input device for this control surface. Never null.

output

public final LXMidiOutput output

The midi output device for this control surface. May be null in cases where the control surface does not implement the OutputRequired interface

enabled

public final BooleanParameter enabled

KEY_NAME

public static final String KEY_NAME

See Also:

Constant Field Values

Constructor Detail

LXMidiSurface

protected LXMidiSurface(LX lx,
                        LXMidiInput input,
                        LXMidiOutput output)

Method Detail

getName

public String getName()

getInput

public LXMidiInput getInput()

getOutput

public LXMidiOutput getOutput()

onEnable

protected void onEnable(boolean isOn)

Subclasses may override, invoked automatically when surface is enabled/disabled

Parameters:

isOn - Whether surface is enabled

onReconnect

protected void onReconnect()

Subclasses may override, invoked when the control surface was disconnected but has now reconnected. Re-initialization may be necessary.

sendNoteOn

protected void sendNoteOn(int channel,
                          int note,
                          int velocity)

sendControlChange

protected void sendControlChange(int channel,
                                 int cc,
                                 int value)

load

public void load(LX lx,
                 JsonObject object)

Description copied from interface: LXSerializable

Restores this instance from a JSON object

Specified by:

load in interface LXSerializable

Parameters:

lx - LX instance

object - Object to deserialize

save

public void save(LX lx,
                 JsonObject object)

Description copied from interface: LXSerializable

Serializes this instance into the JSON object

Specified by:

save in interface LXSerializable

Parameters:

lx - LX instance

object - Object to serialize into

noteOnReceived

public void noteOnReceived(MidiNoteOn note)

Specified by:

noteOnReceived in interface LXMidiListener

noteOffReceived

public void noteOffReceived(MidiNote note)

Specified by:

noteOffReceived in interface LXMidiListener

controlChangeReceived

public void controlChangeReceived(MidiControlChange cc)

Specified by:

controlChangeReceived in interface LXMidiListener

programChangeReceived

public void programChangeReceived(MidiProgramChange pc)

Specified by:

programChangeReceived in interface LXMidiListener

pitchBendReceived

public void pitchBendReceived(MidiPitchBend pitchBend)

Specified by:

pitchBendReceived in interface LXMidiListener

aftertouchReceived

public void aftertouchReceived(MidiAftertouch aftertouch)

Specified by:

aftertouchReceived in interface LXMidiListener