Package heronarts.lx.osc

Class LXOscEngine

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.osc.LXOscEngine

All Implemented Interfaces:

LXPath, LXSerializable, LXParameterListener

public class LXOscEngine
extends LXComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LXOscEngine.IOListener
static enum	LXOscEngine.IOState
class	LXOscEngine.Receiver
class	LXOscEngine.Transmitter

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

LXComponent.Description, LXComponent.Hidden, LXComponent.Name, 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 String	DEFAULT_RECEIVE_HOST
static final int	DEFAULT_RECEIVE_PORT
static final String	DEFAULT_TRANSMIT_HOST
static final int	DEFAULT_TRANSMIT_PORT
final List<LXOscConnection.Input>	inputs
final BooleanParameter	logInput
final BooleanParameter	logOutput
final List<LXOscConnection.Output>	outputs
final BooleanParameter	receiveActive
final TriggerParameter	receiveActivity
final StringParameter	receiveHost
final DiscreteParameter	receivePort
final EnumParameter<LXOscEngine.IOState>	receiveState
final BooleanParameter	transmitActive
final TriggerParameter	transmitActivity
final StringParameter	transmitHost
final DiscreteParameter	transmitPort
final EnumParameter<LXOscEngine.IOState>	transmitState
final BooleanParameter	unknownReceiveHost
final BooleanParameter	unknownTransmitHost

Fields inherited from class heronarts.lx.LXComponent

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

Fields inherited from interface heronarts.lx.LXPath

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
LXOscEngine(LX lx)

Method Summary

Modifier and Type	Method	Description
LXOscConnection.Input	addInput()
LXOscConnection.Input	addInput(JsonObject inputObj, int index)
LXOscConnection.Input	addInput(LXOscConnection.Input input)
LXOscConnection.Input	addInput(LXOscConnection.Input input, int index)
LXOscEngine	addIOListener(LXOscEngine.IOListener listener)
LXOscEngine	addListener(LXOscListener listener)
LXOscConnection.Output	addOutput()
LXOscConnection.Output	addOutput(JsonObject outputObj, int index)
LXOscConnection.Output	addOutput(LXOscConnection.Output output)
LXOscConnection.Output	addOutput(LXOscConnection.Output output, int index)
void	dispatch()	Invoked by the main engine to dispatch OSC messages on the input queue of all the receivers
void	dispose()	Invoked when a component is being removed from the system and will no longer be used at all.
static final void	error(String message)
static final void	error(Throwable x, String message)
static String	getOscAddress(LXParameter p)	Gets the OSC address pattern for a parameter
void	load(LX lx, JsonObject obj)	Loads the LX component.
static final void	log(String message)
void	onParameterChanged(LXParameter p)	Subclasses are free to override this if desired.
LXOscEngine.Receiver	receiver(int port)
LXOscEngine.Receiver	receiver(int port, int bufferSize)
LXOscEngine.Receiver	receiver(int port, String host)
LXOscEngine.Receiver	receiver(int port, InetAddress address)
LXOscEngine.Receiver	receiver(int port, InetAddress address, int bufferSize)
LXOscEngine	removeInput(LXOscConnection.Input input)
LXOscEngine	removeIOListener(LXOscEngine.IOListener listener)
LXOscEngine	removeListener(LXOscListener listener)
LXOscEngine	removeOutput(LXOscConnection.Output output)
void	save(LX lx, JsonObject obj)	Serializes the LX component.
LXOscEngine	sendMessage(String path, float value)
LXOscEngine	sendMessage(String path, int value)
LXOscEngine	sendMessage(String path, String value)
LXOscEngine	sendParameter(LXParameter parameter)
LXOscEngine.Transmitter	transmitter(String host, int port)
LXOscEngine.Transmitter	transmitter(InetAddress address, int port)
LXOscEngine.Transmitter	transmitter(InetAddress address, int port, int bufferSize)

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.LXPath

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

Field Details

DEFAULT_RECEIVE_PORT

public static final int DEFAULT_RECEIVE_PORT

See Also:

• Constant Field Values

DEFAULT_TRANSMIT_PORT

public static final int DEFAULT_TRANSMIT_PORT

See Also:

• Constant Field Values

DEFAULT_RECEIVE_HOST

public static final String DEFAULT_RECEIVE_HOST

See Also:

• Constant Field Values

DEFAULT_TRANSMIT_HOST

public static final String DEFAULT_TRANSMIT_HOST

See Also:

• Constant Field Values

receiveActive

public final BooleanParameter receiveActive

receiveHost

public final StringParameter receiveHost

unknownReceiveHost

public final BooleanParameter unknownReceiveHost

receiveState

public final EnumParameter<LXOscEngine.IOState> receiveState

receiveActivity

public final TriggerParameter receiveActivity

receivePort

public final DiscreteParameter receivePort

transmitActive

public final BooleanParameter transmitActive

transmitHost

public final StringParameter transmitHost

unknownTransmitHost

public final BooleanParameter unknownTransmitHost

transmitState

public final EnumParameter<LXOscEngine.IOState> transmitState

transmitActivity

public final TriggerParameter transmitActivity

transmitPort

public final DiscreteParameter transmitPort

logInput

public final BooleanParameter logInput

logOutput

public final BooleanParameter logOutput

inputs

public final List<LXOscConnection.Input> inputs

outputs

public final List<LXOscConnection.Output> outputs

Constructor Details

LXOscEngine

public LXOscEngine(LX lx)

Method Details

addIOListener

public LXOscEngine addIOListener(LXOscEngine.IOListener listener)

removeIOListener

public LXOscEngine removeIOListener(LXOscEngine.IOListener listener)

addListener

public LXOscEngine addListener(LXOscListener listener)

removeListener

public LXOscEngine removeListener(LXOscListener listener)

sendMessage

public LXOscEngine sendMessage(String path,
 int value)

sendMessage

public LXOscEngine sendMessage(String path,
 float value)

sendMessage

public LXOscEngine sendMessage(String path,
 String value)

sendParameter

public LXOscEngine sendParameter(LXParameter parameter)

getOscAddress

public static String getOscAddress(LXParameter p)

Gets the OSC address pattern for a parameter

Parameters:

p - parameter

Returns:

OSC address

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

receiver

public LXOscEngine.Receiver receiver(int port,
 String host)
                              throws SocketException,
UnknownHostException

Throws:

SocketException

UnknownHostException

receiver

public LXOscEngine.Receiver receiver(int port,
 InetAddress address)
                              throws SocketException

Throws:

SocketException

receiver

public LXOscEngine.Receiver receiver(int port,
 InetAddress address,
 int bufferSize)
                              throws SocketException

Throws:

SocketException

receiver

public LXOscEngine.Receiver receiver(int port)
                              throws SocketException

Throws:

SocketException

receiver

public LXOscEngine.Receiver receiver(int port,
 int bufferSize)
                              throws SocketException

Throws:

SocketException

transmitter

public LXOscEngine.Transmitter transmitter(String host,
 int port)
                                    throws SocketException,
UnknownHostException

Throws:

SocketException

UnknownHostException

transmitter

public LXOscEngine.Transmitter transmitter(InetAddress address,
 int port)
                                    throws SocketException

Throws:

SocketException

transmitter

public LXOscEngine.Transmitter transmitter(InetAddress address,
 int port,
 int bufferSize)
                                    throws SocketException

Throws:

SocketException

addInput

public LXOscConnection.Input addInput()

addInput

public LXOscConnection.Input addInput(LXOscConnection.Input input)

addInput

public LXOscConnection.Input addInput(JsonObject inputObj,
 int index)

addInput

public LXOscConnection.Input addInput(LXOscConnection.Input input,
 int index)

removeInput

public LXOscEngine removeInput(LXOscConnection.Input input)

addOutput

public LXOscConnection.Output addOutput()

addOutput

public LXOscConnection.Output addOutput(LXOscConnection.Output output)

addOutput

public LXOscConnection.Output addOutput(JsonObject outputObj,
 int index)

addOutput

public LXOscConnection.Output addOutput(LXOscConnection.Output output,
 int index)

removeOutput

public LXOscEngine removeOutput(LXOscConnection.Output output)

dispatch

public void dispatch()

Invoked by the main engine to dispatch OSC messages on the input queue of all the receivers

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

log

public static final void log(String message)

error

public static final void error(String message)

error

public static final void error(Throwable x,
 String message)