1. Epic GamesDeveloper
  3. UDMXProtocolSettings

UDMXProtocolSettings

DMX Project Settings.

API > API/Plugins > API/Plugins/DMXProtocol

DMX Project Settings.

Note: To handle Port changes in code please refer to FDMXPortManager.

   
Name UDMXProtocolSettings
Type class
Header File /Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/Public/DMXProtocolSettings.h
Include Path #include "DMXProtocolSettings.h"

Syntax

UCLASS (Config=Engine, defaultconfig, AutoExpandCategories=("DMX|Communication Settings"),  
       Meta=(DisplayName="DMX"))  
class UDMXProtocolSettings : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UDMXProtocolSettings()

   DMXProtocolSettings.h  

Typedefs

Name Type Remarks Include Path
FDMXOnAllFixturePatchesReceiveDMXInEditorEnabled TMulticastDelegate_OneParam< void, bool >   DMXProtocolSettings.h
FDMXOnReceiveDMXEnabled TMulticastDelegate_OneParam< void, bool >   DMXProtocolSettings.h
FDMXOnSendDMXEnabled TMulticastDelegate_OneParam< void, bool >   DMXProtocolSettings.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Attributes TSet< FDMXAttribute > Common names to map Fixture Functions to and access them easily on Blueprints DMXProtocolSettings.h
  • Config
  • EditAnywhere
  • Category="DMX|Fixture Settings"
  • Meta=(DisplayName="Fixture Attributes")
FixtureCategories TSet< FName > Fixture Categories ENum DMXProtocolSettings.h
  • Config
  • EditAnywhere
  • Category="DMX|Fixture Settings"
  • Meta=(DisplayName="Fixture Categories")
InputPortConfigs TArray< FDMXInputPortConfig > DMX Input Port Configs DMXProtocolSettings.h
  • Config
  • EditAnywhere
  • Category="DMX|Communication Settings"
  • Meta=(DisplayName="Input Ports")
OnSetReceiveDMXEnabled FDMXOnReceiveDMXEnabled DEPRECATED 5.1 DMXProtocolSettings.h  
OnSetSendDMXEnabled FDMXOnSendDMXEnabled DEPRECATED 5.1 DMXProtocolSettings.h  
OutputPortConfigs TArray< FDMXOutputPortConfig > DMX Output Port Configs DMXProtocolSettings.h
  • Config
  • EditAnywhere
  • Category="DMX|Communication Settings"
  • Meta=(DisplayName="Output Ports")
SendingRefreshRate uint32 Rate at which DMX is sent, in Hz from 1 to 1000. 44Hz is recommended. DMXProtocolSettings.h
  • Config
  • EditAnywhere
  • Category="DMX|Communication Settings"
  • Meta=(ClampMin="1", ClampMax="1000")
  • Meta=(DisplayName="DMX Send Rate")

Protected

Name Type Remarks Include Path Unreal Specifiers
bAllFixturePatchesReceiveDMXInEditor bool If true, all fixture patches receive DMX in Editor. DMXProtocolSettings.h
  • Config
  • EditAnywhere
  • Category="DMX|Communication Settings"
  • Meta=(DisplayName="All Fixture Patches receive DMX in Editor")
bDefaultReceiveDMXEnabled bool Whether DMX is received from the network. Recalled whenever editor or game starts. DMXProtocolSettings.h
  • Config
  • EditAnywhere
  • Category="DMX|Communication Settings"
  • Meta=(AllowPrivateAccess=true, DisplayName="Receive DMX by default")
bDefaultSendDMXEnabled bool Whether DMX is sent to the network. Recalled whenever editor or game starts. DMXProtocolSettings.h
  • Config
  • EditAnywhere
  • Category="DMX|Communication Settings"
  • Meta=(AllowPrivateAccess=true, DisplayName="Send DMX by default")
bOverrideReceiveDMXEnabled bool Overrides the default bDefaultReceiveDMXEnabled value at runtime DMXProtocolSettings.h  
bOverrideSendDMXEnabled bool Overrides the default bDefaultSendDMXEnabled value at runtime DMXProtocolSettings.h  
OnAllFixturePatchesReceiveDMXInEditorEnabled FDMXOnAllFixturePatchesReceiveDMXInEditorEnabled Broadcast when Fixture Patches recieve DMX in Editor is enabled or disabled DMXProtocolSettings.h  
OnDefaultAttributesChanged FSimpleMulticastDelegate Broadcast when default attributets changed DMXProtocolSettings.h  
OnDefaultFixtureCategoriesChanged FSimpleMulticastDelegate Broadcast when default fixture categories changed DMXProtocolSettings.h  
OnSendingRefresRateChanged FSimpleMulticastDelegate Broadcast the Sending Refresh Rate (the DMX send rate) changed DMXProtocolSettings.h  
OnSetReceiveDMXEnabledDelegate FDMXOnReceiveDMXEnabled Broadcast when receive DMX is enabled or disabled DMXProtocolSettings.h  
OnSetSendDMXEnabledDelegate FDMXOnSendDMXEnabled Broadcast when send DMX is enabled or disabled DMXProtocolSettings.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FDMXInputPortConfig * FindInputPortConfig ( Predicate Pred
)

 Returns the input port matching the predicate, or nullptr if it cannot be found DMXProtocolSettings.h  

FDMXOutputPortConfig * FindOutputPortConfig ( Predicate Pred
)

 Returns the input port matching the predicate, or nullptr if it cannot be found DMXProtocolSettings.h  

FDMXOnAllFixturePatchesReceiveDMXInEditorEnabled & GetOnAllFixturePatchesReceiveDMXInEditorEnabled()

 Gets a Delegate Broadcast when receive DMX is enabled or disabled DMXProtocolSettings.h  

FSimpleMulticastDelegate & GetOnDefaultAttributesChanged()

 Gets a delegate broadcast when default attributes were changed DMXProtocolSettings.h  

FSimpleMulticastDelegate & GetOnDefaultFixtureCategoriesChanged()

 Gets a delegate broadcast when default fixture categories were changed DMXProtocolSettings.h  

FSimpleMulticastDelegate & GetOnSendingRefresRateChanged()

 Gets a delegate broadcast when the Sending Refresh Rate (the DMX send rate) changed DMXProtocolSettings.h  

FDMXOnSendDMXEnabled & GetOnSetReceiveDMXEnabled()

 Gets a delegate broadcast when receive DMX is enabled or disabled DMXProtocolSettings.h  

FDMXOnSendDMXEnabled & GetOnSetSendDMXEnabled()

 Gets a delegate broadcast when send DMX is enabled or disabled DMXProtocolSettings.h  

FString GetUniqueInputPortName()

 Returns an automatic/unique name for an InputPort DMXProtocolSettings.h  

FString GetUniqueOutputPortName()

 Returns an automatic/unique name for an OutputPort DMXProtocolSettings.h  

bool IsReceiveDMXEnabled()

 Returns whether receive DMX is currently enabled, considering runtime override DMXProtocolSettings.h  

bool IsSendDMXEnabled()

 Returns whether send DMX is currently enabled, considering runtime override DMXProtocolSettings.h  

void OverrideReceiveDMXEnabled ( bool bEnabled
)

 Overrides if send DMX is enabled at runtime DMXProtocolSettings.h  

void OverrideSendDMXEnabled ( bool bEnabled
)

 Overrides if send DMX is enabled at runtime DMXProtocolSettings.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedChainEvent
)

   DMXProtocolSettings.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   DMXProtocolSettings.h  

virtual void PostInitProperties()

   DMXProtocolSettings.h  

bool ShouldAllFixturePatchesReceiveDMXInEditor()

 Returns true if Fixture Patches should receive DMX in Editor DMXProtocolSettings.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName GetAllFixturePatchesReceiveDMXInEditorPropertyName()

 Returns the property name of the bDMXComponentRecievesDMXInEditor Property DMXProtocolSettings.h  

static FName GetDefaultReceiveDMXEnabledPropertyName()

 Returns the property name of the bDefaultReceiveDMXEnabled Property DMXProtocolSettings.h  

static FName GetDefaultSendDMXEnabledPropertyName()

 Returns the property name of the bDefaultSendDMXEnabled Property DMXProtocolSettings.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
GlobalArtNetUniverseOffset_DEPRECATED int32 DEPRECATED 4.27 DMXProtocolSettings.h
  • Config
  • Meta=(DeprecatedProperty, DeprecationMessage="GlobalArtNetUniverseOffset is deprecated. Use Ports instead.")
GlobalSACNUniverseOffset_DEPRECATED int32 DEPRECATED 4.27 DMXProtocolSettings.h
  • Config
  • Meta=(DeprecatedProperty, DeprecationMessage="GlobalSACNUniverseOffset is deprecated. Use Ports instead.")
InterfaceIPAddress_DEPRECATED FString DEPRECATED 4.27. DMXProtocolSettings.h
  • Config
  • Meta=(DeprecatedProperty, DeprecationMessage="InterfaceIPAddress is deprecated. Use Ports instead.")
ReceivingRefreshRate_DEPRECATED uint32 Rate at which DMX is received, in Hz from 1 to 1000. 44Hz is recommended DMXProtocolSettings.h
  • Meta=(DeprecatedProperty, DeprecationMessage="ReceivingRefreshRate is deprecated without replacement. It would prevent from precise timestamps on the receivers.")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page