Navigation
API > API/Plugins > API/Plugins/DMXProtocol > API/Plugins/DMXProtocol/IO
References
| Module | DMXProtocol |
| Header | /Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/Public/IO/DMXInputPortConfig.h |
| Include | #include "IO/DMXInputPortConfig.h" |
Syntax
USTRUCT&40;BlueprintType&41;
struct FDMXInputPortConfig
Remarks
Blueprint Configuration of a Port, used in DXM Settings to specify inputs and outputs.
Property changes are handled in details customization consistently.
Variables
| Type | Name | Description | |
|---|---|---|---|
| FString | AutoCompleteDeviceAddress | Searches available Network Interface Card IP Addresses and uses the first match as the 'Network Interface Card IP Address' (both in Editor and Game). | |
| bool | bAutoCompleteDeviceAddressEnabled | Enables 'Auto Complete Device Address', hidden via customization - EditConditionInlineToggle doesn't support Config | |
| bool | bIsExternUnivereStartEditable | Edit condition for the ExternUniverseStart property | |
| EDMXCommunicationType | CommunicationType | The type of communication used with this port | |
| FString | DeviceAddress | The Network Interface Card's IP Adress, over which DMX is received | |
| int32 | ExternUniverseStart | Remaps the range of local Universes (Num Universes from Local Universe Start) to a different set of Universes at the Protocol level. | |
| int32 | LocalUniverseStart | Local Start Universe | |
| int32 | NumUniverses | Number of Universes | |
| FGuid | PortGuid | Unique identifier, shared with the port instance. | |
| FString | PortName | The name displayed wherever the port can be displayed | |
| int32 | Priority | Priority value, can act as a filter or a threshold | |
| EDMXPortPriorityStrategy | PriorityStrategy | How to deal with the priority value | |
| FName | ProtocolName | DMX Protocol |
Constructors
| Type | Name | Description | |
|---|---|---|---|
| Default constructor, only for Default Objects | |||
FDMXInputPortConfig
(
const FGuid& InPortGuid |
Constructs a config from the guid | ||
FDMXInputPortConfig
(
const FGuid& InPortGuid, |
Constructs a config from the guid and given initialization data |
Functions
| Type | Name | Description | |
|---|---|---|---|
| FString | |||
| FName | |||
| FName | |||
| EDMXCommunicationType | |||
| FName | |||
| FString | |||
| FName | |||
| int32 | |||
| FName | |||
| FName | |||
| int32 | |||
| FName | |||
| int32 | |||
| FName | |||
| const FGuid & | GetPortGuid () |
||
| FName | |||
| const FString & | GetPortName () |
||
| FName | |||
| const EDMXPortPriorityStrategy | |||
| const int32 | GetPriority () |
||
| FName | |||
| FName | |||
| const FName & | |||
| FName | |||
| bool | |||
| void | MakeValid () |
Changes members to result in a valid config | |
| void | Upgrade () |
Upgrades this config to the latest engine version |