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/VirtualProduction/DMX/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
FSimpleMulticas...	OnAllDMXLibraryAssetsLoaded	Delegate broadcast when all dmx library assets were loaded
FDMXOnDMXLibrar...	OnDMXLibraryAssetAdded	Delegate broadcast when a dmx library asset was added
FDMXOnDMXLibrar...	OnDMXLibraryAssetRemoved	Delegate broadcast when a dmx library asset was removed

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 )	DEPRECATED 4.27
const TArray...	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.
bool	GetAllMatrixCells ( UDMXEntityFixturePatch* Fixtur..., TArray< FDMXCell >& Cells )	Get array of all cells and associated data.
void	GetAllUniversesInController ( const UDMXLibrary* DMXLibrary, FString ControllerName, TArray< int32 >& OutResult )	DEPRECATED 4.27
FName	GetAttributeLabel ( FDMXAttributeName AttributeName )	Gets the FName for a FDMXAttributeName, since structs can't have UFUCNTIONS to create a getter
bool	GetCellAttributes ( UDMXEntityFixturePatch* Fixtur..., TArray< FDMXAttributeName >& CellA... )	Get all attributes for the fixture patch.
UDMXEntityCo...	GetControllerByName ( const UDMXLibrary* DMXLibrary, const FString& Name )	DEPRECATED 4.27
void	GetDMXDataFromInputPort ( FDMXInputPortReference InputPortRef..., int32 LocalUniverse, TArray< uint8 >& DMXData )	Gets accumulated latest DMX Values from the Input Port (all that's been received since Begin Play)
void	GetDMXDataFromOutputPort ( FDMXOutputPortReference OutputPortR..., int32 LocalUniverse, TArray< uint8 >& DMXData )	Gets accumulated latest DMX Values from the Output Port (all that's been sent since Begin Play)
UDMXSubsyste...	GetDMXSubsystem_Callable()	Get a DMX Subsystem, callable version
UDMXSubsyste...	GetDMXSubsystem_Pure()	Get a DMX Subsystem, pure version
void	GetFixtureAttributes ( const UDMXEntityFixturePatch* ..., const TArray< uint8 >& DMXBuffer, TMap< FDMXAttributeName, int32 >& ... )	Return map with all DMX functions and their associated values given DMX buffer and desired universe.
UDMXEntityFi...	GetFixtureByName ( const UDMXLibrary* DMXLibrary, const FString& Name )	Return reference to Fixture Patch object with a given name.
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..., TMap< FDMXAttributeName, int32 >& ... )	Gets a function map based on you active mode from FixturePatch
bool	GetFunctionsMapForPatch ( UDMXEntityFixturePatch* InFixt..., TMap< FDMXAttributeName, int32 >& ... )	Gets a function map based on you active mode from FixturePatch, but instead of passing a Protocol as parameters, it looks for the first Protocol found in the Patch's universe and use that one
int32	GetFunctionsValue ( const FName FunctionAttributeName, const TMap< FDMXAttributeName, int3... )	Gets function channel value by input function name
bool	GetMatrixCell ( UDMXEntityFixturePatch* Fixtur..., FIntPoint Coordinate, FDMXCell& Cell )	Get data for single cell.
bool	GetMatrixCellChannelsAbsolute ( UDMXEntityFixturePatch* Fixtur..., FIntPoint Coordinate, TMap< FDMXAttributeName, int32 >& ... )	Gets the absolute starting channel of each cell attribute at given coordinate
bool	GetMatrixCellChannelsRelative ( UDMXEntityFixturePatch* Fixtur..., FIntPoint Coordinate, TMap< FDMXAttributeName, int32 >& ... )	Gets the starting channel of each cell attribute at given coordinate, relative to the Starting Channel of the patch.
bool	GetMatrixCellValue ( UDMXEntityFixturePatch* Fixtur..., FIntPoint Coordinate, TMap< FDMXAttributeName, int32 >& ... )	Get DMX Cell value using matrix coordinates.
bool	GetMatrixProperties ( UDMXEntityFixturePatch* Fixtur..., FDMXFixtureMatrix& MatrixPropertie... )	Get Matrix Fixture properties
float	GetNormalizedAttributeValue ( UDMXEntityFixturePatch* InFixt..., FDMXAttributeName InFunctionAttribu..., int32 InValue )	Return the normalized value of an Int value from a Fixture Patch function.
void	GetRawBuffer ( FDMXProtocolName SelectedProtocol, int32 RemoteUniverse, TArray< uint8 >& DMXBuffer )	DEPRECATED 4.27
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	NormalizedValueToBytes ( float InValue, EDMXFixtureSignalFormat InSignalFor..., TArray< uint8 >& Bytes, bool bUseLSB )	Return the Bytes format of Value in the desired Signal Format.
bool	PatchIsOfSelectedType ( UDMXEntityFixturePatch* InFixt..., FString RefTypeValue )	Checks if a FixturePatchs is of a given FixtureType
void	PixelMappingDistributionSort ( EDMXPixelMappingDistribution InDist..., int32 InNumXPanels, int32 InNumYPanels, const TArray< int32 >& InUnordered..., TArray< int32 >& OutSortedList )	Sort an array according to the selected distribution pattern.
void	SendDMX ( UDMXEntityFixturePatch* Fixtur..., TMap< FDMXAttributeName, int32 > At..., EDMXSendResult& OutResult )	Send DMX using function names and integer values.
void	SendDMXRaw ( FDMXProtocolName SelectedProtocol, int32 RemoteUniverse, TMap< int32, uint8 > AddressValueMa..., EDMXSendResult& OutResult )	DEPRECATED 4.27
void	SendDMXToOutputPort ( FDMXOutputPortReference OutputPortR..., int32 LocalUniverse, TMap< int32, uint8 > ChannelToValue... )	Sends DMX Values over the Output Port
bool	SetMatrixCellValue ( UDMXEntityFixturePatch* Fixtur..., FIntPoint Coordinate, FDMXAttributeName Attribute, int32 Value )	Set DMX Cell value using matrix coordinates.

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

Deprecated Variables

		Name	Description
	FProtocolReceiv...	OnProtocolReceived_DEPRECATED	No longer supported in 4.26. Use DMXComponent's OnFixturePatchReceived event or GetRawBuffer instead.

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

Take our survey

Dismiss