unreal.DMXOutputPortConfig
¶
- class unreal.DMXOutputPortConfig(port_name='', protocol_name='Art-Net', communication_type=DMXCommunicationType.INTERNAL_ONLY, device_address='127.0.0.1', destination_addresses=[], loopback_to_engine=True, local_universe_start=1, num_universes=10, extern_universe_start=1, priority=100, delay=0.0, delay_frame_rate=[1, 1], 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] Communication Type: The type of communication used with this portdelay
(double): [Read-Write] Delay: The amout by which sending of packets is delayeddelay_frame_rate
(FrameRate): [Read-Write] Delay Frame Rate: Framerate of the delaydestination_address
(str): [Read-Write] Destination Address: For Unicast, the IP address outbound DMX is sent to deprecated: DestinationAddress is deprecated. Please use DestinationAddresses instead.destination_addresses
(Array(DMXOutputPortDestinationAddress)): [Read-Write] Destination Addresses: For Unicast, the IP addresses outbound DMX is sent todevice_address
(str): [Read-Write] Device Address: The IP address of the network interface card over which outbound DMX is sentextern_universe_start
(int32): [Read-Write] Extern Universe Start: 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 Universe Start: Local Start Universeloopback_to_engine
(bool): [Read-Write] Loopback to Engine: 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] Num Universes: Number of Universesport_guid
(Guid): [Read-Write] Port Guid: 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] Port Name: The name displayed wherever the port can be displayedpriority
(int32): [Read-Write] Priority: Priority on which packets are being sentprotocol_name
(Name): [Read-Write] Protocol Name: DMX Protocol
- property communication_type¶
[Read-Write] Communication Type: The type of communication used with this port
- Type
- property delay¶
[Read-Only] Delay: The amout by which sending of packets is delayed
- Type
(double)
- property destination_address¶
[Read-Write] Destination Address: For Unicast, the IP address outbound DMX is sent to deprecated: DestinationAddress is deprecated. Please use DestinationAddresses instead.
- Type
(str)
- property destination_addresses¶
[Read-Only] Destination Addresses: For Unicast, the IP addresses outbound DMX is sent to
- Type
- property device_address¶
[Read-Only] Device Address: The IP address of the network interface card over which outbound DMX is sent
- Type
(str)
- property extern_universe_start¶
[Read-Only] Extern Universe Start: 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-Only] Local Universe Start: Local Start Universe
- Type
(int32)
- property loopback_to_engine¶
[Read-Only] Loopback to Engine: 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¶
[Read-Only] Num Universes: Number of Universes
- Type
(int32)
- property port_guid¶
[Read-Only] Port Guid: 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-Only] Port Name: The name displayed wherever the port can be displayed
- Type
(str)
- property priority¶
[Read-Only] Priority: Priority on which packets are being sent
- Type
(int32)