unreal.DMXRuntimeLibrary

class unreal.DMXRuntimeLibrary(outer=None, name='None')

Bases: unreal.BlueprintFunctionLibrary

DMXProtocol Blueprint Library

C++ Source:

  • Plugin: DMXProtocol

  • Module: DMXProtocol

  • File: DMXProtocolBlueprintLibrary.h

classmethod get_local_dmx_network_interface_card_i_ps()

Returns the IP addresses of the network interface cards available to the system.

Returns

The Network Interface Card IP Addresses

Return type

Array(str)

classmethod is_receive_dmx_enabled() → bool

Returns whether Receive DMX from the network is enabled globally.

Returns

If true, DMX is received from the Network

Return type

bool

classmethod is_send_dmx_enabled() → bool

Returns whether send DMX to the network is enabled globally.

Returns

If true, DMX is sent to the Network

Return type

bool

classmethod set_dmx_input_port_device_address(input_port, device_address) → None

Sets the Device Address of the Output Port. For networking Protocols that’s the IP Adress of the network interface card.

Parameters

  • input_port (DMXInputPortReference) – The Input Port for which the Device Address should be set

  • device_address (str) – The Device Address the Input Port should use

classmethod set_dmx_output_port_destination_address(output_port, destination_address) → None

Set DMXOutput Port Destination Address deprecated: Deprecated 5.0. Output Ports now support many Destination Addresses. Please use SetDMXOutputPortDestinationAddresses instead.

Parameters
classmethod set_dmx_output_port_destination_addresses(output_port, destination_addresses) → None

Sets the Destination Address Address of the Output Port. For networking Protocols that’s the Unicast IP Adress. Not required for Multicast and Broadcast.

Parameters
classmethod set_dmx_output_port_device_address(output_port, device_address) → None

Sets the Device Address of the Output Port. For networking Protocols that’s the IP Adress of the network interface card.

Parameters

  • output_port (DMXOutputPortReference) – The Output Port for which the Device Address should be set

  • device_address (str) – The Device Address the Output Port should use

classmethod set_receive_dmx_enabled(receive_dmx_enabled=True, affect_editor=False) → None

Sets if DMX is received from the network

Parameters

  • receive_dmx_enabled (bool) – If true, receives inbound DMX packets on the input ports, else ignores them, globally.

  • affect_editor (bool) – If true, affects the editor.

classmethod set_send_dmx_enabled(send_dmx_enabled=True, affect_editor=False) → None

Sets if DMX is sent to the network

Parameters

  • send_dmx_enabled (bool) – If true, sends DMX packets to the output ports, else ignores all send calls globally.

  • affect_editor (bool) – If true, affects the editor.