unreal.DMXOutputPortConfig

class unreal.DMXOutputPortConfig(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 = '', destination_addresses: None = [], loopback_to_engine: bool = False, local_universe_start: int = 0, num_universes: int = 0, extern_universe_start: int = 0, priority: int = 0, delay: float = 0.0, delay_frame_rate: FrameRate = Ellipsis, 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: DMXOutputPortConfig.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

  • delay (double): [Read-Write] The amout by which sending of packets is delayed

  • delay_frame_rate (FrameRate): [Read-Write] Framerate of the delay

  • destination_address (str): [Read-Write] For Unicast, the IP address outbound DMX is sent to deprecated: DestinationAddress is deprecated. Please use DestinationAddresses instead.

  • destination_addresses (Array[DMXOutputPortDestinationAddress]): [Read-Write] For Unicast, the IP addresses outbound DMX is sent to

  • device_address (str): [Read-Write] The IP address of the network interface card over which outbound DMX is sent

  • extern_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 property

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

  • loopback_to_engine (bool): [Read-Write] If true, the signals output from this port are input into to the engine. Note, signals input into the engine this way will not be visible in Monitors when monitoring Inputs.

  • 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 on which packets are being sent

  • 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-Write] The type of communication used with this port

Type:

(DMXCommunicationType)

property delay: float

[Read-Only] The amout by which sending of packets is delayed

Type:

(double)

property delay_frame_rate: FrameRate

[Read-Only] Framerate of the delay

Type:

(FrameRate)

property destination_address: str

[Read-Write] For Unicast, the IP address outbound DMX is sent to deprecated: DestinationAddress is deprecated. Please use DestinationAddresses instead.

Type:

(str)

property destination_addresses: None

[Read-Only] For Unicast, the IP addresses outbound DMX is sent to

Type:

(Array[DMXOutputPortDestinationAddress])

property device_address: str

[Read-Only] The IP address of the network interface card over which outbound DMX is sent

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 local_universe_start: int

[Read-Only] Local Start Universe

Type:

(int32)

property loopback_to_engine: bool

[Read-Only] If true, the signals output from this port are input into to the engine. Note, signals input into the engine this way will not be visible in Monitors when monitoring Inputs.

Type:

(bool)

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 on which packets are being sent

Type:

(int32)

property protocol_name: Name

[Read-Only] DMX Protocol

Type:

(Name)