`ableton.v2.control_surface.identifiable_control_surface` (runtime)¶

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

Module constants¶

logger = <Logger ableton.v2.control_surface.identifiable_control_surface (INFO)>

Classes¶

class `ControlSurface(SimpleControlSurface)`¶

Properties¶

_tasks
application
components
controls
device_provider
root_components
song

Methods¶

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

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

`_component_guard(self)`¶

`_disconnect_and_unregister_all_components(self)`¶

`_do_receive_midi(self, midi_bytes)`¶

`_do_receive_midi_chunk(self, midi_chunk)`¶

`_do_send_midi(self, midi_event_bytes)`¶

`_flush_midi_messages(self)`¶

`_get_tasks(self)`¶

`_init_device_provider(self)`¶

`_install_forwarding(self, midi_map_handle, control, forwarding_type=1)`¶

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

`_merge_midi_data(recipient, data, midi_data)`¶

`_pre_serialize(self)`¶

`_receive_midi_data(recipient, data)`¶

`_register_component(self, component)`¶

`_register_control(self, control)`¶

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

`_set_suppress_rebuild_requests(self, suppress_requests)`¶

`_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)`¶

`build_midi_map(self, midi_map_handle)`¶

`call_listeners(self, listeners)`¶

`can_lock_to_devices(self)`¶

`component_guard(self)`¶

`connect_script_instances(self, instanciated_scripts)`¶

`device_provider_class(song=None, *a, **k)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`disconnect_has_listener(self, slot)`¶

`disconnect_listener_count(self)`¶

`find_disconnectable(self, predicate)`¶

`get_component_by_name(self, component_name)`¶

`get_control_by_name(self, control_name)`¶

`get_recipient_for_nonsysex_midi_message(self, midi_bytes)`¶

`get_registry_entry_for_sysex_midi_message(self, midi_bytes)`¶

`has_disconnectable(self, slot)`¶

`lock_to_device(self, device)`¶

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

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

`port_settings_changed(self)`¶

`process_midi_bytes(self, midi_bytes, midi_processor)`¶

`receive_midi(self, midi_bytes)`¶

`receive_midi_chunk(self, midi_chunk)`¶

`received_midi_has_listener(self, slot)`¶

`received_midi_listener_count(self)`¶

`refresh_state(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`register_slot(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_enabled(self, enable)`¶

`set_feedback_channels(self, channels)`¶

`set_pad_translations(self, pad_translations)`¶

`show_message(self, message)`¶

`suggest_map_mode(self, cc_no, channel)`¶

`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)`¶

`update_display_hook(self)`¶

Attributes¶

handle_undo_steps = False - bool(x) -> bool
preferences = <ableton.v2.base.util.lazy_attribute object at 0x11df16048>
preferences_key = None

class `IdentifiableControlSurface(ControlSurface)`¶

Properties¶

_tasks
application
components
controls
device_provider
root_components
song

Methods¶

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

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

`_component_guard(self)`¶

`_disconnect_and_unregister_all_components(self)`¶

`_do_receive_midi(self, midi_bytes)`¶

`_do_receive_midi_chunk(self, midi_chunk)`¶

`_do_send_midi(self, midi_event_bytes)`¶

`_extract_product_id_bytes(self, midi_bytes)`¶

`_flush_midi_messages(self)`¶

`_get_tasks(self)`¶

`_init_device_provider(self)`¶

`_install_forwarding(self, midi_map_handle, control, forwarding_type=1)`¶

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

`_is_identity_response(self, midi_bytes)`¶

`_merge_midi_data(recipient, data, midi_data)`¶

`_pre_serialize(self)`¶

`_receive_midi_data(recipient, data)`¶

`_register_component(self, component)`¶

`_register_control(self, control)`¶

`_send_identity_request(self)`¶

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

`_set_suppress_rebuild_requests(self, suppress_requests)`¶

`_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)`¶

`build_midi_map(self, midi_map_handle)`¶

`call_listeners(self, listeners)`¶

`can_lock_to_devices(self)`¶

`component_guard(self)`¶

`connect_script_instances(self, instanciated_scripts)`¶

`device_provider_class(song=None, *a, **k)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`disconnect_has_listener(self, slot)`¶

`disconnect_listener_count(self)`¶

`find_disconnectable(self, predicate)`¶

`get_component_by_name(self, component_name)`¶

`get_control_by_name(self, control_name)`¶

`get_recipient_for_nonsysex_midi_message(self, midi_bytes)`¶

`get_registry_entry_for_sysex_midi_message(self, midi_bytes)`¶

`has_disconnectable(self, slot)`¶

`lock_to_device(self, device)`¶

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

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

`on_identified(self, response_bytes)`¶

`port_settings_changed(self)`¶

`process_midi_bytes(self, midi_bytes, midi_processor)`¶

`receive_midi(self, midi_bytes)`¶

`receive_midi_chunk(self, midi_chunk)`¶

`received_midi_has_listener(self, slot)`¶

`received_midi_listener_count(self)`¶

`refresh_state(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`register_slot(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_enabled(self, enable)`¶

`set_feedback_channels(self, channels)`¶

`set_pad_translations(self, pad_translations)`¶

`show_message(self, message)`¶

`suggest_map_mode(self, cc_no, channel)`¶

`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)`¶

`update_display_hook(self)`¶

Attributes¶

handle_undo_steps = False - bool(x) -> bool
identity_request = (240, 126, 127, 6, 1, 247) - Built-in immutable sequence.
identity_request_delay = 0.0 - Convert a string or number to a floating point number, if possible.
preferences = <ableton.v2.base.util.lazy_attribute object at 0x11df16048>
preferences_key = None

ableton.v2.control_surface.identifiable_control_surface (runtime)¶

Module constants¶

Classes¶

class ControlSurface(SimpleControlSurface)¶

Properties¶

Methods¶

__init__(self, *a, **k)¶

_component_guard(self)¶

_disconnect_and_unregister_all_components(self)¶

_do_receive_midi(self, midi_bytes)¶

_do_receive_midi_chunk(self, midi_chunk)¶

_do_send_midi(self, midi_event_bytes)¶

_flush_midi_messages(self)¶

_get_tasks(self)¶

_init_device_provider(self)¶

_install_forwarding(self, midi_map_handle, control, forwarding_type=1)¶

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

_merge_midi_data(recipient, data, midi_data)¶

_pre_serialize(self)¶

_receive_midi_data(recipient, data)¶

_register_component(self, component)¶

_register_control(self, control)¶

_send_midi(self, midi_event_bytes, optimized=True)¶

_set_suppress_rebuild_requests(self, suppress_requests)¶

_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)¶

build_midi_map(self, midi_map_handle)¶

call_listeners(self, listeners)¶

can_lock_to_devices(self)¶

component_guard(self)¶

connect_script_instances(self, instanciated_scripts)¶

device_provider_class(song=None, *a, **k)¶

disconnect(self)¶

disconnect_disconnectable(self, slot)¶

disconnect_has_listener(self, slot)¶

disconnect_listener_count(self)¶

find_disconnectable(self, predicate)¶

get_component_by_name(self, component_name)¶

get_control_by_name(self, control_name)¶

get_recipient_for_nonsysex_midi_message(self, midi_bytes)¶

get_registry_entry_for_sysex_midi_message(self, midi_bytes)¶

has_disconnectable(self, slot)¶

lock_to_device(self, device)¶

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

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

port_settings_changed(self)¶

process_midi_bytes(self, midi_bytes, midi_processor)¶

receive_midi(self, midi_bytes)¶

receive_midi_chunk(self, midi_chunk)¶

received_midi_has_listener(self, slot)¶

received_midi_listener_count(self)¶

refresh_state(self)¶

register_disconnectable(self, slot)¶

register_disconnectables(self, disconnectables)¶

register_slot(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_enabled(self, enable)¶

set_feedback_channels(self, channels)¶

set_pad_translations(self, pad_translations)¶

show_message(self, message)¶

suggest_map_mode(self, cc_no, channel)¶

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

update_display_hook(self)¶

Attributes¶

class IdentifiableControlSurface(ControlSurface)¶

Properties¶

`ableton.v2.control_surface.identifiable_control_surface` (runtime)¶

class `ControlSurface(SimpleControlSurface)`¶

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

`_component_guard(self)`¶

`_disconnect_and_unregister_all_components(self)`¶

`_do_receive_midi(self, midi_bytes)`¶

`_do_receive_midi_chunk(self, midi_chunk)`¶

`_do_send_midi(self, midi_event_bytes)`¶

`_flush_midi_messages(self)`¶

`_get_tasks(self)`¶

`_init_device_provider(self)`¶

`_install_forwarding(self, midi_map_handle, control, forwarding_type=1)`¶

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

`_merge_midi_data(recipient, data, midi_data)`¶

`_pre_serialize(self)`¶

`_receive_midi_data(recipient, data)`¶

`_register_component(self, component)`¶

`_register_control(self, control)`¶

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

`_set_suppress_rebuild_requests(self, suppress_requests)`¶

`_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)`¶

`build_midi_map(self, midi_map_handle)`¶

`call_listeners(self, listeners)`¶

`can_lock_to_devices(self)`¶

`component_guard(self)`¶

`connect_script_instances(self, instanciated_scripts)`¶

`device_provider_class(song=None, *a, **k)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`disconnect_has_listener(self, slot)`¶

`disconnect_listener_count(self)`¶

`find_disconnectable(self, predicate)`¶

`get_component_by_name(self, component_name)`¶

`get_control_by_name(self, control_name)`¶

`get_recipient_for_nonsysex_midi_message(self, midi_bytes)`¶

`get_registry_entry_for_sysex_midi_message(self, midi_bytes)`¶

`has_disconnectable(self, slot)`¶

`lock_to_device(self, device)`¶

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

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

`port_settings_changed(self)`¶

`process_midi_bytes(self, midi_bytes, midi_processor)`¶

`receive_midi(self, midi_bytes)`¶

`receive_midi_chunk(self, midi_chunk)`¶

`received_midi_has_listener(self, slot)`¶

`received_midi_listener_count(self)`¶

`refresh_state(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`register_slot(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_enabled(self, enable)`¶

`set_feedback_channels(self, channels)`¶

`set_pad_translations(self, pad_translations)`¶

`show_message(self, message)`¶

`suggest_map_mode(self, cc_no, channel)`¶

`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)`¶

`update_display_hook(self)`¶

class `IdentifiableControlSurface(ControlSurface)`¶

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

`_component_guard(self)`¶

`_disconnect_and_unregister_all_components(self)`¶

`_do_receive_midi(self, midi_bytes)`¶

`_do_receive_midi_chunk(self, midi_chunk)`¶

`_do_send_midi(self, midi_event_bytes)`¶