_MxDCore.MxDCore

Module constants

• logger
• PATH_KEY = 'CURRENT_PATH'
• ID_KEY = 'CURRENT_LOM_ID'
• TYPE_KEY = 'CURRENT_TYPE'
• PROP_KEY = 'CURRENT_PROPERTY'
• PROP_LISTENER_KEY = 'PROPERTY_LISTENER'
• PATH_LISTENER_KEY = 'PATH_LISTENERS'
• OPEN_OPERATIONS_KEY = 'OPEN_OPERATION'
• NOTE_BUFFER_KEY = 'NOTE_BUFFER'
• NOTE_OPERATION_KEY = 'NOTE_OPERATION'
• NOTE_COUNT_KEY = 'NOTE_COUNT'
• NOTE_REPLACE_KEY = 'NOTE_REPLACE'
• NOTE_SET_KEY = 'NOTE_SET'
• CONTAINS_CS_ID_KEY = 'CONTAINS_CS_ID_KEY'
• GRABBED_CONTROLS_KEY = 'GRABBED_CONTROLS_KEY'
• LAST_SENT_ID_KEY = 'LAST_SENT_ID'
• INVALID_DICT_ENTRY_ERROR = 'Invalid entry in the dictionary'
• INVALID_ID_ERROR = 'Provide a list of valid note IDs or a dictionary with function parameters as keys'
• MALFORMATTED_DICTIONARY_ERROR = 'Malformatted dictionary argument'
• NOTES_API_MAIN_KEY_ERROR = "Expecting 'notes' as the main dictionary's key"
• NOTE_IDS_MISSING_ERROR = "Required key 'note_ids' is missing"
• NOTE_ID_MISSING_ERROR = "Required key 'note_id' is missing"
• PARSE_ERROR = 'Error parsing parameters'
• PRIVATE_PROP_WARNING = 'Warning: Calling private property. This property might change or be removed in the future.'
• WARP_MARKER_SPEC_INCOMPLETE_ERROR = 'At least beat time needs to be specified'
• GrabbedControl

Classes

class MaxObjectType(Enum)

Bases: Enum

Attributes

• ANYTHING = 0
• PATH = 1
• OBJECT = 2
• OBSERVER = 3
• REMOTE = 4
• MODULATE = 5

class MxDCore(object)

Bases: object

Attributes

• instance = None

__init__(self, *a, **k)

disconnect(self)

set_manager(self, manager)

_get_lom_object_by_lom_id(self, referring_device_id, lom_id)

_lom_id_exists(self, referring_device_id, lom_id)

_get_lom_id_by_lom_object(self, lom_object)

_get_lom_id_to_mapped_objects_map(self, lom_ids)

_get_object_path(self, device_id, lom_object)

_is_integer(self, s)

_set_current_lom_id(self, device_id, object_id, lom_id, type)

_get_current_lom_id(self, device_id, object_id)

_setting_lom_id_is_supported(self, device_id, object_id, object_type, new_id)

_set_current_lom_id_from_param(self, device_id, object_id, object_type, parameter)

_set_current_type(self, device_id, object_id, type)

_get_current_type(self, device_id, object_id)

_set_current_property(self, device_id, object_id, property_name)

_get_current_property(self, device_id, object_id)

update_device_context(self, device_id, object_id)

release_device_context(self, device_id, *_)

prepare_control_surface_update(self, *_)

path_set_path(self, device_id, object_id, parameters)

path_goto(self, device_id, object_id, parameters)

path_get_id(self, device_id, object_id, parameters)

path_bang(self, device_id, object_id, parameters)

_get_path_and_object(self, device_id, object_id)

_get_lom_object_properties(self, device_id, object_id, looking_for)

path_get_props(self, device_id, object_id, parameters)

path_get_children(self, device_id, object_id, parameters)

path_get_count(self, device_id, object_id, parameters)

obj_set_id(self, device_id, object_id, parameter)

obj_get_id(self, device_id, object_id, parameter)

obj_get_path(self, device_id, object_id, parameters)

obj_get_type(self, device_id, object_id, parameters)

obj_get_info(self, device_id, object_id, parameters)

obj_set_val(self, device_id, object_id, parameters)

_set_property_value(self, lom_object, property_name, value)

_warn_if_using_private_property(self, device_id, object_id, property_name)

obj_set(self, device_id, object_id, parameters)

obj_get_val(self, device_id, object_id, parameters)

obj_get(self, device_id, object_id, parameters)

obj_call(self, device_id, object_id, parameters)

obs_set_id(self, device_id, object_id, parameter)

obs_get_id(self, device_id, object_id, parameter)

obs_set_prop(self, device_id, object_id, parameter)

obs_get_prop(self, device_id, object_id, parameter)

obs_get_type(self, device_id, object_id, parameter)

obs_bang(self, device_id, object_id, parameter)

rmt_set_id(self, device_id, object_id, parameter)

rmt_get_id(self, device_id, object_id, parameter)

mod_set_id(self, device_id, object_id, parameter)

mod_get_id(self, device_id, object_id, parameter)

_object_attr_path_iter(self, device_id, object_id, path_components)

_object_from_path(self, device_id, object_id, path_components, must_exist)

_get_current_lom_object(self, device_id, object_id)

_object_for_id(self, device_id)

str_representation_for_object(self, obj, mark_ids)

_install_path_listeners(self, device_id, object_id, listener_callback)

_uninstall_path_listeners(self, device_id, object_id)

_path_listener_callback(self, device_id, object_id)

_goto_path(self, device_id, object_id, parameters)

_object_default_call_handler(self, device_id, object_id, lom_object, parameters)

_object_get_notes_handler(self, device_id, object_id, lom_object, parameters)

_extract_dict_from_parameters(self, parameters)

_object_get_notes_by_id_handler(self, device_id, object_id, lom_object, parameters)

_object_get_notes_extended_handler(self, device_id, object_id, lom_object, parameters)

_do_get_notes_extended(self, device_id, object_id, lom_object, function_name, param_dict, *function_parameters)

_object_add_new_notes_handler(self, device_id, object_id, lom_object, parameters)

_object_warp_marker_handler(self, device_id, object_id, lom_object, parameters)

_object_events_in_range_handler(self, device_id, object_id, lom_object, parameters)

_object_create_event_handler(self, device_id, object_id, lom_object, parameters)

_object_apply_note_modifications_handler(self, device_id, object_id, lom_object, parameters)

_object_duplicate_notes_by_id_handler(self, device_id, object_id, lom_object, parameters)

_object_perform_operation_on_notes_by_id_handler(self, device_id, object_id, lom_object, parameters)

_object_selected_notes_handler(self, device_id, object_id, lom_object, parameters)

_object_set_notes_handler(self, device_id, object_id, lom_object, parameters)

_object_replace_selected_notes_handler(self, device_id, object_id, lom_object, parameters)

_object_notes_handler(self, device_id, object_id, lom_object, parameters)

_object_note_handler(self, device_id, object_id, lom_object, parameters)

_selector_for_note_operation(self, note_operation)

_object_done_handler(self, device_id, object_id, lom_object, parameters)

_object_grab_handler(self, device_id, object_id, lom_object, parameters)

_object_release_handler(self, device_id, object_id, lom_object, parameters)

_create_notes_output(self, notes)

_midi_note_vector_to_dict_output(self, notes, properties_to_return)

_sanitize_midi_note_property_list(self, device_id, object_id, property_list)

_get_list_of_note_dictionaries(self, parameter)

_start_note_operation(self, device_id, object_id, lom_object, parameters, operation)

_stop_note_operation(self, device_id, object_id)

update_observer_listener(self, device_id, object_id)

install_observer_listener(self, device_id, object_id)

uninstall_observer_listener(self, device_id, object_id)

update_mapped_object_links(self, id_or_ids)

_observer_update_listener(self, device_id, object_id)

_observer_install_listener(self, device_id, object_id)

_observer_uninstall_listener(self, device_id, object_id)

_observer_property_message_type(self, prop, prop_info)

_observer_property_callback(self, device_id, object_id, *args)

_observer_id_callback(self, device_id, object_id)

update_timeable(self, device_id, object_id, object_type)

reset_all_current_lom_ids(self, device_id)

_update_timeable(self, device_id, object_id, object_type, validate_change_allowed)

_disambiguate_object(self, object)

_listenable_property_for(self, prop_name)

_get_lom_object_prop(self, lom_object, property_name)

_parse(self, device_id, object_id, string)

_print_error(self, device_id, object_id, message)

_print_warning(self, device_id, object_id, message)

Functions

get_current_max_device(device_id)

sanitize_list(passed_list, valid_elements)

concatenate_strings(string_list, string_format)

parameter_to_bool(parameter)

note_from_parameters(parameters)

get_object_type_name(obj)

max_object_type_to_enum(object_type)