Package heronarts.lx.midi.surface

Class LXMidiSurface

java.lang.Object

heronarts.lx.midi.surface.LXMidiSurface

All Implemented Interfaces:

LXSerializable, LXMidiListener, LXParameterListener

Direct Known Subclasses:

APC40, APC40Mk2, APCmini, DJM900nxs2, DJMA9, DJMV10, MidiFighterTwister

public abstract class LXMidiSurface
extends Object
implements LXMidiListener, LXSerializable, LXParameterListener

Nested Class Summary

Nested Classes

Modifier and Type	Class	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	Description
final BooleanParameter	enabled
final LXMidiInput	input	The midi input device for this control surface.
static final String	KEY_NAME
static final String	KEY_SETTINGS
static final String	KEY_STATE
protected final LX	lx
protected final LXParameter.Collection	mutableSettings
protected final LXParameter.Collection	mutableState
final LXMidiOutput	output	The midi output device for this control surface.
final Map<String,LXParameter>	settings
final Map<String,LXParameter>	state

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	addSetting(String key, LXListenableParameter setting)
protected void	addState(String key, LXListenableParameter state)
void	aftertouchReceived(MidiAftertouch aftertouch)
void	controlChangeReceived(MidiControlChange cc)
void	dispose()
LXMidiInput	getInput()
String	getName()
LXMidiOutput	getOutput()
int	getRemoteControlLength()
int	getRemoteControlStart()
boolean	isRemoteControlAux()
void	load(LX lx, JsonObject obj)	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
void	onParameterChanged(LXParameter p)	Invoked when the value of a parameter is changed.
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 obj)	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 Details

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

mutableSettings

protected final LXParameter.Collection mutableSettings

settings

public final Map<String,LXParameter> settings

mutableState

protected final LXParameter.Collection mutableState

state

public final Map<String,LXParameter> state

KEY_NAME

public static final String KEY_NAME

See Also:

• Constant Field Values

KEY_SETTINGS

public static final String KEY_SETTINGS

See Also:

• Constant Field Values

KEY_STATE

public static final String KEY_STATE

See Also:

• Constant Field Values

Constructor Details

LXMidiSurface

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

Method Details

onParameterChanged

public void onParameterChanged(LXParameter p)

Description copied from interface: LXParameterListener

Invoked when the value of a parameter is changed.

Specified by:

onParameterChanged in interface LXParameterListener

Parameters:

p - The parameter that has changed its value

addSetting

protected void addSetting(String key,
 LXListenableParameter setting)

addState

protected void addState(String key,
 LXListenableParameter state)

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)

getRemoteControlStart

public int getRemoteControlStart()

getRemoteControlLength

public int getRemoteControlLength()

isRemoteControlAux

public boolean isRemoteControlAux()

load

public void load(LX lx,
 JsonObject obj)

Description copied from interface: LXSerializable

Restores this instance from a JSON object

Specified by:

load in interface LXSerializable

Parameters:

lx - LX instance

obj - Object to deserialize

save

public void save(LX lx,
 JsonObject obj)

Description copied from interface: LXSerializable

Serializes this instance into the JSON object

Specified by:

save in interface LXSerializable

Parameters:

lx - LX instance

obj - 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

dispose

public void dispose()