Navigation
API > API/Plugins > API/Plugins/DMXProtocol
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.
Note: To handle Port changes in code please refer to FDMXPortManager.
Variables
| Type | Name | Description | |
|---|---|---|---|
    |
TSet< FDMXAttribute > | Attributes | Common names to map Fixture Functions to and access them easily on Blueprints |
    |
TSet< FName > | FixtureCategories | Fixture Categories ENum |
    |
TArray< FDMXInputPortConfig > | InputPortConfigs | DMX Input Port Configs |
 |
FDMXOnReceiveDMXEnabled | OnSetReceiveDMXEnabled | DEPRECATED 5.1 |
 |
FDMXOnSendDMXEnabled | OnSetSendDMXEnabled | DEPRECATED 5.1 |
    |
TArray< FDMXOutputPortConfig > | OutputPortConfigs | DMX Output Port Configs |
    |
uint32 | SendingRefreshRate | Rate at which DMX is sent, in Hz from 1 to 1000. 44Hz is recommended. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
FDMXInputPortConfig * | FindInputPortConfig
(
Predicate Pred |
Returns the input port matching the predicate, or nullptr if it cannot be found |
 |
FDMXOutputPortConfig * | FindOutputPortConfig
(
Predicate Pred |
Returns the input port matching the predicate, or nullptr if it cannot be found |
  |
FName | Returns the property name of the bDMXComponentRecievesDMXInEditor Property | |
  |
FName | Returns the property name of the bDefaultReceiveDMXEnabled Property | |
  |
FName | Returns the property name of the bDefaultSendDMXEnabled Property | |
 |
FDMXOnAllFixturePatchesReceiveDMXInEditorEnabled & | Gets a Delegate Broadcast when receive DMX is enabled or disabled | |
 |
FSimpleMulticastDelegate & | Gets a delegate broadcast when default attributes were changed | |
 |
FSimpleMulticastDelegate & | Gets a delegate broadcast when default fixture categories were changed | |
 |
FSimpleMulticastDelegate & | Gets a delegate broadcast when the Sending Refresh Rate (the DMX send rate) changed | |
 |
FDMXOnSendDMXEnabled & | Gets a delegate broadcast when receive DMX is enabled or disabled | |
 |
FDMXOnSendDMXEnabled & | Gets a delegate broadcast when send DMX is enabled or disabled | |
  |
FString | Returns an automatic/unique name for an InputPort | |
  |
FString | Returns an automatic/unique name for an OutputPort | |
  |
bool | Returns whether receive DMX is currently enabled, considering runtime override | |
  |
bool | 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 |
  |
bool | Returns true if Fixture Patches should receive DMX in Editor |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | PostEditChangeChainProperty
(
FPropertyChangedChainEvent& PropertyChangedChainEvent |
This alternate version of PostEditChange is called when properties inside structs are modified. |
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
  |
void | Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
Typedefs
| Name | Description |
|---|---|
| FDMXOnAllFixturePatchesReceiveDMXInEditorEnabled | |
| FDMXOnReceiveDMXEnabled | |
| FDMXOnSendDMXEnabled |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
    |
int32 | GlobalArtNetUniverseOffset_DEPRECATED | DEPRECATED 4.27 |
    |
int32 | GlobalSACNUniverseOffset_DEPRECATED | DEPRECATED 4.27 |
    |
FString | InterfaceIPAddress_DEPRECATED | DEPRECATED 4.27. |
   |
uint32 | ReceivingRefreshRate_DEPRECATED | Rate at which DMX is received, in Hz from 1 to 1000. 44Hz is recommended |