LXMixerEngine (LX API)

java.lang.Object
- heronarts.lx.LXComponent
- - heronarts.lx.mixer.LXMixerEngine

All Implemented Interfaces:

LXPath, LXSerializable, LXOscComponent, LXParameterListener
```
public class LXMixerEngine
extends LXComponent
implements LXOscComponent
```
Encapsulation of all the LX channel blending and mixer

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface LXMixerEngine.Listener
- Nested classes/interfaces inherited from class heronarts.lx.LXComponent
  LXComponent.Placeholder, LXComponent.Renamable
- Nested classes/interfaces inherited from interface heronarts.lx.LXSerializable
  LXSerializable.Utils

Nested Classes
Modifier and Type	Class and Description
`static interface`	`LXMixerEngine.Listener`

Field Summary

Fields
Modifier and Type	Field and Description
`List<LXAbstractChannel>`	`channels`
`CompoundParameter`	`crossfader`
`ObjectParameter<LXBlend>`	`crossfaderBlendMode`
`BooleanParameter`	`cueA`
`BooleanParameter`	`cueB`
`DiscreteParameter`	`focusedChannel`
`LXMasterBus`	`masterBus`
`static String`	`PATH_CHANNEL`
`static String`	`PATH_FOCUSED`
`static String`	`PATH_MASTER`
`BooleanParameter`	`viewCondensed`

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

LXMixerEngine(LX lx)

Constructors
Constructor and Description
`LXMixerEngine(LX lx)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LXChannel`	`addChannel()`
`LXChannel`	`addChannel(int index)`
`LXChannel`	`addChannel(int index, LXPattern[] patterns)`
`LXChannel`	`addChannel(LXPattern[] patterns)`
`LXGroup`	`addGroup()`
`LXGroup`	`addGroup(int index)`
`LXGroup`	`addGroup(List<LXChannel> groupChannels)`
`LXGroup`	`addGroupFromSelection()`
`LXMixerEngine`	`addListener(LXMixerEngine.Listener listener)`
`void`	`clear()`
`LXMixerEngine`	`deselectChannel(LXBus bus)`
`void`	`dispose()` Invoked when a component is being removed from the system and will no longer be used at all.
`LXAbstractChannel`	`getChannel(int channelIndex)`
`LXAbstractChannel`	`getChannel(String label)`
`List<LXAbstractChannel>`	`getChannels()`
`LXChannel`	`getDefaultChannel()`
`LXBus`	`getFocusedChannel()`
`LXAbstractChannel`	`getLastChannel()`
`BooleanParameter`	`getScene(int index)` Get the boolean parameter that launches a scene
`List<LXChannel>`	`getSelectedChannelsForGroup()`
`LXMixerEngine`	`group(LXGroup group, LXChannel channel, int index)`
`boolean`	`handleOscMessage(OscMessage message, String[] parts, int index)` Handles an OSC message sent to this component.
`protected LXBlend[]`	`instantiateChannelBlends()`
`protected LXBlend[]`	`instantiateCrossfaderBlends()`
`protected LXBlend[]`	`instantiateTransitionBlends()`
`LXMixerEngine`	`launchScene(int index)` Launches the scene at given index
`void`	`load(LX lx, JsonObject obj)` Loads the LX component.
`void`	`loadChannel(JsonObject channelObj)`
`void`	`loadChannel(JsonObject channelObj, int index)`
`void`	`loop(LXEngine.Frame render, double deltaMs)`
`void`	`moveChannel(LXAbstractChannel channel, int delta)`
`void`	`onParameterChanged(LXParameter p)` Subclasses are free to override this if desired.
`void`	`removeChannel(LXAbstractChannel channel)`
`LXMixerEngine`	`removeListener(LXMixerEngine.Listener listener)`
`void`	`removeSelectedChannels()`
`void`	`save(LX lx, JsonObject obj)` Serializes the LX component.
`LXMixerEngine`	`selectChannel(LXBus bus)`
`LXMixerEngine`	`selectChannel(LXBus bus, boolean multipleSelection)`
`LXMixerEngine`	`selectChannelRange(LXBus destination)`
`LXMixerEngine`	`setFocusedChannel(LXBus channel)`
`LXMixerEngine`	`stopClips()` Stops all running clips
`LXMixerEngine`	`ungroup(LXChannel channel)`

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, 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
  - channels
```
public final List<LXAbstractChannel> channels
```
  - masterBus
```
public final LXMasterBus masterBus
```
  - focusedChannel
```
public final DiscreteParameter focusedChannel
```
  - crossfader
```
public final CompoundParameter crossfader
```
  - crossfaderBlendMode
```
public final ObjectParameter<LXBlend> crossfaderBlendMode
```
  - cueA
```
public final BooleanParameter cueA
```
  - cueB
```
public final BooleanParameter cueB
```
  - viewCondensed
```
public final BooleanParameter viewCondensed
```
  - PATH_CHANNEL
```
public static final String PATH_CHANNEL
```
    See Also:
    
    Constant Field Values
  - PATH_FOCUSED
```
public static final String PATH_FOCUSED
```
    See Also:
    
    Constant Field Values
  - PATH_MASTER
```
public static final String PATH_MASTER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LXMixerEngine
```
public LXMixerEngine(LX lx)
```
- Method Detail
  - addListener
```
public final LXMixerEngine addListener(LXMixerEngine.Listener listener)
```
  - removeListener
```
public final LXMixerEngine removeListener(LXMixerEngine.Listener listener)
```
  - 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 LXComponent
    
    Parameters:
    
    p - Parameter that has a value change
  - getScene
```
public BooleanParameter getScene(int index)
```
    Get the boolean parameter that launches a scene
    
    Parameters:
    
    index - Index of scene
    
    Returns:
    
    Scene at index
  - launchScene
```
public LXMixerEngine launchScene(int index)
```
    Launches the scene at given index
    
    Parameters:
    
    index - Scene index
    
    Returns:
    
    this
  - stopClips
```
public LXMixerEngine stopClips()
```
    Stops all running clips
    
    Returns:
    
    this
  - 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
  - instantiateChannelBlends
```
protected LXBlend[] instantiateChannelBlends()
```
  - instantiateTransitionBlends
```
protected LXBlend[] instantiateTransitionBlends()
```
  - instantiateCrossfaderBlends
```
protected LXBlend[] instantiateCrossfaderBlends()
```
  - getChannels
```
public List<LXAbstractChannel> getChannels()
```
  - getDefaultChannel
```
public LXChannel getDefaultChannel()
```
  - getLastChannel
```
public LXAbstractChannel getLastChannel()
```
  - getChannel
```
public LXAbstractChannel getChannel(int channelIndex)
```
  - getChannel
```
public LXAbstractChannel getChannel(String label)
```
  - getFocusedChannel
```
public LXBus getFocusedChannel()
```
  - setFocusedChannel
```
public LXMixerEngine setFocusedChannel(LXBus channel)
```
  - deselectChannel
```
public LXMixerEngine deselectChannel(LXBus bus)
```
  - selectChannel
```
public LXMixerEngine selectChannel(LXBus bus)
```
  - selectChannel
```
public LXMixerEngine selectChannel(LXBus bus,
                                   boolean multipleSelection)
```
  - selectChannelRange
```
public LXMixerEngine selectChannelRange(LXBus destination)
```
  - addChannel
```
public LXChannel addChannel()
```
  - addChannel
```
public LXChannel addChannel(int index)
```
  - addChannel
```
public LXChannel addChannel(LXPattern[] patterns)
```
  - addChannel
```
public LXChannel addChannel(int index,
                            LXPattern[] patterns)
```
  - group
```
public LXMixerEngine group(LXGroup group,
                           LXChannel channel,
                           int index)
```
  - ungroup
```
public LXMixerEngine ungroup(LXChannel channel)
```
  - addGroupFromSelection
```
public LXGroup addGroupFromSelection()
```
  - addGroup
```
public LXGroup addGroup()
```
  - addGroup
```
public LXGroup addGroup(int index)
```
  - addGroup
```
public LXGroup addGroup(List<LXChannel> groupChannels)
```
  - getSelectedChannelsForGroup
```
public List<LXChannel> getSelectedChannelsForGroup()
```
  - removeSelectedChannels
```
public void removeSelectedChannels()
```
  - removeChannel
```
public void removeChannel(LXAbstractChannel channel)
```
  - moveChannel
```
public void moveChannel(LXAbstractChannel channel,
                        int delta)
```
  - loop
```
public void loop(LXEngine.Frame render,
                 double deltaMs)
```
  - save
```
public void save(LX lx,
                 JsonObject obj)
```
    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
    
    obj - Object to serialize into
  - load
```
public void load(LX lx,
                 JsonObject obj)
```
    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
    
    obj - Object to deserialize
  - 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
  - clear
```
public void clear()
```
  - loadChannel
```
public void loadChannel(JsonObject channelObj)
```
  - loadChannel
```
public void loadChannel(JsonObject channelObj,
                        int index)
```

Class LXMixerEngine

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

channels

masterBus

focusedChannel

crossfader

crossfaderBlendMode

cueA

cueB

viewCondensed

PATH_CHANNEL

PATH_FOCUSED

PATH_MASTER

Constructor Detail

LXMixerEngine

Method Detail

addListener

removeListener

onParameterChanged

getScene

launchScene

stopClips

handleOscMessage

instantiateChannelBlends

instantiateTransitionBlends

instantiateCrossfaderBlends

getChannels

getDefaultChannel

getLastChannel

getChannel

getChannel

getFocusedChannel

setFocusedChannel

deselectChannel

selectChannel

selectChannel

selectChannelRange

addChannel

addChannel

addChannel

addChannel

group

ungroup

addGroupFromSelection

addGroup

addGroup

addGroup

getSelectedChannelsForGroup

removeSelectedChannels

removeChannel

moveChannel

loop

save

load

dispose

clear

loadChannel

loadChannel