unreal.DMXSubsystem

class unreal.DMXSubsystem(outer: Object | None = None, name: Name | str = 'None')

Bases: EngineSubsystem

UDMXSubsystem Collections of DMX context blueprint subsystem functions and internal functions for DMX K2Nodes

C++ Source:

  • Plugin: DMXEngine

  • Module: DMXRuntime

  • File: DMXSubsystem.h

Editor Properties: (see get_editor_property/set_editor_property)

  • on_protocol_received (ProtocolReceivedDelegate): [Read-Write] deprecated: WARNING: This can execute faster than tick leading to possible blueprint performance issues. Use DMXComponent’s OnFixturePatchReceived event or GetRawBuffer instead.

bytes_to_int(bytes, use_lsb=False) int32

Return integer given an array of bytes. Up to the first 4 bytes in the array will be used for the conversion.

Parameters:
  • bytes (Array[uint8]) –

  • use_lsb (bool) – Least Significant Byte mode makes the individual bytes (channels) of the function be interpreted with the first bytes being the lowest part of the number. Most Fixtures use MSB (Most Significant Byte).

Return type:

int32

bytes_to_normalized_value(bytes, use_lsb=False) float

Return normalized value given an array of bytes. Up to the first 4 bytes in the array will be used for the conversion.

Parameters:
  • bytes (Array[uint8]) –

  • use_lsb (bool) – Least Significant Byte mode makes the individual bytes (channels) of the function be interpreted with the first bytes being the lowest part of the number. Most Fixtures use MSB (Most Significant Byte).

Return type:

float

get_all_controllers_in_library(dmx_library) Array[DMXEntityController]

DEPRECATED 4.27 deprecated: Deprecated 4.27. Controllers are removed in favor of Ports.

Parameters:

dmx_library (DMXLibrary) –

Return type:

Array[DMXEntityController]

get_all_dmx_libraries() Array[DMXLibrary]

Return reference to array of DMX Library objects.

Return type:

Array[DMXLibrary]

get_all_fixture_types_in_library(dmx_library) Array[DMXEntityFixtureType]

Return reference to array of Fixture Types objects in library.

Parameters:

dmx_library (DMXLibrary) –

Return type:

Array[DMXEntityFixtureType]

get_all_fixtures_in_library(dmx_library) Array[DMXEntityFixturePatch]

Return reference to array of Fixture Patch objects in library.

Parameters:

dmx_library (DMXLibrary) –

Return type:

Array[DMXEntityFixturePatch]

get_all_fixtures_in_universe(dmx_library, universe_id) Array[DMXEntityFixturePatch]

Return reference to array of Fixture Patch objects in a given universe.

Parameters:
  • dmx_library (DMXLibrary) –

  • universe_id (int32) –

Returns:

out_result (Array[DMXEntityFixturePatch]):

Return type:

Array[DMXEntityFixturePatch]

get_all_fixtures_of_category(dmx_library, category) Array[DMXEntityFixturePatch]

Return reference to array of Fixture Patch objects of a given category.

Parameters:
Returns:

out_result (Array[DMXEntityFixturePatch]):

Return type:

Array[DMXEntityFixturePatch]

get_all_fixtures_of_type(fixture_type) Array[DMXEntityFixturePatch]

Return reference to array of Fixture Patch objects of a given type.

Parameters:

fixture_type (DMXEntityFixtureTypeRef) –

Returns:

out_result (Array[DMXEntityFixturePatch]):

Return type:

Array[DMXEntityFixturePatch]

get_all_fixtures_with_tag(dmx_library, custom_tag) Array[DMXEntityFixturePatch]

Return reference to array of Fixture Patch objects with a given tag.

Parameters:
Return type:

Array[DMXEntityFixturePatch]

get_all_matrix_cells(fixture_patch) Array[DMXCell] or None

Get All Matrix Cells deprecated: Deprecated 4.26. DMXEntityFixurePatch::GetAllMatrixCells instead

Parameters:

fixture_patch (DMXEntityFixturePatch) –

Returns:

cells (Array[DMXCell]):

Return type:

Array[DMXCell] or None

get_all_universes_in_controller(dmx_library, controller_name) Array[int32]

DEPRECATED 4.27 deprecated: Deprecated 4.27. Controllers are removed in favor of Ports.

Parameters:
Returns:

out_result (Array[int32]):

Return type:

Array[int32]

get_attribute_label(attribute_name) Name

Gets the FName for a FDMXAttributeName, since structs can’t have UFUCNTIONS to create a getter

Parameters:

attribute_name (DMXAttributeName) – the struct we want to grab the name from

Returns:

FName the name of the AttributeName

Return type:

Name

get_cell_attributes(fixture_patch) Array[DMXAttributeName] or None

Get Cell Attributes deprecated: Deprecated 4.26. DMXEntityFixurePatch::GetCellAttributes instead

Parameters:

fixture_patch (DMXEntityFixturePatch) –

Returns:

cell_attributes (Array[DMXAttributeName]):

Return type:

Array[DMXAttributeName] or None

get_controller_by_name(dmx_library, name) DMXEntityController

DEPRECATED 4.27 deprecated: Deprecated 4.27. Controllers are removed in favor of Ports.

Parameters:
Return type:

DMXEntityController

classmethod get_dmx_data_from_input_port(input_port_reference, local_universe=1) Array[uint8]

Gets accumulated latest DMX Values from the Input Port (all that’s been received since Begin Play)

Parameters:
Returns:

dmx_data (Array[uint8]):

Return type:

Array[uint8]

classmethod get_dmx_data_from_output_port(output_port_reference, local_universe=1) Array[uint8]

Gets accumulated latest DMX Values from the Output Port (all that’s been sent since Begin Play)

Parameters:
Returns:

dmx_data (Array[uint8]):

Return type:

Array[uint8]

get_fixture_attributes(fixture_patch, dmx_buffer) Map[DMXAttributeName, int32]

Return map with all DMX functions and their associated values given DMX buffer and desired universe.

Parameters:
Returns:

out_result (Map[DMXAttributeName, int32]):

Return type:

Map[DMXAttributeName, int32]

get_fixture_by_name(dmx_library, name) DMXEntityFixturePatch

Return reference to Fixture Patch object with a given name.

Parameters:
Return type:

DMXEntityFixturePatch

get_fixture_type_by_name(dmx_library, name) DMXEntityFixtureType

Return reference to Fixture Type object with a given name.

Parameters:
Return type:

DMXEntityFixtureType

get_matrix_cell(fixture_patch, coordinate) DMXCell or None

Cell coordinate X/Y deprecated: Deprecated 4.26. DMXEntityFixurePatch::GetMatrixCell instead

Parameters:
Returns:

cell (DMXCell):

Return type:

DMXCell or None

get_matrix_cell_channels_absolute(fixture_patch, coordinate) Map[DMXAttributeName, int32] or None

Cell coordinate X/Y deprecated: Deprecated 4.26. DMXEntityFixurePatch::GetMatrixCellChannelsAbsolute instead

Parameters:
Returns:

attribute_channel_map (Map[DMXAttributeName, int32]):

Return type:

Map[DMXAttributeName, int32] or None

get_matrix_cell_channels_relative(fixture_patch, coordinate) Map[DMXAttributeName, int32] or None

Cell coordinate X/Y deprecated: Deprecated 4.26. DMXEntityFixurePatch::GetMatrixCellChannelsRelative instead

Parameters:
Returns:

attribute_channel_map (Map[DMXAttributeName, int32]):

Return type:

Map[DMXAttributeName, int32] or None

get_matrix_cell_value(fixture_patch, coordinate) Map[DMXAttributeName, int32] or None

Cell coordinate X/Y deprecated: Deprecated 4.26. DMXEntityFixurePatch::GetMatrixCellValues instead

Parameters:
Returns:

attribute_value_map (Map[DMXAttributeName, int32]):

Return type:

Map[DMXAttributeName, int32] or None

get_matrix_properties(fixture_patch) DMXFixtureMatrix or None

Get Matrix Properties deprecated: Deprecated 4.26. DMXEntityFixurePatch::GetMatrixProperties instead

Parameters:

fixture_patch (DMXEntityFixturePatch) –

Returns:

matrix_properties (DMXFixtureMatrix):

Return type:

DMXFixtureMatrix or None

get_normalized_attribute_value(fixture_patch, function_attribute, value) float

Return the normalized value of an Int value from a Fixture Patch function.

Parameters:
Returns:

The normalized value of the passed in Int using the Function’s signal format. -1.0 if the Function is not found in the Fixture Patch.

Return type:

float

get_raw_buffer(selected_protocol, remote_universe) Array[uint8]

DEPRECATED 4.27 deprecated: Deprecated 4.27. Use GetDMXDataFromInputPort or GetDMXDataFromOutputPort instead.

Parameters:
Returns:

dmx_buffer (Array[uint8]):

Return type:

Array[uint8]

int_to_normalized_value(value, signal_format) float

Return the normalized value of an Int value from the specified Signal Format.

Parameters:
Return type:

float

classmethod int_value_to_bytes(value, signal_format, use_lsb=False) Array[uint8]

Return the Bytes format of Value in the desired Signal Format.

Parameters:
  • value (int32) –

  • signal_format (DMXFixtureSignalFormat) –

  • use_lsb (bool) – Least Significant Byte mode makes the individual bytes (channels) of the function be interpreted with the first bytes being the lowest part of the number. Most Fixtures use MSB (Most Significant Byte).

Returns:

bytes (Array[uint8]):

Return type:

Array[uint8]

normalized_value_to_bytes(value, signal_format, use_lsb=False) Array[uint8]

Return the Bytes format of Value in the desired Signal Format.

Parameters:
  • value (float) –

  • signal_format (DMXFixtureSignalFormat) –

  • use_lsb (bool) – Least Significant Byte mode makes the individual bytes (channels) of the function be interpreted with the first bytes being the lowest part of the number. Most Fixtures use MSB (Most Significant Byte).

Returns:

bytes (Array[uint8]):

Return type:

Array[uint8]

property on_protocol_received: ProtocolReceivedDelegate

[Read-Write] deprecated: WARNING: This can execute faster than tick leading to possible blueprint performance issues. Use DMXComponent’s OnFixturePatchReceived event or GetRawBuffer instead.

Type:

(ProtocolReceivedDelegate)

pixel_mapping_distribution_sort(distribution, num_x_panels, num_y_panels, unordered_list) Array[int32]

Sort an array according to the selected distribution pattern.

Parameters:
Returns:

out_sorted_list (Array[int32]):

Return type:

Array[int32]

send_dmx(fixture_patch, attribute_map) DMXSendResult

Send DMX using function names and integer values. deprecated: Deprecated 4.27. Use DMXEntityFixurePatch::SendDMX instead

Parameters:
Returns:

out_result (DMXSendResult):

Return type:

DMXSendResult

send_dmx_raw(selected_protocol, remote_universe, address_value_map) DMXSendResult

DEPRECATED 4.27 deprecated: Deprecated 4.27. Use SendDMXToOutputPort instead.

Parameters:
  • selected_protocol (DMXProtocolName) –

  • remote_universe (int32) –

  • address_value_map (Map[int32, uint8]) –

Returns:

out_result (DMXSendResult):

Return type:

DMXSendResult

classmethod send_dmx_to_output_port(output_port_reference, channel_to_value_map, local_universe=1) None

Sends DMX Values over the Output Port

Parameters:
set_matrix_cell_value(fixture_patch, coordinate, attribute, value) bool

Cell coordinate X/Y deprecated: Deprecated 4.26. DMXEntityFixurePatch::SendMatrixCellValue instead

Parameters:
Return type:

bool