Navigation
| Name | DMXProtocol |
| Type | Plugin |
| Part of Plugins | DMX Protocol |
| Location | /Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/ |
| Module Build Rules | DMXProtocol.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FDMXConversions | Common conversions for dmx |
| FDMXInputPort | Higher level abstraction of a DMX input hiding networking specific and protocol specific complexity from the game. |
| FDMXOutputPort | Higher level abstraction of a DMX input hiding networking specific and protocol specific complexity. |
| FDMXPort | Base class for a higher level abstraction of a DMX input or output. |
| FDMXPortManager | Manager for all DMX ports. |
| FDMXProtocolModule | Implements the Protocol Module, that enables specific Protocol implementations. |
| FDMXProtocolUtils | |
| FDMXRawListener | Listen to all DMX data of a port. |
| FDMXSignal | A single, generic DMX signal. One universe of raw DMX data received |
| UDMXAttributeNameConversions | |
| UDMXNameContainersConversions | |
| UDMXProtocolBlueprintLibrary | |
| UDMXProtocolSettings | DMX Project Settings. |
Structs
| Name | Remarks |
|---|---|
| FDMXAttribute | |
| FDMXAttributeName | |
| FDMXFixtureCategory | Category of a fixture |
| FDMXInputPortConfig | Blueprint Configuration of a Port, used in DXM Settings to specify inputs and outputs. |
| FDMXInputPortConfigParams | Data to create a new input port config with related constructor. |
| FDMXInputPortReference | Reference of an input port |
| FDMXNameListItem | Types that represent names in a SNameListPicker dropdown must: |
| FDMXOutputPortCommunicationDeterminator | Helper to determine how DMX should be communicated (loopback, send) |
| FDMXOutputPortConfig | Blueprint Configuration of a Port, used in DXM Settings to specify inputs and outputs. |
| FDMXOutputPortConfigParams | Data to create a new output port config with related constructor |
| FDMXOutputPortDestinationAddress | The IP address outbound DMX is sent to |
| FDMXOutputPortReference | Reference of an input port |
| FDMXProtocolName | A DMX protocol as a name that can be displayed in UI. |
| FDMXProtocolObjectVersion | |
| FDMXProtocolRegistrationParams | |
| FDMXSignalFragment | Structs that holds the fragmented values to be sent along with a timestamp when to send it |
| FLogCategoryLogDMXProtocol | |
| IDMXProtocolPacket |
Interfaces
| Name | Remarks |
|---|---|
| IDMXProtocol | Serves as a higher level abstraction of a specific protocol such as Art-Net or sACN with the purpose to hide its complexity. |
| IDMXProtocolBase | |
| IDMXProtocolFactory | |
| IDMXSender |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FDMXInputPortSharedPtr | TSharedPtr< FDMXInputPort, ESPMode::ThreadSafe > | DMXProtocolCommon.h | |
| FDMXInputPortSharedRef | TSharedRef< FDMXInputPort, ESPMode::ThreadSafe > | DMXProtocolCommon.h | |
| FDMXOnPortsChangedDelegate | TMulticastDelegate_NoParams< void > | IO/DMXPortManager.h | |
| FDMXOutputPortSharedPtr | TSharedPtr< FDMXOutputPort, ESPMode::ThreadSafe > | DMXProtocolCommon.h | |
| FDMXOutputPortSharedRef | TSharedRef< FDMXOutputPort, ESPMode::ThreadSafe > | DMXProtocolCommon.h | |
| FDMXPortSharedPtr | TSharedPtr< class FDMXPort, ESPMode::ThreadSafe > | Ports. | DMXProtocolCommon.h |
| FDMXPortSharedRef | TSharedRef< class FDMXPort, ESPMode::ThreadSafe > | DMXProtocolCommon.h | |
| FDMXSignalSharedPtr | TSharedPtr< FDMXSignal, ESPMode::ThreadSafe > | Signal. | DMXProtocolCommon.h |
| FDMXSignalSharedRef | TSharedRef< FDMXSignal, ESPMode::ThreadSafe > | DMXProtocolCommon.h | |
| IDMXProtocolPtr | TSharedPtr< IDMXProtocol, ESPMode::ThreadSafe > | Protocol. | DMXProtocolCommon.h |
| IDMXProtocolPtrWeak | TWeakPtr< IDMXProtocol, ESPMode::ThreadSafe > | DMXProtocolCommon.h |
Enums
Public
| Name | Remarks |
|---|---|
| EDMXCommunicationType | Type of network communication |
| EDMXFixtureSignalFormat | |
| EDMXPortPriorityStrategy | Strategy for priority system (when receiving packets)Not: Not all protocols have a use for this |
| EDMXSendResult | Result when sending a DMX packet |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| LogDMXProtocol | FLogCategoryLogDMXProtocol | DMXProtocolLog.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| STATCAT_Advanced | DMXStats.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint32 GetTypeHash
(
const FDMXAttribute& Attribute |
Unique hash from a DMX Attribute | DMXAttribute.h | |
uint32 GetTypeHash
(
const FDMXAttributeName& DMXNameListItem |
DMXAttribute.h | ||
bool operator!=
(
const FDMXAttributeName& V1, |
DMXAttribute.h | ||
bool operator==
(
const FDMXAttributeName& V1, |
DMXAttribute.h |