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 and Description
class	LXOscEngine.Receiver
class	LXOscEngine.Transmitter

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
static String	DEFAULT_RECEIVE_HOST
static int	DEFAULT_RECEIVE_PORT
static String	DEFAULT_TRANSMIT_HOST
static int	DEFAULT_TRANSMIT_PORT
BooleanParameter	receiveActive
StringParameter	receiveHost
DiscreteParameter	receivePort
BooleanParameter	transmitActive
StringParameter	transmitHost
DiscreteParameter	transmitPort
BooleanParameter	unknownReceiveHost
BooleanParameter	unknownTransmitHost

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
LXOscEngine(LX lx)

Method Summary

Modifier and Type	Method and Description
void	dispatch() Invoked by the main engine to dispatch all OSC messages on the input queue.
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)
static String	getOscAddress(LXParameter p) Gets the OSC address pattern for a parameter
static 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, InetAddress address)
LXOscEngine.Receiver	receiver(int port, InetAddress address, int bufferSize)
LXOscEngine.Receiver	receiver(int port, int bufferSize)
LXOscEngine.Receiver	receiver(int port, String host)
LXOscEngine	sendMessage(String path, int value)
LXOscEngine	sendParameter(LXParameter parameter)
LXOscEngine.Transmitter	transmitter(InetAddress address, int port)
LXOscEngine.Transmitter	transmitter(InetAddress address, int port, int bufferSize)
LXOscEngine.Transmitter	transmitter(String host, int port)

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, handleOscMessage, load, loadParameters, removeParameter, removeParameter, save, 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.LXPath

get, get, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getComponent, getComponent, getParameter, getParameter

Field Detail

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

receiveHost

public final StringParameter receiveHost

unknownReceiveHost

public final BooleanParameter unknownReceiveHost

receivePort

public final DiscreteParameter receivePort

transmitHost

public final StringParameter transmitHost

unknownTransmitHost

public final BooleanParameter unknownTransmitHost

transmitPort

public final DiscreteParameter transmitPort

receiveActive

public final BooleanParameter receiveActive

transmitActive

public final BooleanParameter transmitActive

Constructor Detail

LXOscEngine

public LXOscEngine(LX lx)

Method Detail

sendMessage

public LXOscEngine sendMessage(String path,
                               int 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

dispatch

public void dispatch()

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

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(Exception x,
                               String message)