1. Epic GamesDeveloper
  3. UDMXSubsystem

UDMXSubsystem

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

API > API/Plugins > API/Plugins/DMXRuntime

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

   
Name UDMXSubsystem
Type class
Header File /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/Public/DMXSubsystem.h
Include Path #include "DMXSubsystem.h"

Syntax

UCLASS ()  
class UDMXSubsystem : public UEngineSubsystem

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnAllDMXLibraryAssetsLoaded FSimpleMulticastDelegate Delegate broadcast when all DMX Library assets were loaded DMXSubsystem.h  
OnDMXLibraryAssetAdded FDMXOnDMXLibraryAssetDelegate Delegate broadcast when a DMX Library asset was added DMXSubsystem.h  
OnDMXLibraryAssetRemoved FDMXOnDMXLibraryAssetDelegate Delegate broadcast when a DMX Library asset was removed DMXSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 BytesToInt ( const TArray< uint8 >& Bytes,
bool bUseLSB
) const

 Converts consecutive DMX channel values to a signed 32bit integer value. DMXSubsystem.h
  • BlueprintPure
  • Category="DMX"

float BytesToNormalizedValue ( const TArray< uint8 >& Bytes,
bool bUseLSB
) const

 Converts consecutive DMX channel values to a normalized value. DMXSubsystem.h
  • BlueprintPure
  • Category="DMX"
  • Meta=(Keywords="float")

TArray< UDMXEntityController * > GetAllControllersInLibrary ( const UDMXLibrary* DMXLibrary
)

 DEPRECATED 4.27 DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.27. Controllers are removed in favor of Ports.")

TArray< UDMXLibrary * > GetAllDMXLibraries()

 DEPRECATED 5.5, instead use 'Load All DMX Libraries Synchronous' DMXSubsystem.h  

TArray< UDMXEntityFixturePatch * > GetAllFixturesInLibrary ( const UDMXLibrary* DMXLibrary
)

 Return an array of Fixture Patches in the provided DMX Library. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"

void GetAllFixturesInUniverse ( const UDMXLibrary* DMXLibrary,
int32 UniverseId,
TArray< UDMXEntityFixturePatch* >& OutResult
)

 Return an array of Fixture Patches that reside in the provided universe. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"

void GetAllFixturesOfCategory ( const UDMXLibrary* DMXLibrary,
FDMXFixtureCategory Category,
TArray< UDMXEntityFixturePatch* >& OutResult
)

 Return an array of Fixture Patches that use the provided category. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"

void GetAllFixturesOfType ( const FDMXEntityFixtureTypeRef& FixtureType,
TArray< UDMXEntityFixturePatch* >& OutResult
)

 Return an array of Fixture Patches that use the provided Fixture Type. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(AutoCreateRefTerm="FixtureType")

TArray< UDMXEntityFixturePatch * > GetAllFixturesWithTag ( const UDMXLibrary* DMXLibrary,
FName CustomTag
)

 Return an array of Fixture Patches that have the custom tag set. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"

TArray< UDMXEntityFixtureType * > GetAllFixtureTypesInLibrary ( const UDMXLibrary* DMXLibrary
)

 Returns all Fixture Types in a DMX Library. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"

bool GetAllMatrixCells ( UDMXEntityFixturePatch* FixturePatch,
TArray< FDMXCell >& Cells
)

 Get array of all cells and associated data. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.26. DMXEntityFixurePatch::GetAllMatrixCells instead")

void GetAllUniversesInController ( const UDMXLibrary* DMXLibrary,
FString ControllerName,
TArray< int32 >& OutResult
)

 DEPRECATED 4.27 DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.27. Controllers are removed in favor of Ports.")

FName GetAttributeLabel ( FDMXAttributeName AttributeName
)

 Gets the FName of an Attribute Name. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"

bool GetCellAttributes ( UDMXEntityFixturePatch* FixturePatch,
TArray< FDMXAttributeName >& CellAttributes
)

 Get all attributes for the Fixture Patch. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.26. DMXEntityFixurePatch::GetCellAttributes instead")

UDMXEntityController * GetControllerByName ( const UDMXLibrary* DMXLibrary,
const FString& Name
)

 DEPRECATED 4.27 DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(AutoCreateRefTerm="Name")
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.27. Controllers are removed in favor of Ports.")

TArray< TSoftObjectPtr< UDMXLibrary > > GetDMXLibraries()

 Gets all DMX Libraries in this project, returns an array of Soft Object References to the DMX Libraries without loading them. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DisplayName="Get DMX Libraries")

void GetFixtureAttributes ( const UDMXEntityFixturePatch* InFixturePatch,
const TArray< uint8 >& DMXBuffer,
TMap< FDMXAttributeName, int32 >& OutResult
)

 Return a map with all DMX functions and their associated values provided DMX buffer and desired universe. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 5.5. Instead please call the Fixture Patch function 'Get Attribute Values' to retrieve attribute values safely.")

UDMXEntityFixturePatch * GetFixtureByName ( const UDMXLibrary* DMXLibrary,
const FString& Name
)

 Return the Fixture Patch with given name or an invalid object if no Fixture Patch matches the name. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(AutoCreateRefTerm="Name")

UDMXEntityFixturePatch * GetFixturePatch ( FDMXEntityFixturePatchRef InFixturePatch
)

 Gets the Fixture Patch from a Fixture Patch Reference. DMXSubsystem.h
  • BlueprintPure
  • Meta=(BlueprintInternalUseOnly="TRUE")
  • Category="DMX"

UDMXEntityFixtureType * GetFixtureType ( FDMXEntityFixtureTypeRef InFixtureType
)

 Gets the Fixture Type from a Fixture Type Reference. DMXSubsystem.h
  • BlueprintPure
  • Meta=(BlueprintInternalUseOnly="TRUE")
  • Category="DMX"

UDMXEntityFixtureType * GetFixtureTypeByName ( const UDMXLibrary* DMXLibrary,
const FString& Name
)

 Return the Fixture Type with provided name or an invalid object if no Fixture Type matches the name. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(AutoCreateRefTerm="Name")

bool GetFunctionsMap ( UDMXEntityFixturePatch* InFixturePatch,
TMap< FDMXAttributeName, int32 >& OutAttributesMap
)

 Gets a function map based on you active mode from FixturePatch DMXSubsystem.h
  • BlueprintCallable
  • Meta=(BlueprintInternalUseOnly="TRUE", AutoCreateRefTerm="SelectedProtocol")
  • Category="DMX"

bool GetFunctionsMapForPatch ( UDMXEntityFixturePatch* InFixturePatch,
TMap< FDMXAttributeName, int32 >& OutAttributesMap
)

 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 DMXSubsystem.h
  • BlueprintCallable
  • Meta=(BlueprintInternalUseOnly="TRUE", AutoCreateRefTerm="SelectedProtocol", DeprecatedFunction, DeprecationMessage="Duplicate of GetFunctionsMap. Instead please call DMXSubsystem::GetFunctionsMap or DMXEntityFixturePatch::GetAttributeValues.")
  • Category="DMX"

int32 GetFunctionsValue ( const FName FunctionAttributeName,
const TMap< FDMXAttributeName, int32 >& InAttributesMap
)

 Gets function channel value by input function name DMXSubsystem.h
  • BlueprintCallable
  • Meta=(BlueprintInternalUseOnly="TRUE", AutoCreateRefTerm="InName, InAttributesMap")
  • Category="DMX"

bool GetMatrixCell ( UDMXEntityFixturePatch* FixturePatch,
FIntPoint Coordinate,
FDMXCell& Cell
)

 Get data for single cell. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.26. DMXEntityFixurePatch::GetMatrixCell instead")

bool GetMatrixCellChannelsAbsolute ( UDMXEntityFixturePatch* FixturePatch,
FIntPoint Coordinate,
TMap< FDMXAttributeName, int32 >& AttributeChannelMap
)

 Gets the absolute starting channel of each cell attribute at given coordinate DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.26. DMXEntityFixurePatch::GetMatrixCellChannelsAbsolute instead")

bool GetMatrixCellChannelsRelative ( UDMXEntityFixturePatch* FixturePatch,
FIntPoint Coordinate,
TMap< FDMXAttributeName, int32 >& AttributeChannelMap
)

 Gets the starting channel of each cell attribute at given coordinate, relative to the Starting Channel of the patch. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.26. DMXEntityFixurePatch::GetMatrixCellChannelsRelative instead")

bool GetMatrixCellValue ( UDMXEntityFixturePatch* FixturePatch,
FIntPoint Coordinate,
TMap< FDMXAttributeName, int32 >& AttributeValueMap
)

 Get DMX Cell value using matrix coordinates. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.26. DMXEntityFixurePatch::GetMatrixCellValues instead")

bool GetMatrixProperties ( UDMXEntityFixturePatch* FixturePatch,
FDMXFixtureMatrix& MatrixProperties
)

 Get Matrix Fixture properties DMXSubsystem.h
  • BlueprintPure
  • Category="DMX"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.26. DMXEntityFixurePatch::GetMatrixProperties instead")

float GetNormalizedAttributeValue ( UDMXEntityFixturePatch* InFixturePatch,
FDMXAttributeName InFunctionAttribute,
int32 InValue
) const

 Return the normalized value of an Int value from a Fixture Patch function. DMXSubsystem.h
  • BlueprintPure
  • Category="DMX"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 5.5. Instead please call the optimized Fixture Patch function 'Get Attribute Value' to retrieve the attribute value.")

void GetRawBuffer ( FDMXProtocolName SelectedProtocol,
int32 RemoteUniverse,
TArray< uint8 >& DMXBuffer
)

 DEPRECATED 4.27 DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.27. Use GetDMXDataFromInputPort or GetDMXDataFromOutputPort instead.")

float IntToNormalizedValue ( int32 InValue,
EDMXFixtureSignalFormat InSignalFormat
) const

 Converts a signed 32bit integer value to a normalized value. DMXSubsystem.h
  • BlueprintPure
  • Category="DMX"
  • Meta=(Keywords="float")

TArray< UDMXLibrary * > LoadDMXLibrariesSynchronous()

 Loads all DMX Libraries in this project synchronous, returns an array of DMX Libraries DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DisplayName="Load DMX Libraries Synchronous")

void NormalizedValueToBytes ( float InValue,
EDMXFixtureSignalFormat InSignalFormat,
TArray< uint8 >& Bytes,
bool bUseLSB
) const

 Converts a normalized value to an array of DMX channel values. DMXSubsystem.h
  • BlueprintPure
  • Category="DMX"
  • Meta=(Keywords="float")

bool PatchIsOfSelectedType ( UDMXEntityFixturePatch* InFixturePatch,
FString RefTypeValue
)

 Returns true if a Fixture Patch is of a given FixtureType DMXSubsystem.h
  • BlueprintCallable
  • Meta=(BlueprintInternalUseOnly="TRUE")
  • Category="DMX"

void PixelMappingDistributionSort ( EDMXPixelMappingDistribution InDistribution,
int32 InNumXPanels,
int32 InNumYPanels,
const TArray< int32 >& InUnorderedList,
TArray< int32 >& OutSortedList
)

 Sort an array according to the selected distribution pattern. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"

void SendDMX ( UDMXEntityFixturePatch* FixturePatch,
TMap< FDMXAttributeName, int32 > AttributeMap,
EDMXSendResult& OutResult
)

 Send DMX using function names and integer values. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.27. Use DMXEntityFixurePatch::SendDMX instead")

void SendDMXRaw ( FDMXProtocolName SelectedProtocol,
int32 RemoteUniverse,
TMap< int32, uint8 > AddressValueMap,
EDMXSendResult& OutResult
)

 DEPRECATED 4.27 DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.27. Use SendDMXToOutputPort instead.")

bool SetMatrixCellValue ( UDMXEntityFixturePatch* FixturePatch,
FIntPoint Coordinate,
FDMXAttributeName Attribute,
int32 Value
)

 Set DMX Cell value using matrix coordinates. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 4.26. DMXEntityFixurePatch::SendMatrixCellValue instead")

Static

Name Remarks Include Path Unreal Specifiers

static void ClearDMXBuffers ()

 Clears all buffered DMX data of Ports and Fixture Patches. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DisplayName="Clear DMX Buffers")

static void GetDMXDataFromInputPort ( FDMXInputPortReference InputPortReference,
TArray< uint8 >& DMXData,
int32 LocalUniverse
)

 Gets latest DMX Values from a DMX Universe of a DMX Input Port. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DisplayName="Get DMX Data From Input Port")

static void GetDMXDataFromOutputPort ( FDMXOutputPortReference OutputPortReference,
TArray< uint8 >& DMXData,
int32 LocalUniverse
)

 Gets latest DMX Values from a DMX Universe of a DMX Output Port. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DisplayName="Get DMX Data From Output Port")

static UDMXSubsystem * GetDMXSubsystem_Callable()

 Get the DMX Subsystem, callable. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX Subsystem"
  • Meta=(BlueprintInternalUseOnly="true")

static UDMXSubsystem * GetDMXSubsystem_Pure()

 Get the DMX Subsystem, pure. DMXSubsystem.h
  • BlueprintPure
  • Category="DMX Subsystem"
  • Meta=(BlueprintInternalUseOnly="true")

static void IntValueToBytes ( int32 InValue,
EDMXFixtureSignalFormat InSignalFormat,
TArray< uint8 >& Bytes,
bool bUseLSB
)

 Converts a signed 32bit integer value to an array of DMX channel values. DMXSubsystem.h
  • BlueprintPure
  • Category="DMX"
  • Meta=(DisplayName="Int To Bytes")

static void SendDMXToOutputPort ( FDMXOutputPortReference OutputPortReference,
TMap< int32, uint8 > ChannelToValueMap,
int32 LocalUniverse
)

 Sends DMX via an Output Port. DMXSubsystem.h
  • BlueprintCallable
  • Category="DMX"
  • Meta=(DisplayName="Send DMX To Output Port")

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
OnProtocolReceived_DEPRECATED FProtocolReceivedDelegate   DMXSubsystem.h
  • BlueprintAssignable
  • Category="DMX"
  • Meta=(DeprecatedProperty, DeprecationMessage="WARNING: This can execute faster than tick leading to possible blueprint performance issues. Use DMXComponent's OnFixturePatchReceived event or GetRawBuffer instead.")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page