heronarts.lx.output

Class StreamingACNDatagram

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.output.LXOutput

heronarts.lx.output.LXBufferOutput

heronarts.lx.output.LXDatagram

heronarts.lx.output.StreamingACNDatagram

All Implemented Interfaces:

LXPath, LXSerializable, LXOutput.InetOutput, LXParameterListener

public class StreamingACNDatagram
extends LXDatagram

Streaming ACN, also referred to as E1.31, is a standardized protocol for streaming DMX data over ACN protocol. It's a fairly simple UDP-based wrapper on 512 bytes of data with a 16-bit universe number. See: https://tsp.esta.org/tsp/documents/docs/ANSI_E1-31-2018.pdf

Nested Class Summary

Nested classes/interfaces inherited from class heronarts.lx.output.LXDatagram

LXDatagram.ErrorState

Nested classes/interfaces inherited from class heronarts.lx.output.LXBufferOutput

LXBufferOutput.ByteOrder

Nested classes/interfaces inherited from class heronarts.lx.output.LXOutput

LXOutput.GammaMode, LXOutput.InetOutput

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 int	MAX_DATA_LENGTH
protected static int	OFFSET_DMX_DATA
protected static int	OFFSET_SEQUENCE_NUMBER
protected static int	OFFSET_UNIVERSE_NUMBER

Fields inherited from class heronarts.lx.output.LXDatagram

buffer, error

Fields inherited from class heronarts.lx.output.LXBufferOutput

byteOrder, byteOrderBuffer, indexBuffer

Fields inherited from class heronarts.lx.output.LXOutput

brightness, enabled, framesPerSecond, gamma, gammaMode

Fields inherited from class heronarts.lx.LXComponent

controlSurfaceSemaphore, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_PARAMETER_PATH, KEY_PATH, label, lx, modulationColor

Fields inherited from interface heronarts.lx.output.LXOutput.InetOutput

NO_PORT

Constructor Summary

Constructors

Modifier	Constructor and Description
	StreamingACNDatagram(LX lx, int[] indexBuffer) Constructs a StreamingACNDatagram on default universe
	StreamingACNDatagram(LX lx, int[] indexBuffer, int universeNumber) Constructs a datagram, sends the list of point indices on the given universe number.
	StreamingACNDatagram(LX lx, int[] indexBuffer, int dataSize, int universeNumber) Creates a StreamingACNDatagram for a given index buffer with fixed data size and universe number
	StreamingACNDatagram(LX lx, int[] indexBuffer, LXBufferOutput.ByteOrder byteOrder, int universeNumber) Creates a StreamingACNDatagrm for given index buffer on universe and byte order
	StreamingACNDatagram(LX lx, int[] indexBuffer, LXBufferOutput.ByteOrder byteOrder, int dataSize, int universeNumber) Creates a StreamingACNDatagram for a given index buffer with fixed data size and universe number
protected	StreamingACNDatagram(LX lx, int dataSize, int universeNumber) Subclasses may use this constructor for datagrams with custom DMX data of a fixed length.
	StreamingACNDatagram(LX lx, LXModel model) Creates a StreamingACNDatagram for the given model
	StreamingACNDatagram(LX lx, LXModel model, int universeNumber) Creates a StreamingACNDatagram for the model on given universe

Method Summary

Modifier and Type	Method and Description
protected int	getDataBufferOffset() Offset into raw byte buffer where color data is written
int	getUniverseNumber() Universe number for datagram.
void	setDmxData(byte[] data, int channel)
void	setDmxData(byte data, int channel)
StreamingACNDatagram	setUniverseNumber(int universeNumber) Sets the universe for this datagram
protected void	updateSequenceNumber() Subclasses may override to update a sequence number in the packet when appropriate as part of the protocol.

Methods inherited from class heronarts.lx.output.LXDatagram

dispose, getAddress, getDataBuffer, getErrorState, getPort, onSend, setAddress, setPort, setSocket, validateBufferSize

Methods inherited from class heronarts.lx.output.LXBufferOutput

setByteOrder, setByteOrder, updateDataBuffer, updateIndexBuffer

Methods inherited from class heronarts.lx.output.LXOutput

error, error, getGammaLut, log, onParameterChanged, onSend, send, send, setGammaDelegate, setGroup

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

OFFSET_DMX_DATA

protected static final int OFFSET_DMX_DATA

See Also:

Constant Field Values

OFFSET_SEQUENCE_NUMBER

protected static final int OFFSET_SEQUENCE_NUMBER

See Also:

Constant Field Values

OFFSET_UNIVERSE_NUMBER

protected static final int OFFSET_UNIVERSE_NUMBER

See Also:

Constant Field Values

MAX_DATA_LENGTH

public static final int MAX_DATA_LENGTH

See Also:

Constant Field Values

Constructor Detail

StreamingACNDatagram

public StreamingACNDatagram(LX lx,
                            LXModel model)

Creates a StreamingACNDatagram for the given model

Parameters:

lx - LX instance

model - Model of points

StreamingACNDatagram

public StreamingACNDatagram(LX lx,
                            int[] indexBuffer)

Constructs a StreamingACNDatagram on default universe

Parameters:

lx - LX instance

indexBuffer - Points to send on this universe

StreamingACNDatagram

public StreamingACNDatagram(LX lx,
                            LXModel model,
                            int universeNumber)

Creates a StreamingACNDatagram for the model on given universe

Parameters:

lx - LX instance

model - Model of points

universeNumber - Universe number

StreamingACNDatagram

public StreamingACNDatagram(LX lx,
                            int[] indexBuffer,
                            int universeNumber)

Constructs a datagram, sends the list of point indices on the given universe number.

Parameters:

lx - LX instance

indexBuffer - List of point indices to encode in packet

universeNumber - Universe number

StreamingACNDatagram

public StreamingACNDatagram(LX lx,
                            int[] indexBuffer,
                            LXBufferOutput.ByteOrder byteOrder,
                            int universeNumber)

Creates a StreamingACNDatagrm for given index buffer on universe and byte order

Parameters:

lx - LX instance

indexBuffer - Index buffer

universeNumber - Universe number

byteOrder - Byte order

StreamingACNDatagram

protected StreamingACNDatagram(LX lx,
                               int dataSize,
                               int universeNumber)

Subclasses may use this constructor for datagrams with custom DMX data of a fixed length.

Parameters:

lx - LX instance

dataSize - Data size

universeNumber - Universe number

StreamingACNDatagram

public StreamingACNDatagram(LX lx,
                            int[] indexBuffer,
                            int dataSize,
                            int universeNumber)

Creates a StreamingACNDatagram for a given index buffer with fixed data size and universe number

Parameters:

lx - LX instance

indexBuffer - Index buffer

dataSize - Fixed DMX data size

universeNumber - Universe number

StreamingACNDatagram

public StreamingACNDatagram(LX lx,
                            int[] indexBuffer,
                            LXBufferOutput.ByteOrder byteOrder,
                            int dataSize,
                            int universeNumber)

Creates a StreamingACNDatagram for a given index buffer with fixed data size and universe number

Parameters:

lx - LX instance

indexBuffer - Index buffer

byteOrder - Byte order

dataSize - Fixed DMX data size

universeNumber - Universe number

Method Detail

setUniverseNumber

public StreamingACNDatagram setUniverseNumber(int universeNumber)

Sets the universe for this datagram

Parameters:

universeNumber - DMX universe

Returns:

this

getUniverseNumber

public int getUniverseNumber()

Universe number for datagram.

Returns:

Universe number

setDmxData

public void setDmxData(byte data,
                       int channel)

setDmxData

public void setDmxData(byte[] data,
                       int channel)

getDataBufferOffset

protected int getDataBufferOffset()

Description copied from class: LXBufferOutput

Offset into raw byte buffer where color data is written

Specified by:

getDataBufferOffset in class LXBufferOutput

Returns:

Offset into raw byte buffer for color data

updateSequenceNumber

protected void updateSequenceNumber()

Description copied from class: LXDatagram

Subclasses may override to update a sequence number in the packet when appropriate as part of the protocol.

Overrides:

updateSequenceNumber in class LXDatagram