Navigation
API > API/Plugins > API/Plugins/DMXProtocol > API/Plugins/DMXProtocol/IO
References
| Module | DMXProtocol |
| Header | /Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/Public/IO/DMXOutputPortConfig.h |
| Include | #include "IO/DMXOutputPortConfig.h" |
Syntax
USTRUCT (BlueprintType )
struct FDMXOutputPortConfig
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 | |
| bool | bLoopbackToEngine | If true, the signals output from this port are input into to the engine. | |
| EDMXCommunicationType | CommunicationType | The type of communication used with this port | |
| double | Delay | The amout by which sending of packets is delayed | |
| FFrameRate | DelayFrameRate | Framerate of the delay | |
| FString | DestinationAddress | For Unicast, the IP address outbound DMX is sent to | |
| TArray< FDMXOutputPortDestinationAddress > | DestinationAddresses | For Unicast, the IP addresses outbound DMX is sent to | |
| FString | DeviceAddress | The IP address of the network interface card over which outbound DMX is sent | |
| 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 on which packets are being sent | |
| FName | ProtocolName | DMX Protocol |
Constructors
| Type | Name | Description | |
|---|---|---|---|
| Default constructor, only for Default Objects | |||
FDMXOutputPortConfig
(
const FGuid& InPortGuid |
Constructs a config from the guid | ||
FDMXOutputPortConfig
(
const FGuid& InPortGuid, |
Constructs a config from the guid and given initialization data |
Functions
| Type | Name | Description | |
|---|---|---|---|
| FString | |||
| FName | |||
| FName | |||
| EDMXCommunicationType | |||
| FName | |||
| double | GetDelay () |
||
| const FFrameRate & | |||
| FName | |||
| FName | |||
| const FString & | |||
| const TArray< FDMXOutputPortDestinationAddress > & | |||
| FName | |||
| FName | |||
| FString | |||
| FName | |||
| int32 | |||
| FName | |||
| FName | |||
| int32 | |||
| FName | |||
| int32 | |||
| FName | |||
| const FGuid & | GetPortGuid () |
||
| FName | |||
| const FString & | GetPortName () |
||
| FName | |||
| int32 | GetPriority () |
||
| FName | |||
| const FName & | |||
| FName | |||
| bool | |||
| void | MakeValid () |
Changes members to result in a valid config | |
| bool | |||
| void | Upgrade () |
Upgrades this config to the latest engine version |