unreal.DMXOutputPortConfig

class unreal.DMXOutputPortConfig(port_name='', protocol_name='None', communication_type=DMXCommunicationType.BROADCAST, device_address='', destination_address='', loopback_to_engine=False, local_universe_start=0, num_universes=0, extern_universe_start=0, priority=0, port_guid=[])

Bases: unreal.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)

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

  • destination_address (str): [Read-Write] For Unicast, the IP address 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] 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

  • loopback_to_engine (bool): [Read-Write] If true, the signals of output to this port is input into to the engine

  • 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 communication_type

[Read-Write] The type of communication used with this port

Type

(DMXCommunicationType)

property destination_address

[Read-Write] For Unicast, the IP address outbound DMX is sent to

Type

(str)

property device_address

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

Type

(str)

property extern_universe_start

[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.

Type

(int32)

property local_universe_start

[Read-Write] Local Start Universe

Type

(int32)

property loopback_to_engine

[Read-Write] If true, the signals of output to this port is input into to the engine

Type

(bool)

property num_universes

[Read-Write] Number of Universes

Type

(int32)

property port_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.

Type

(Guid)

property port_name

[Read-Write] The name displayed wherever the port can be displayed

Type

(str)

property priority

[Read-Write] Priority on which packets are being sent

Type

(int32)

property protocol_name

[Read-Write] DMX Protocol

Type

(Name)