Skip to content

Ableton Live MIDI Remote Scripts — Unofficial Docs & Tools

_Framework.IdentifiableControlSurface (runtime)

`_Framework.IdentifiableControlSurface` (runtime)¶

Live 12 — Live Object Model & framework reference (descriptions and signatures).

Module constants¶

SYSEX_IDENTITY_REQUEST = (240, 126, 0, 6, 1, 247)

Classes¶

class `ControlSurface(Subject, SlotManager)`¶

Properties¶

_tasks
components
in_component_guard
root_components

Methods¶

`init(self, c_instance=None, *a, **k)`¶

Initialize self. See help(type(self)) for accurate signature.

`_component_guard(self)`¶

`_control_surfaces(self)`¶

`_disconnect_and_unregister_all_components(self)`¶

`_do_receive_midi(self, midi_bytes)`¶

`_do_send_midi(self, midi_event_bytes)`¶

`_flush_midi_messages(self)`¶

`_get_tasks(self)`¶

`_install_forwarding(self, midi_map_handle, control)`¶

`_install_mapping(self, midi_map_handle, control, parameter, feedback_delay, feedback_map)`¶

`_on_scene_list_changed(self)`¶

`_on_selected_scene_changed(self)`¶

`_on_selected_track_changed(self)`¶

`_on_track_list_changed(self)`¶

`_process_remaining_scheduled_messages(self)`¶

`_refresh_displays(self)`¶

`_register_component(self, component)`¶

`_register_control(self, control)`¶

`_send_midi(self, midi_event_bytes, optimized=True)`¶

`_set_session_highlight(self, track_offset, scene_offset, width, height, include_return_tracks)`¶

`_set_suppress_rebuild_requests(self, suppress_requests)`¶

`_toggle_lock(self)`¶

`_translate_message(self, type, from_identifier, from_channel, to_identifier, to_channel)`¶

`accumulating_midi_messages(self)`¶

`add_disconnect_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_received_midi_listener(self, slot, identify_sender=False, *a, **k)`¶

`application(self)`¶

`build_midi_map(self, midi_map_handle)`¶

`call_listeners(self, listeners)`¶

`can_lock_to_devices(self)`¶

`clear_disconnect_listeners(self)`¶

`clear_received_midi_listeners(self)`¶

`component_guard(self)`¶

`connect_script_instances(self, instanciated_scripts)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`disconnect_has_listener(self, slot)`¶

`disconnect_listener_count(self)`¶

`find_disconnectable(self, predicate)`¶

`get_control_by_name(self, control_name)`¶

`get_recipient_for_nonsysex_midi_message(self, midi_bytes)`¶

`handle_nonsysex(self, midi_bytes)`¶

`handle_sysex(self, midi_bytes)`¶

`has_disconnectable(self, slot)`¶

`highlighting_session_component(self)`¶

`instance_identifier(self)`¶

`is_sysex_message(self, midi_bytes)`¶

`lock_to_device(self, device)`¶

`log_message(self, *message)`¶

`notify_disconnect(self, *a, **k)`¶

`notify_received_midi(self, *a, **k)`¶

`port_settings_changed(self)`¶

`receive_midi(self, midi_bytes)`¶

`received_midi_has_listener(self, slot)`¶

`received_midi_listener_count(self)`¶

`refresh_state(self)`¶

`register_disconnectable(self, slot)`¶

`register_slot(self, *a, **k)`¶

`register_slot_manager(self, *a, **k)`¶

`release_controlled_track(self)`¶

`remove_disconnect_listener(self, slot)`¶

`remove_received_midi_listener(self, slot)`¶

`request_rebuild_midi_map(self)`¶

`restore_bank(self, bank_index)`¶

`schedule_message(self, delay_in_ticks, callback, parameter=None)`¶

`set_controlled_track(self, track)`¶

`set_device_component(self, device_component)`¶

`set_enabled(self, enable)`¶

`set_feedback_channels(self, channels)`¶

`set_highlighting_session_component(self, session_component)`¶

`set_pad_translations(self, pad_translations)`¶

`show_message(self, message)`¶

`song(self)`¶

`suggest_input_port(self)`¶

`suggest_map_mode(self, cc_no, channel)`¶

`suggest_needs_takeover(self, cc_no, channel)`¶

`suggest_output_port(self)`¶

`supports_pad_translation(self)`¶

`suppressing_rebuild_requests(self)`¶

`toggle_lock(self)`¶

`unlock_from_device(self, device)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

`update_display(self)`¶

Attributes¶

received_midi = () - Built-in immutable sequence.

class `IdentifiableControlSurface(ControlSurface)`¶

Properties¶

_tasks
components
in_component_guard
root_components

Methods¶

`init(self, product_id_bytes=None, *a, **k)`¶

Initialize self. See help(type(self)) for accurate signature.

`_component_guard(self)`¶

`_control_surfaces(self)`¶

`_disconnect_and_unregister_all_components(self)`¶

`_do_receive_midi(self, midi_bytes)`¶

`_do_send_midi(self, midi_event_bytes)`¶

`_extract_product_id_bytes(self, midi_bytes)`¶

`_flush_midi_messages(self)`¶

`_get_tasks(self)`¶

`_install_forwarding(self, midi_map_handle, control)`¶

`_install_mapping(self, midi_map_handle, control, parameter, feedback_delay, feedback_map)`¶

`_is_identity_response(self, midi_bytes)`¶

`_on_scene_list_changed(self)`¶

`_on_selected_scene_changed(self)`¶

`_on_selected_track_changed(self)`¶

`_on_track_list_changed(self)`¶

`_process_remaining_scheduled_messages(self)`¶

`_refresh_displays(self)`¶

`_register_component(self, component)`¶

`_register_control(self, control)`¶

`_send_identity_request(self)`¶

`_send_midi(self, midi_event_bytes, optimized=True)`¶

`_set_session_highlight(self, track_offset, scene_offset, width, height, include_return_tracks)`¶

`_set_suppress_rebuild_requests(self, suppress_requests)`¶

`_toggle_lock(self)`¶

`_translate_message(self, type, from_identifier, from_channel, to_identifier, to_channel)`¶

`accumulating_midi_messages(self)`¶

`add_disconnect_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_received_midi_listener(self, slot, identify_sender=False, *a, **k)`¶

`application(self)`¶

`build_midi_map(self, midi_map_handle)`¶

`call_listeners(self, listeners)`¶

`can_lock_to_devices(self)`¶

`clear_disconnect_listeners(self)`¶

`clear_received_midi_listeners(self)`¶

`component_guard(self)`¶

`connect_script_instances(self, instanciated_scripts)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`disconnect_has_listener(self, slot)`¶

`disconnect_listener_count(self)`¶

`find_disconnectable(self, predicate)`¶

`get_control_by_name(self, control_name)`¶

`get_recipient_for_nonsysex_midi_message(self, midi_bytes)`¶

`handle_nonsysex(self, midi_bytes)`¶

`handle_sysex(self, midi_bytes)`¶

`has_disconnectable(self, slot)`¶

`highlighting_session_component(self)`¶

`instance_identifier(self)`¶

`is_sysex_message(self, midi_bytes)`¶

`lock_to_device(self, device)`¶

`log_message(self, *message)`¶

`notify_disconnect(self, *a, **k)`¶

`notify_received_midi(self, *a, **k)`¶

`on_identified(self)`¶

`port_settings_changed(self)`¶

`receive_midi(self, midi_bytes)`¶

`received_midi_has_listener(self, slot)`¶

`received_midi_listener_count(self)`¶

`refresh_state(self)`¶

`register_disconnectable(self, slot)`¶

`register_slot(self, *a, **k)`¶

`register_slot_manager(self, *a, **k)`¶

`release_controlled_track(self)`¶

`remove_disconnect_listener(self, slot)`¶

`remove_received_midi_listener(self, slot)`¶

`request_rebuild_midi_map(self)`¶

`restore_bank(self, bank_index)`¶

`schedule_message(self, delay_in_ticks, callback, parameter=None)`¶

`set_controlled_track(self, track)`¶

`set_device_component(self, device_component)`¶

`set_enabled(self, enable)`¶

`set_feedback_channels(self, channels)`¶

`set_highlighting_session_component(self, session_component)`¶

`set_pad_translations(self, pad_translations)`¶

`show_message(self, message)`¶

`song(self)`¶

`suggest_input_port(self)`¶

`suggest_map_mode(self, cc_no, channel)`¶

`suggest_needs_takeover(self, cc_no, channel)`¶

`suggest_output_port(self)`¶

`supports_pad_translation(self)`¶

`suppressing_rebuild_requests(self)`¶

`toggle_lock(self)`¶

`unlock_from_device(self, device)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

`update_display(self)`¶

Attributes¶

identity_request = (240, 126, 0, 6, 1, 247) - Built-in immutable sequence.
identity_request_delay = 0.5 - Convert a string or number to a floating point number, if possible.
received_midi = () - Built-in immutable sequence.