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

Converts consecutive DMX channel values to a signed 32bit integer value.

Parameters:

  • bytes (Array[uint8]) – The byte array that is converted to a normalized value. Up to 3 bytes (24 bits) are supported.

  • use_lsb (bool) – When true, the byte array is interpreted in little endian format (least significant byte first) otherwise big endian.

Returns:

The signed 32bit integer value.

Return type:

int32

bytes_to_normalized_value(bytes, use_lsb=False) → float

Converts consecutive DMX channel values to a normalized value.

Parameters:

  • bytes (Array[uint8]) – The byte array that is converted to a normalized value. Up to 4 bytes (32 bits) are supported.

  • use_lsb (bool) – When true, the byte array is returned in little endian format (least significant byte first) otherwise big endian.

Returns:

The normalized value.

Return type:

float

classmethod clear_dmx_buffers() → None

Clears all buffered DMX data of Ports and Fixture Patches. Note, this function clears the buffers, it does not zero them out. To reset to default or zero, see Fixture Patch members Send Default Values and Send Zero Values.

get_all_controllers_in_library(dmx_library) → Array[DMXEntityController]

Get All Controllers in Library deprecated: Deprecated 4.27. Controllers are removed in favor of Ports.

Parameters:

dmx_library (DMXLibrary)

Return type:

Array[DMXEntityController]

get_all_dmx_libraries() → None

deprecated: ‘get_all_dmx_libraries’ was renamed to ‘load_dmx_libraries_synchronous’.

get_all_fixture_types_in_library(dmx_library) → Array[DMXEntityFixtureType]

Returns all Fixture Types in a DMX Library.

Parameters:

dmx_library (DMXLibrary)

Return type:

Array[DMXEntityFixtureType]

get_all_fixtures_in_library(dmx_library) → Array[DMXEntityFixturePatch]

Return an array of Fixture Patches in the provided DMX Library.

Parameters:

dmx_library (DMXLibrary)

Return type:

Array[DMXEntityFixturePatch]

get_all_fixtures_in_universe(dmx_library, universe_id) → Array[DMXEntityFixturePatch]

Return an array of Fixture Patches that reside in the provided universe.

Parameters:
Returns:

out_result (Array[DMXEntityFixturePatch]):

Return type:

Array[DMXEntityFixturePatch]

get_all_fixtures_of_category(dmx_library, category) → Array[DMXEntityFixturePatch]

Return an array of Fixture Patches that use the provided category.

Parameters:
Returns:

out_result (Array[DMXEntityFixturePatch]):

Return type:

Array[DMXEntityFixturePatch]

get_all_fixtures_of_type(fixture_type) → Array[DMXEntityFixturePatch]

Return an array of Fixture Patches that use the provided Fixture 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 an array of Fixture Patches that have the custom tag set.

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]

Get All Universes in Controller 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 of an Attribute Name.

Parameters:

attribute_name (DMXAttributeName) – The Attribute Name struct.

Returns:

The name of the Attribute

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

Get Controller by Name 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 latest DMX Values from a DMX Universe of a DMX Input Port. If no DMX was received the resulting array will be empty.

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 latest DMX Values from a DMX Universe of a DMX Output Port. If no DMX was received the resulting array will be empty.

Parameters:
Returns:

dmx_data (Array[uint8]):

Return type:

Array[uint8]

get_dmx_libraries() → Array[DMXLibrary]

Gets all DMX Libraries in this project, returns an array of Soft Object References to the DMX Libraries without loading them.

Return type:

Array[DMXLibrary]

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

Get Fixture Attributes deprecated: Deprecated 5.5. Instead please call the Fixture Patch function ‘Get Attribute Values’ to retrieve attribute values safely.

Parameters:
Returns:

out_result (Map[DMXAttributeName, int32]):

Return type:

Map[DMXAttributeName, int32]

get_fixture_by_name(dmx_library, name) → DMXEntityFixturePatch

Return the Fixture Patch with given name or an invalid object if no Fixture Patch matches the name.

Parameters:
Return type:

DMXEntityFixturePatch

get_fixture_type_by_name(dmx_library, name) → DMXEntityFixtureType

Return the Fixture Type with provided name or an invalid object if no Fixture Type matches the 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

Get Normalized Attribute Value deprecated: Deprecated 5.5. Instead please call the optimized Fixture Patch function ‘Get Attribute Value’ to retrieve the attribute value.

Parameters:
Return type:

float

get_raw_buffer(selected_protocol, remote_universe) → Array[uint8]

Get Raw Buffer 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

Converts a signed 32bit integer value to a normalized value.

Parameters:

  • value (int32) – The signed 32bit integer value. The value range depends on the signal format (e.g. 0-65535 for 16bit). Excess values get clamped.

  • signal_format (DMXFixtureSignalFormat)

Returns:

The normalized value.

Return type:

float

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

Converts a signed 32bit integer value to an array of DMX channel values.

Parameters:

  • value (int32) – The signed 32bit integer value. The value range depends on the signal format. Excess values get clamped.

  • signal_format (DMXFixtureSignalFormat) – Specifies the resolution of the resulting byte array, hence the precision of resulting data (e.g. 0-65535 for 16bit).

  • use_lsb (bool) – When true, the byte array is returned in little endian format (least significant byte first) otherwise big endian.

Returns:

bytes (Array[uint8]): The resulting byte array.

Return type:

Array[uint8]

load_dmx_libraries_synchronous() → Array[DMXLibrary]

Loads all DMX Libraries in this project synchronous, returns an array of DMX Libraries

Return type:

Array[DMXLibrary]

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

Converts a normalized value to an array of DMX channel values.

Parameters:

  • value (float) – The normalized floating point value in the range of 0.0 - 1.0. Other values get clamped.

  • signal_format (DMXFixtureSignalFormat) – Specifies the resolution of the resulting byte array, hence the precision of resulting data (e.g. 0-65535 for 16bit).

  • use_lsb (bool) – When true, the byte array is returned in little endian format (least significant byte first) otherwise big endian.

Returns:

bytes (Array[uint8]): The resulting byte array.

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

Send DMXRaw 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 via an 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