unreal.DMXInputPortConfig
¶
- class unreal.DMXInputPortConfig(port_name: str = '', protocol_name: Name = 'None', communication_type: DMXCommunicationType = Ellipsis, auto_complete_device_address_enabled: bool = False, auto_complete_device_address: str = '', device_address: str = '', local_universe_start: int = 0, num_universes: int = 0, extern_universe_start: int = 0, priority_strategy: DMXPortPriorityStrategy = Ellipsis, priority: int = 0, port_guid: Guid = [])¶
Bases:
StructBase
Blueprint Configuration of a Port, used in DXM Settings to specify inputs and outputs.
Property changes are handled in details customization consistently.
C++ Source:
Plugin: DMXProtocol
Module: DMXProtocol
File: DMXInputPortConfig.h
Editor Properties: (see get_editor_property/set_editor_property)
auto_complete_device_address
(str): [Read-Write] Searches available Network Interface Card IP Addresses and uses the first match as the ‘Network Interface Card IP Address’ (both in Editor and Game).Supports wildcards, examples: ‘192’ ‘192.*’ ‘192.168.?.*’.
If empty or ‘*’ the first best available IP will be selected (not recommended)
auto_complete_device_address_enabled
(bool): [Read-Write] Enables ‘Auto Complete Device Address’, hidden via customization - EditConditionInlineToggle doesn’t support Configcommunication_type
(DMXCommunicationType): [Read-Write] The type of communication used with this portdevice_address
(str): [Read-Write] The Network Interface Card’s IP Adress, over which DMX is receivedextern_universe_start
(int32): [Read-Write] Remaps the range of local Universes (Num Universes from Local Universe Start) to a different set of Universes at the Protocol level. For example, for Art-Net this allows to map local Universe 1 to extern Universe 0.is_extern_univere_start_editable
(bool): [Read-Write] Edit condition for the ExternUniverseStart propertylocal_universe_start
(int32): [Read-Write] Local Start Universenum_universes
(int32): [Read-Write] Number of Universesport_guid
(Guid): [Read-Write] Unique identifier, shared with the port instance. Note: This needs be BlueprintReadWrite to be accessible to property type customization, but is hidden by customization.port_name
(str): [Read-Write] The name displayed wherever the port can be displayedpriority
(int32): [Read-Write] Priority value, can act as a filter or a thresholdpriority_strategy
(DMXPortPriorityStrategy): [Read-Write] How to deal with the priority valueprotocol_name
(Name): [Read-Write] DMX Protocol
- property auto_complete_device_address: str¶
[Read-Only] Searches available Network Interface Card IP Addresses and uses the first match as the ‘Network Interface Card IP Address’ (both in Editor and Game).
Supports wildcards, examples: ‘192’ ‘192.*’ ‘192.168.?.*’.
If empty or ‘*’ the first best available IP will be selected (not recommended)
- Type:
(str)
- property auto_complete_device_address_enabled: bool¶
[Read-Only] Enables ‘Auto Complete Device Address’, hidden via customization - EditConditionInlineToggle doesn’t support Config
- Type:
(bool)
- property communication_type: DMXCommunicationType¶
[Read-Only] The type of communication used with this port
- Type:
- property device_address: str¶
[Read-Only] The Network Interface Card’s IP Adress, over which DMX is received
- Type:
(str)
- property extern_universe_start: int¶
[Read-Only] Remaps the range of local Universes (Num Universes from Local Universe Start) to a different set of Universes at the Protocol level. For example, for Art-Net this allows to map local Universe 1 to extern Universe 0.
- Type:
(int32)
- property port_guid: Guid¶
[Read-Only] Unique identifier, shared with the port instance. Note: This needs be BlueprintReadWrite to be accessible to property type customization, but is hidden by customization.
- Type:
(Guid)
- property port_name: str¶
[Read-Only] The name displayed wherever the port can be displayed
- Type:
(str)
- property priority: int¶
[Read-Only] Priority value, can act as a filter or a threshold
- Type:
(int32)
- property priority_strategy: DMXPortPriorityStrategy¶
[Read-Only] How to deal with the priority value
- Type: