UDMXProtocolSettings

DMX Project Settings.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UDMXProtocolSettings

References

Module

DMXProtocol

Header

/Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/Public/DMXProtocolSettings.h

Include

#include "DMXProtocolSettings.h"

Syntax

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

Remarks

DMX Project Settings.

To handle Port changes in code please refer to FDMXPortManager.

Variables

Name Description

Public variable UProperty Category, EditAnywhere, Meta Config

TSet< FDMXAttri...

 

Attributes

Common names to map Fixture Functions to and access them easily on Blueprints

Public variable UProperty Category, EditAnywhere, Meta Config

TSet< FName >

 

FixtureCategories

Fixture Categories ENum

Public variable UProperty Category, EditAnywhere, Meta Config

TArray< FDMXInp...

 

InputPortConfigs

DMX Input Port Configs

Public variable

FDMXOnReceiveDM...

 

OnSetReceiveDMXEnabled

Broadcast when receive DMX is enabled or disabled

Public variable

FDMXOnSendDMXEn...

 

OnSetSendDMXEnabled

Broadcast when send DMX is enabled or disabled

Public variable UProperty Category, EditAnywhere, Meta Config

TArray< FDMXOut...

 

OutputPortConfigs

DMX Output Port Configs

Public variable UProperty Category, EditAnywhere, Meta Config

uint32

 

SendingRefreshRate

Rate at which DMX is sent, in Hz from 1 to 1000. 44Hz is recommended.

Constructors

Name Description

Public function

UDMXProtocolSettings()

Functions

Name Description

Public function

FDMXInputPor...

 

FindInputPortConfig

(
    Predicate Pred
)

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

Public function

FDMXOutputPo...

 

FindOutputPortConfig

(
    Predicate Pred
)

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

Public function Const

FString

 

GetUniqueInputPortName()

Returns an automatic/unique name for an InputPort

Public function Const

FString

 

GetUniqueOutputPortName()

Returns an automatic/unique name for an OutputPort

Public function Const

bool

 

IsReceiveDMXEnabled()

Returns whether receive DMX is currently enabled, considering runtime override

Public function Const

bool

 

IsSendDMXEnabled()

Returns whether send DMX is currently enabled, considering runtime override

Public function

void

 

OverrideReceiveDMXEnabled

(
    bool bEnabled
)

Overrides if send DMX is enabled at runtime

Public function

void

 

OverrideSendDMXEnabled

(
    bool bEnabled
)

Overrides if send DMX is enabled at runtime

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeChainProperty

(
    FPropertyChangedChainEvent& Proper...
)

This alternate version of PostEditChange is called when properties inside structs are modified.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Typedefs

Deprecated Variables

Name Description

Public variable UProperty Meta Config

int32

 

GlobalArtNetUniverseOffset_DEPRECATED

Now in Port Configs to support many NICs

Public variable UProperty Meta Config

int32

 

GlobalSACNUniverseOffset_DEPRECATED

Now in Port Configs to support many NICs

Public variable UProperty Meta Config

FString

 

InterfaceIPAddress_DEPRECATED

Now in Port Configs to support many NICs

Public variable UProperty Meta

uint32

 

ReceivingRefreshRate_DEPRECATED

Rate at which DMX is received, in Hz from 1 to 1000. 44Hz is recommended