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 > DMXRuntime > UDMXSubsystem

Light Theme

Dark Theme

UDMXSubsystem

[UDMXSubsystem](API\Plugins\DMXRuntime\UDMXSubsystem) Collections of DMX context blueprint subsystem functions and internal functions for DMX K2Nodes

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USubsystem

UDynamicSubsystem

UEngineSubsystem

UDMXSubsystem

References

Module	DMXRuntime
Header	/Engine/Plugins/Experimental/DigitalMultiplex/DMXEngine/Source/DMXRuntime/Public/DMXSubsystem.h
Include	#include "DMXSubsystem.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UDMXSubsystem : public UEngineSubsystem

Remarks

UDMXSubsystem Collections of DMX context blueprint subsystem functions and internal functions for DMX K2Nodes

Variables

		Name	Description
	FProtocolReceiv...	OnProtocolReceived

Functions

	Name	Description
int32	BytesToInt ( const TArray< uint8 >& Bytes, bool bUseLSB )	Return integer given an array of bytes.
float	BytesToNormalizedValue ( const TArray< uint8 >& Bytes, bool bUseLSB )	Return normalized value given an array of bytes.
TArray< UDMX...	GetAllControllersInLibrary ( const UDMXLibrary* DMXLibrary )	Return reference to array of Controller objects in library.
TArray< UDMX...	GetAllDMXLibraries()	Return reference to array of DMX Library objects.
TArray< UDMX...	GetAllFixturesInLibrary ( const UDMXLibrary* DMXLibrary )	Return reference to array of Fixture Patch objects in library.
void	GetAllFixturesInUniverse ( const UDMXLibrary* DMXLibrary, int32 UniverseId, TArray< UDMXEntityFixturePatch*... )	Return reference to array of Fixture Patch objects in a given universe.
void	GetAllFixturesOfCategory ( const UDMXLibrary* DMXLibrary, FDMXFixtureCategory Category, TArray< UDMXEntityFixturePatch*... )	Return reference to array of Fixture Patch objects of a given category.
void	GetAllFixturesOfType ( const FDMXEntityFixtureTypeRef& Fi..., TArray< UDMXEntityFixturePatch*... )	Return reference to array of Fixture Patch objects of a given type.
TArray< UDMX...	GetAllFixturesWithTag ( const UDMXLibrary* DMXLibrary, FName CustomTag )	Return reference to array of Fixture Patch objects with a given tag.
TArray< UDMX...	GetAllFixtureTypesInLibrary ( const UDMXLibrary* DMXLibrary )	Return reference to array of Fixture Types objects in library.
void	GetAllUniversesInController ( const UDMXLibrary* DMXLibrary, FString ControllerName, TArray< int32 >& OutResult )	Return reference to array of Fixture Patch objects in a given controller.
UDMXEntityCo...	GetControllerByName ( const UDMXLibrary* DMXLibrary, const FString& Name )	Return reference to Controller object with a given name.
UDMXSubsyste...	GetDMXSubsystem_Callable()	Get a DMX Subsystem, callable version
UDMXSubsyste...	GetDMXSubsystem_Pure()	Get a DMX Subsystem, pure version
UDMXEntityFi...	GetFixtureByName ( const UDMXLibrary* DMXLibrary, const FString& Name )	Return reference to Fixture Patch object with a given name.
void	GetFixtureFunctions ( const UDMXEntityFixturePatch* ..., const TArray< uint8 >& DMXBuffer, TMap< FName, int32 >& OutResult )	Return map with all DMX functions and their associated values given DMX buffer and desired universe.
UDMXEntityFi...	GetFixturePatch ( FDMXEntityFixturePatchRef InFixture... )	Creates a literal UDMXEntityFixturePatch reference
UDMXEntityFi...	GetFixtureTypeByName ( const UDMXLibrary* DMXLibrary, const FString& Name )	Return reference to Fixture Type object with a given name.
bool	GetFunctionsMap ( UDMXEntityFixturePatch* InFixt..., const FDMXProtocolName& SelectedPr..., TMap< FName, int32 >& OutFunctions... )	Gets a function map based on you active mode from FixturePatch
int32	GetFunctionsValue ( const FName& InName, const TMap< FName, int32 >& InFunc... )	Gets function channel value by input function name
float	GetNormalizedFunctionValue ( UDMXEntityFixturePatch* InFixt..., FName InFunctionName, int32 InValue )	Return the normalized value of an Int value from a Fixture Patch function.
void	GetRawBuffer ( FDMXProtocolName SelectedProtocol, int32 UniverseIndex, TArray< uint8 >& DMXBuffer )	Return byte array from the DMX buffer given a universe.
float	IntToNormalizedValue ( int32 InValue, EDMXFixtureSignalFormat InSignalFor... )	Return the normalized value of an Int value from the specified Signal Format.
void	IntValueToBytes ( int32 InValue, EDMXFixtureSignalFormat InSignalFor..., TArray< uint8 >& Bytes, bool bUseLSB )	Return the Bytes format of Value in the desired Signal Format.
void	LoadDMXLibrary ( UDMXLibrary* DMXLibrary )	Load all referenced Objects in the given library.
void	NormalizedValueToBytes ( float InValue, EDMXFixtureSignalFormat InSignalFor..., TArray< uint8 >& Bytes, bool bUseLSB )	Return the Bytes format of Value in the desired Signal Format.
void	SendDMX ( FDMXProtocolName SelectedProtocol, UDMXEntityFixturePatch* Fixtur..., TMap< FName, int32 > FunctionMap, EDMXSendResult& OutResult )	Send DMX using function names and integer values.
void	SendDMXRaw ( FDMXProtocolName SelectedProtocol, int32 UniverseIndex, TMap< int32, uint8 > ChannelValuesM..., EDMXSendResult& OutResult )	Send DMX using channel and value raw values.

Overridden from USubsystem

		Name	Description
	void	Deinitialize()	Implement this for deinitialization of instances of the system
	void	Initialize ( FSubsystemCollectionBase& Collecti... )	Implement this for initialization of instances of the system

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

Take our survey

Dismiss