Package heronarts.lx.output

Class DDPDatagram

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.output.LXOutput

heronarts.lx.output.LXBufferOutput

heronarts.lx.output.LXDatagram

heronarts.lx.output.DDPDatagram

All Implemented Interfaces:

LXPath, LXSerializable, LXOutput.InetOutput, LXParameterListener

public class DDPDatagram
extends LXDatagram

Distributed Display Protocol is a simple protocol developed by 3waylabs. It's a simple framing of raw color buffers, without DMX size limitations. The specification is available at http://www.3waylabs.com/ddp/

Nested Class Summary

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

LXDatagram.BufferException, LXDatagram.ErrorState

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

LXBufferOutput.ByteEncoder, LXBufferOutput.ByteOrder

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

LXOutput.GammaMode, LXOutput.GammaTable, LXOutput.InetOutput

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 int	DEFAULT_PORT
static final int	MAX_DATA_LENGTH

Fields inherited from class heronarts.lx.output.LXDatagram

buffer, error

Fields inherited from class heronarts.lx.output.LXBufferOutput

indexBuffer

Fields inherited from class heronarts.lx.output.LXOutput

brightness, enabled, framesPerSecond, gamma, gammaMode, MAX_FRAMES_PER_SECOND, whitePointBlue, whitePointGreen, whitePointRed, whitePointWhite

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.output.LXOutput.InetOutput

NO_PORT

Fields inherited from interface heronarts.lx.LXPath

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
DDPDatagram(LX lx, int[] indexBuffer)
DDPDatagram(LX lx, int[] indexBuffer, int dataOffset)
DDPDatagram(LX lx, int[] indexBuffer, LXBufferOutput.ByteOrder byteOrder, int dataOffset)
DDPDatagram(LX lx, LXModel model)
DDPDatagram(LX lx, IndexBuffer indexBuffer, int dataOffset)

Method Summary

Modifier and Type	Method	Description
protected int	getDataBufferOffset()	Offset into raw byte buffer where color data is written
DDPDatagram	setDataOffset(int offset)	Sets the data offset for this packet
DDPDatagram	setPushFlag(boolean push)	Sets whether the push flag is set on this datagram.

Methods inherited from class heronarts.lx.output.LXDatagram

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

Methods inherited from class heronarts.lx.output.LXBufferOutput

updateDataBuffer

Methods inherited from class heronarts.lx.output.LXOutput

error, error, load, log, onParameterChanged, send, send, setGammaDelegate, setGammaTable, setGammaTable, setGroup

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, assertDisposed, contains, copyParameters, dispose, 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, save, 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

MAX_DATA_LENGTH

public static final int MAX_DATA_LENGTH

See Also:

• Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

• Constant Field Values

Constructor Details

DDPDatagram

public DDPDatagram(LX lx,
 LXModel model)

DDPDatagram

public DDPDatagram(LX lx,
 int[] indexBuffer)

DDPDatagram

public DDPDatagram(LX lx,
 int[] indexBuffer,
 int dataOffset)

DDPDatagram

public DDPDatagram(LX lx,
 int[] indexBuffer,
 LXBufferOutput.ByteOrder byteOrder,
 int dataOffset)

DDPDatagram

public DDPDatagram(LX lx,
 IndexBuffer indexBuffer,
 int dataOffset)

Method Details

setPushFlag

public DDPDatagram setPushFlag(boolean push)

Sets whether the push flag is set on this datagram.

Parameters:

push - Whether push flag is true

Returns:

this

setDataOffset

public DDPDatagram setDataOffset(int offset)

Sets the data offset for this packet

Parameters:

offset - Offset into the remote data buffer

Returns:

this

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