DMX Plugin Settings

Information about the DMX Plugin settings, including, among others, fixture categories and attributes.

Windows
MacOS
Linux
See Also
Prerequisite Topics

In order to understand and use the content on this page, make sure you are familiar with the following topics:

On this page

This page describes the settings for the DMX Plugin.

Plugin Setting

Description

Communication Settings

Input Ports

An array of input configurations for receiving DMX. Refer to the Input Ports section below for more details.

Output Ports

An array of output configurations for sending DMX. Refer to the Output Ports section below for more details

DMX Send Rate

The rate in hertz (Hz) to send out DMX. Default value is 30.

Send DMX by default

When enabled, the project sends DMX over the network. Default value is False.

Receive DMX by default

When enabled, the project receives DMX from the network. Default value is False.

Fixture Settings

Fixture Categories

Defines the fixture categories using a set of text elements. These categories are used inside your DMX Library inside the Fixture Type tab for the purposes of organizing and grouping the fixtures that you add to your scene.

By default, the plugin provides five generic categories.

Fixture Attributes

Internal naming convention used as an alias for imported fixture properties

  • Attribute Names: These names act as aliases for any functions that are imported into the project via GDTF files. Attributes are easily accessible from any part of the project and remove the dependence upon DMX libraries.

    Additionally, attributes solve the problem of mapping unpredictable imported function names to a generic list of terms that are easy to reference via dropdowns anywhere in the project.

  • Attribute Keywords: Keywords are the input names mapped to the defined attribute name. Any number of keywords can be mapped to a single attribute name, just ensure each keyword is separated by a comma or space.

DMX Ports can be referenced and used within the DMX Library. You can have different DMX Libraries using different Ports configurations to avoid DMX data collisions.

DMX Library port settings

Input Ports

Plugin Setting

Description

Port Name

User-defined name for the input port for easy identification.

Protocol Name

Specifies which DMX protocol to use. Options include:

  • Art-Net

  • sACN

Network Interface Card IP Address

The IP Address for the network card used for DMX control. By default, this is set to 0.0.0.0 which selects the primary network card determined by your operating system.

Local Universe Start

Location of the first Universe to receive DMX.

Amount of Universes

Number of Universes to use in the project.

Extern Universe Start

Offset to apply to the Universe start for external software or hardware.

For example, if Local Universe Start is set to 1 and Extern Universe Start is set to 20. Unreal will remap Universe 1 locally to Universe 20 on the receiving hardware.

Output Ports

Plugin Setting

Description

Port Name

User-defined name for the input port for easy identification.

Protocol Name

Specifies which DMX protocol to use. Options include:

  • Art-Net

  • sACN

Communication Type

The type of communication to use with the port. Options include:

  • Broadcast

  • Unicast

Network Interface Card IP Address

The IP Address for the network card used for DMX control. By default, this is set to 0.0.0.0 which selects the primary network card determined by your operating system.

Input into Engine

When enabled, output to this port is input to the engine. It will only show under output ports and will not be visible in Monitors as input.

Local Universe Start

Location of the first Universe to send DMX.

Amount of Universes

Number of Universes to use in the project.

Extern Universe Start

Offset to apply to the Universe start for external software or hardware.

For example, if Local Universe Start is set to 1 and Extern Universe Start is set to 20. Unreal will remap Universe 1 locally to Universe 20 on the receiving hardware.

Tags
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss