Package heronarts.lx.midi.surface

Class APCminiSurface

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.midi.surface.LXMidiSurface

heronarts.lx.midi.surface.APCminiSurface

All Implemented Interfaces:

LXPath, LXSerializable, LXMidiListener, LXMidiSurface.Bidirectional, LXParameterListener

Direct Known Subclasses:

APCmini, APCminiMk2

public abstract class APCminiSurface
extends LXMidiSurface
implements LXMidiSurface.Bidirectional

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	APCminiSurface.ChannelButtonMode
static enum	APCminiSurface.GridMode

Nested classes/interfaces inherited from class heronarts.lx.midi.surface.LXMidiSurface

LXMidiSurface.Bidirectional, LXMidiSurface.DeviceName, LXMidiSurface.Name

Nested classes/interfaces inherited from class heronarts.lx.LXComponent

LXComponent.Description, LXComponent.Hidden, LXComponent.Placeholder, LXComponent.PluginRequired, LXComponent.Renamable

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CHANNEL_FADER
static final int	CHANNEL_FADER_MAX
static final int	CLIP_LAUNCH
static final int	CLIP_LAUNCH_COLUMNS
static final int	CLIP_LAUNCH_MAX
static final int	CLIP_LAUNCH_NUM
static final int	CLIP_LAUNCH_ROWS
final EnumParameter<LXMidiParameterControl.Mode>	faderMode
static final int	LED_BLINK
static final int	LED_OFF
static final int	LED_ON
static final int	MASTER_FADER
final BooleanParameter	masterFaderEnabled
static final int	MIDI_CHANNEL_SINGLE
protected final MixerSurface	mixerSurface
static final int	NUM_CHANNELS
static final int	PARAMETER_COLUMN_STRIDE
static final int	PARAMETER_COLUMNS
static final double	PARAMETER_INCREMENT_AMOUNT
static final int	PARAMETER_NUM
static final int	PARAMETER_ROW_STRIDE
static final int	PARAMETER_ROWS
static final int	PARAMETER_START

Fields inherited from class heronarts.lx.midi.surface.LXMidiSurface

connected, destinationDevice, enabled, KEY_CLASS, KEY_NAME, KEY_SETTINGS, KEY_STATE, lx, mutableSettings, mutableState, settings, sourceDevice, state

Fields inherited from class heronarts.lx.LXComponent

childArrays, children, internalParameters, KEY_CHILDREN, KEY_COMPONENT_ID, KEY_ID, KEY_INTERNAL, KEY_PARAMETER_PATH, KEY_PARAMETERS, KEY_PATH, KEY_RESET, label, legacyInternalParameters, legacyParameters, modulationColor, modulationControlsExpanded, modulationsExpanded, parameters, presetFile

Fields inherited from interface heronarts.lx.LXPath

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
APCminiSurface(LX lx, LXMidiInput input, LXMidiOutput output)

Method Summary

Modifier and Type	Method	Description
void	controlChangeReceived(MidiControlChange cc)
void	dispose()	Invoked when a component is being removed from the system and will no longer be used at all.
protected abstract heronarts.lx.midi.surface.APCminiSurface.LedDefinitions	getLedDefinitions()
protected abstract heronarts.lx.midi.surface.APCminiSurface.NoteDefinitions	getNoteDefinitions()
void	noteOffReceived(MidiNote note)
void	noteOnReceived(MidiNoteOn note)
protected void	onEnable(boolean on)	Subclasses may override, invoked automatically when surface is enabled/disabled.
void	onParameterChanged(LXParameter p)	Subclasses are free to override this if desired.
protected void	onReconnect()	Subclasses may override, invoked when the control surface was disconnected but has now reconnected, while still being in the enabled state.

Methods inherited from class heronarts.lx.midi.surface.LXMidiSurface

addSetting, addState, aftertouchReceived, getDeviceName, getDeviceName, getInput, getName, getOutput, getRemoteControlLength, getRemoteControlStart, getSurfaceName, getSurfaceName, hasRememberFlag, initializeDefaultIO, isRemoteControlAux, load, matches, pitchBendReceived, programChangeReceived, save, sendControlChange, sendNoteOn, sendSysex, setRememberFlag, sysexReceived

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, assertDisposed, contains, copyParameters, getCategory, getChild, getComponentDescription, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, getPath, handleOscMessage, hasParameter, isValidOscParameter, loadParameters, loadPreset, removeParameter, removeParameter, removeParameter, removeParameter, savePreset, setDescription, setParent, toOscQuery, toOscQuery, toOscQuery, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface heronarts.lx.midi.LXMidiListener

midiPanicReceived

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Field Details

NUM_CHANNELS

public static final int NUM_CHANNELS

See Also:

• Constant Field Values

PARAMETER_INCREMENT_AMOUNT

public static final double PARAMETER_INCREMENT_AMOUNT

See Also:

• Constant Field Values

CHANNEL_FADER

public static final int CHANNEL_FADER

See Also:

• Constant Field Values

CHANNEL_FADER_MAX

public static final int CHANNEL_FADER_MAX

See Also:

• Constant Field Values

MASTER_FADER

public static final int MASTER_FADER

See Also:

• Constant Field Values

CLIP_LAUNCH

public static final int CLIP_LAUNCH

See Also:

• Constant Field Values

CLIP_LAUNCH_ROWS

public static final int CLIP_LAUNCH_ROWS

See Also:

• Constant Field Values

CLIP_LAUNCH_COLUMNS

public static final int CLIP_LAUNCH_COLUMNS

See Also:

• Constant Field Values

CLIP_LAUNCH_NUM

public static final int CLIP_LAUNCH_NUM

See Also:

• Constant Field Values

CLIP_LAUNCH_MAX

public static final int CLIP_LAUNCH_MAX

See Also:

• Constant Field Values

PARAMETER_COLUMNS

public static final int PARAMETER_COLUMNS

See Also:

• Constant Field Values

PARAMETER_COLUMN_STRIDE

public static final int PARAMETER_COLUMN_STRIDE

See Also:

• Constant Field Values

PARAMETER_ROWS

public static final int PARAMETER_ROWS

See Also:

• Constant Field Values

PARAMETER_ROW_STRIDE

public static final int PARAMETER_ROW_STRIDE

See Also:

• Constant Field Values

PARAMETER_NUM

public static final int PARAMETER_NUM

See Also:

• Constant Field Values

PARAMETER_START

public static final int PARAMETER_START

See Also:

• Constant Field Values

MIDI_CHANNEL_SINGLE

public static final int MIDI_CHANNEL_SINGLE

See Also:

• Constant Field Values

LED_OFF

public static final int LED_OFF

See Also:

• Constant Field Values

LED_ON

public static final int LED_ON

See Also:

• Constant Field Values

LED_BLINK

public static final int LED_BLINK

See Also:

• Constant Field Values

mixerSurface

protected final MixerSurface mixerSurface

masterFaderEnabled

public final BooleanParameter masterFaderEnabled

faderMode

public final EnumParameter<LXMidiParameterControl.Mode> faderMode

Constructor Details

APCminiSurface

public APCminiSurface(LX lx,
 LXMidiInput input,
 LXMidiOutput output)

Method Details

getNoteDefinitions

protected abstract heronarts.lx.midi.surface.APCminiSurface.NoteDefinitions getNoteDefinitions()

getLedDefinitions

protected abstract heronarts.lx.midi.surface.APCminiSurface.LedDefinitions getLedDefinitions()

onParameterChanged

public void onParameterChanged(LXParameter p)

Description copied from class: LXComponent

Subclasses are free to override this if desired. It will automatically fire for any listenable parameter that is registered with this component.

Specified by:

onParameterChanged in interface LXParameterListener

Overrides:

onParameterChanged in class LXMidiSurface

Parameters:

p - Parameter that has a value change

onEnable

protected void onEnable(boolean on)

Description copied from class: LXMidiSurface

Subclasses may override, invoked automatically when surface is enabled/disabled. This is the typical place to send MIDI messages that configure the state and behavior of a MIDI control surface that has different modes or customization available

Overrides:

onEnable in class LXMidiSurface

Parameters:

on - Whether surface is enabled

onReconnect

protected void onReconnect()

Description copied from class: LXMidiSurface

Subclasses may override, invoked when the control surface was disconnected but has now reconnected, while still being in the enabled state.

Overrides:

onReconnect in class LXMidiSurface

noteOnReceived

public void noteOnReceived(MidiNoteOn note)

Specified by:

noteOnReceived in interface LXMidiListener

Overrides:

noteOnReceived in class LXMidiSurface

noteOffReceived

public void noteOffReceived(MidiNote note)

Specified by:

noteOffReceived in interface LXMidiListener

Overrides:

noteOffReceived in class LXMidiSurface

controlChangeReceived

public void controlChangeReceived(MidiControlChange cc)

Specified by:

controlChangeReceived in interface LXMidiListener

Overrides:

controlChangeReceived in class LXMidiSurface

dispose

public void dispose()

Description copied from class: LXComponent

Invoked when a component is being removed from the system and will no longer be used at all. This unregisters the component and should free up any resources and parameter listeners. Ideally after this method is called the object should be eligible for garbage collection. Subclasses are generally expected to override this method to handle their particular cleanup work. They should also generally call super.dispose() at the appropriate time to perform the basic cleanup, which may need to happen either before or after cleaning up other objects.

Overrides:

dispose in class LXMidiSurface