LXMidiEngine (LX API)

java.lang.Object
- heronarts.lx.LXComponent
- - heronarts.lx.midi.LXMidiEngine

All Implemented Interfaces:

LXPath, LXSerializable, LXOscComponent, LXParameterListener
```
public class LXMidiEngine
extends LXComponent
implements LXOscComponent
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`LXMidiEngine.Channel`
`static interface`	`LXMidiEngine.DeviceListener`
`static interface`	`LXMidiEngine.MappingListener`

Nested classes/interfaces inherited from class heronarts.lx.LXComponent
LXComponent.Placeholder, LXComponent.Renamable

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

Field Summary

Fields
Modifier and Type	Field and Description
`BooleanParameter`	`computerKeyboardEnabled`
`List<LXMidiInput>`	`inputs`
`List<LXMidiMapping>`	`mappings`
`List<LXMidiOutput>`	`outputs`
`List<LXMidiSurface>`	`surfaces`

Fields inherited from class heronarts.lx.LXComponent
controlSurfaceSemaphore, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_PARAMETER_PATH, KEY_PATH, label, lx, modulationColor

Constructor Summary

Constructors
Constructor and Description

LXMidiEngine(LX lx)

Constructors
Constructor and Description
`LXMidiEngine(LX lx)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LXMidiEngine`	`addDeviceListener(LXMidiEngine.DeviceListener listener)`
`LXMidiEngine`	`addListener(LXMidiListener listener)`
`LXMidiEngine`	`addMapping(LXMidiMapping mapping)`
`LXMidiEngine`	`addMappingListener(LXMidiEngine.MappingListener listener)`
`void`	`dispatch()` Invoked by the main engine to dispatch all midi messages on the input queue.
`void`	`dispatch(LXShortMessage message)`
`void`	`dispose()` Invoked when a component is being removed from the system and will no longer be used at all.
`static void`	`error(Exception x, String message)`
`static void`	`error(String message)`
`LXMidiInput`	`findInput(String name)`
`List<LXMidiMapping>`	`findMappings(LXComponent component)`
`LXMidiOutput`	`findOutput(String name)`
`LXMidiSurface`	`findSurface(LXMidiInput input)`
`LXMidiSurface`	`findSurface(String name)`
`static String`	`getDeviceName(MidiDevice.Info deviceInfo)`
`List<LXMidiInput>`	`getInputs()`
`List<LXMidiOutput>`	`getOutputs()`
`boolean`	`handleOscMessage(OscMessage message, String[] parts, int index)` Handles an OSC message sent to this component.
`void`	`initialize()`
`void`	`load(LX lx, JsonObject object)` Loads the LX component.
`static void`	`log(String message)`
`LXMidiInput`	`matchInput(String name)`
`LXMidiInput`	`matchInput(String[] names)`
`LXMidiOutput`	`matchOutput(String name)`
`LXMidiOutput`	`matchOutput(String[] names)`
`LXMidiEngine`	`registerSurface(String deviceName, Class<? extends LXMidiSurface> surfaceClass)`
`LXMidiEngine`	`removeDeviceListener(LXMidiEngine.DeviceListener listener)`
`LXMidiEngine`	`removeListener(LXMidiListener listener)`
`LXMidiEngine`	`removeMapping(LXMidiMapping mapping)` Removes a midi mapping
`LXMidiEngine`	`removeMappingListener(LXMidiEngine.MappingListener listener)`
`LXMidiEngine`	`removeMappings(LXComponent component)` Called when a component is disposed.
`void`	`save(LX lx, JsonObject object)` Serializes the LX component.
`void`	`whenReady(Runnable runnable)` Executes the given code only after the MIDI engine initialization is done.

Methods inherited from class heronarts.lx.LXComponent
addArray, addChild, addInternalParameter, addParameter, addParameter, contains, copyParameters, getChild, getComponentName, getComponentName, getComponentName, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, getPath, loadParameters, onParameterChanged, removeParameter, removeParameter, saveParameters, setParent, 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.osc.LXOscComponent
getOscAddress

Methods inherited from interface heronarts.lx.LXPath
get, get, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getComponent, getComponent, getParameter, getParameter

- Field Detail
  - inputs
```
public final List<LXMidiInput> inputs
```
  - outputs
```
public final List<LXMidiOutput> outputs
```
  - surfaces
```
public final List<LXMidiSurface> surfaces
```
  - mappings
```
public final List<LXMidiMapping> mappings
```
  - computerKeyboardEnabled
```
public final BooleanParameter computerKeyboardEnabled
```
- Constructor Detail
  - LXMidiEngine
```
public LXMidiEngine(LX lx)
```
- Method Detail
  - registerSurface
```
public LXMidiEngine registerSurface(String deviceName,
                                    Class<? extends LXMidiSurface> surfaceClass)
```
  - initialize
```
public void initialize()
```
  - 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 LXComponent
  - getDeviceName
```
public static String getDeviceName(MidiDevice.Info deviceInfo)
```
  - whenReady
```
public void whenReady(Runnable runnable)
```
    Executes the given code only after the MIDI engine initialization is done. If it's done, then this will be run immediately on the thread that called it. If it is not done, then this will be run later on the LX engine thread in the sequential order of all calls made to whenReady
    
    Parameters:
    
    runnable - Code to run when MIDI engine is ready
  - getInputs
```
public List<LXMidiInput> getInputs()
```
  - getOutputs
```
public List<LXMidiOutput> getOutputs()
```
  - matchInput
```
public LXMidiInput matchInput(String name)
```
  - matchInput
```
public LXMidiInput matchInput(String[] names)
```
  - matchOutput
```
public LXMidiOutput matchOutput(String name)
```
  - matchOutput
```
public LXMidiOutput matchOutput(String[] names)
```
  - findSurface
```
public LXMidiSurface findSurface(LXMidiInput input)
```
  - findSurface
```
public LXMidiSurface findSurface(String name)
```
  - findOutput
```
public LXMidiOutput findOutput(String name)
```
  - findInput
```
public LXMidiInput findInput(String name)
```
  - addListener
```
public LXMidiEngine addListener(LXMidiListener listener)
```
  - removeListener
```
public LXMidiEngine removeListener(LXMidiListener listener)
```
  - addDeviceListener
```
public LXMidiEngine addDeviceListener(LXMidiEngine.DeviceListener listener)
```
  - removeDeviceListener
```
public LXMidiEngine removeDeviceListener(LXMidiEngine.DeviceListener listener)
```
  - addMappingListener
```
public LXMidiEngine addMappingListener(LXMidiEngine.MappingListener listener)
```
  - removeMappingListener
```
public LXMidiEngine removeMappingListener(LXMidiEngine.MappingListener listener)
```
  - handleOscMessage
```
public boolean handleOscMessage(OscMessage message,
                                String[] parts,
                                int index)
```
    Description copied from class: LXComponent
    
    Handles an OSC message sent to this component. By default this method handles registered components and parameters, but subclasses may override this method to handle different types of OSC messages.
    
    Specified by:
    
    handleOscMessage in interface LXOscComponent
    
    Overrides:
    
    handleOscMessage in class LXComponent
    
    Parameters:
    
    message - Full OSC message object
    
    parts - The OSC address pattern, broken into an array of parts
    
    index - Which index into the parts array corresponds to this component's children
    
    Returns:
    
    true if the OSC message was handled and should be considered consumed, false otherwise
  - addMapping
```
public LXMidiEngine addMapping(LXMidiMapping mapping)
```
  - removeMapping
```
public LXMidiEngine removeMapping(LXMidiMapping mapping)
```
    Removes a midi mapping
    
    Parameters:
    
    mapping - The mapping to remove
    
    Returns:
    
    this
  - findMappings
```
public List<LXMidiMapping> findMappings(LXComponent component)
```
  - removeMappings
```
public LXMidiEngine removeMappings(LXComponent component)
```
    Called when a component is disposed. Remove any midi mappings pointing to the now-nonexistent component.
    
    Parameters:
    
    component - Component to remove any midi mappings from
    
    Returns:
    
    this
  - dispatch
```
public void dispatch()
```
    Invoked by the main engine to dispatch all midi messages on the input queue.
  - dispatch
```
public void dispatch(LXShortMessage message)
```
  - save
```
public void save(LX lx,
                 JsonObject object)
```
    Description copied from class: LXComponent
    
    Serializes the LX component. By default, all internal and user-facing parameters are serialized, as well as any explicitly registered child components. Note that child arrays are not serialized, or any other dynamic components. Subclasses may override to perform more saving, and are expected to call super.save(lx, obj) at the appropriate time.
    
    Specified by:
    
    save in interface LXSerializable
    
    Overrides:
    
    save in class LXComponent
    
    Parameters:
    
    lx - LX instance
    
    object - Object to serialize into
  - load
```
public void load(LX lx,
                 JsonObject object)
```
    Description copied from class: LXComponent
    
    Loads the LX component. Restores the ID of the component, as well as its internal and user-facing parameters. Any explicitly registered children will be automatically loaded, so long as they are direct descendants. Dynamic arrays will not be automatically loaded, this is left to subclasses to implement.
    
    Specified by:
    
    load in interface LXSerializable
    
    Overrides:
    
    load in class LXComponent
    
    Parameters:
    
    lx - LX instance
    
    object - Object to deserialize
  - log
```
public static final void log(String message)
```
  - error
```
public static final void error(String message)
```
  - error
```
public static final void error(Exception x,
                               String message)
```

Class LXMidiEngine

Nested Class Summary

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

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

Field Summary

Fields inherited from class heronarts.lx.LXComponent

Constructor Summary

Method Summary

Methods inherited from class heronarts.lx.LXComponent

Methods inherited from class java.lang.Object

Methods inherited from interface heronarts.lx.osc.LXOscComponent

Methods inherited from interface heronarts.lx.LXPath

Field Detail

inputs

outputs

surfaces

mappings

computerKeyboardEnabled

Constructor Detail

LXMidiEngine

Method Detail

registerSurface

initialize

dispose

getDeviceName

whenReady

getInputs

getOutputs

matchInput

matchInput

matchOutput

matchOutput

findSurface

findSurface

findOutput

findInput

addListener

removeListener

addDeviceListener

removeDeviceListener

addMappingListener

removeMappingListener

handleOscMessage

addMapping

removeMapping

findMappings

removeMappings

dispatch

dispatch

save

load

log

error

error