Package heronarts.lx.output

Class DDPOutputGroup

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.output.LXOutput

heronarts.lx.output.LXOutputGroup

heronarts.lx.output.DDPOutputGroup

All Implemented Interfaces:

LXPath, LXSerializable, LXOutput.InetOutput, LXParameterListener

public class DDPOutputGroup
extends LXOutputGroup
implements LXOutput.InetOutput

DDPOutput is a helper class that constructs and sends a set of DDPDatagram packets based upon a specified chunk size, which will typically be a function of either the LED layout or UDP network settings. If greater customization over framing and chunking is required, it may be preferable to construct DDPDatagram packets manually.

Nested Class Summary

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.Hidden, LXComponent.Placeholder, 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_CHUNK_SIZE

Fields inherited from class heronarts.lx.output.LXOutputGroup

children

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

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

ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
DDPOutputGroup(LX lx, int[] indexBuffer)
DDPOutputGroup(LX lx, int[] indexBuffer, int chunkSize)	Constructs a DDPOutput with a given total set of points and a specified chunkSize.
DDPOutputGroup(LX lx, LXModel model)
DDPOutputGroup(LX lx, LXModel model, int chunkSize)

Method Summary

Modifier and Type	Method	Description
InetAddress	getAddress()
int	getPort()
LXOutput.InetOutput	setAddress(InetAddress address)
LXOutput.InetOutput	setPort(int port)
DDPOutputGroup	setPushAll(boolean pushAll)	Configures whether the push flag is set for all individual DDP datagram packets, or whether it is only set on the final DDP packet.

Methods inherited from class heronarts.lx.output.LXOutputGroup

addChild, clearChildren, onSend, removeChild

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, contains, copyParameters, dispose, getCategory, getChild, 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, getCanonicalPath, getCanonicalPath, isDescendant

Field Details

DEFAULT_CHUNK_SIZE

public static final int DEFAULT_CHUNK_SIZE

See Also:

• Constant Field Values

Constructor Details

DDPOutputGroup

public DDPOutputGroup(LX lx,
 LXModel model)

DDPOutputGroup

public DDPOutputGroup(LX lx,
 LXModel model,
 int chunkSize)

DDPOutputGroup

public DDPOutputGroup(LX lx,
 int[] indexBuffer)

DDPOutputGroup

public DDPOutputGroup(LX lx,
 int[] indexBuffer,
 int chunkSize)

Constructs a DDPOutput with a given total set of points and a specified chunkSize. By default, the DDP Push flag is only set on the final packet.

Parameters:

lx - LX instance

indexBuffer - All of the points to send

chunkSize - Number of points to chunk per packet

Method Details

setPushAll

public DDPOutputGroup setPushAll(boolean pushAll)

Configures whether the push flag is set for all individual DDP datagram packets, or whether it is only set on the final DDP packet. Note that setting the push flag for all packets may result in some visual tearing if chunk size does not fall across wiring boundaries.

Parameters:

pushAll - Whether to set the push flag on all packets

Returns:

this

setAddress

public LXOutput.InetOutput setAddress(InetAddress address)

Specified by:

setAddress in interface LXOutput.InetOutput

getAddress

public InetAddress getAddress()

Specified by:

getAddress in interface LXOutput.InetOutput

setPort

public LXOutput.InetOutput setPort(int port)

Specified by:

setPort in interface LXOutput.InetOutput

getPort

public int getPort()

Specified by:

getPort in interface LXOutput.InetOutput