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 Config

• communication_type (DMXCommunicationType): [Read-Write] The type of communication used with this port

• device_address (str): [Read-Write] The Network Interface Card’s IP Adress, over which DMX is received

• extern_universe_start (int32): [Read-Write] The start address this being transposed to. E.g. if LocalUniverseStart is 1 and this is 100, Local Universe 1 is sent/received as Universe 100.

• local_universe_start (int32): [Read-Write] Local Start Universe

• num_universes (int32): [Read-Write] Number of Universes

• port_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 displayed

• priority (int32): [Read-Write] Priority value, can act as a filter or a threshold

• priority_strategy (DMXPortPriorityStrategy): [Read-Write] How to deal with the priority value

• protocol_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:

(DMXCommunicationType)

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] The start address this being transposed to. E.g. if LocalUniverseStart is 1 and this is 100, Local Universe 1 is sent/received as Universe 100.

Type:

(int32)

property local_universe_start: int

[Read-Only] Local Start Universe

Type:

(int32)

property num_universes: int

[Read-Only] Number of Universes

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:

(DMXPortPriorityStrategy)

property protocol_name: Name

[Read-Only] DMX Protocol

Type:

(Name)