Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > DMXProtocol > UDMXProtocolSettings

Light Theme

Dark Theme

UDMXProtocolSettings

DMX Project Settings.

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](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Engine, defaultconfig, Meta=(DisplayName="DMX"))
class UDMXProtocolSettings : public UObject

Remarks

DMX Project Settings.

To handle Port changes in code please refer to FDMXPortManager.

Variables

	Name	Description
TSet< FDMXAttri...	Attributes	Common names to map Fixture Functions to and access them easily on Blueprints
TSet< FName >	FixtureCategories	Fixture Categories ENum
TArray< FDMXInp...	InputPortConfigs	DMX Input Port Configs
FDMXOnReceiveDM...	OnSetReceiveDMXEnabled	Broadcast when receive DMX is enabled or disabled
FDMXOnSendDMXEn...	OnSetSendDMXEnabled	Broadcast when send DMX is enabled or disabled
TArray< FDMXOut...	OutputPortConfigs	DMX Output Port Configs
uint32	ReceivingRefreshRate	Rate at which DMX is received, in Hz from 1 to 1000. 44Hz is recommended
uint32	SendingRefreshRate	Rate at which DMX is sent, in Hz from 1 to 1000. 44Hz is recommended.

Constructors

	Name	Description
	UDMXProtocolSettings()

Functions

	Name	Description
FDMXInputPor...	FindInputPortConfig ( Predicate Pred )	Returns the input port matching the predicate, or nullptr if it cannot be found
FDMXOutputPo...	FindOutputPortConfig ( Predicate Pred )	Returns the input port matching the predicate, or nullptr if it cannot be found
bool	IsReceiveDMXEnabled()	Returns whether receive DMX is currently enabled, considering runtime override
bool	IsSendDMXEnabled()	Returns whether send DMX is currently enabled, considering runtime override
void	OverrideReceiveDMXEnabled ( bool bEnabled )	Overrides if send DMX is enabled at runtime
void	OverrideSendDMXEnabled ( bool bEnabled )	Overrides if send DMX is enabled at runtime

Overridden from UObject

	Name	Description
void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )	This alternate version of PostEditChange is called when properties inside structs are modified.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Typedefs

Name	Description
FDMXOnReceiveDMXEnabled
FDMXOnSendDMXEnabled

Deprecated Variables

	Name	Description
int32	GlobalArtNetUniverseOffset_DEPRECATED	Now in Port Configs to support many NICs
int32	GlobalSACNUniverseOffset_DEPRECATED	Now in Port Configs to support many NICs
FString	InterfaceIPAddress_DEPRECATED	Now in Port Configs to support many NICs

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

Take our survey

Dismiss