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

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

Functions¶

`make_button(name, channel, number, midi_message_type)`¶

`make_encoder(name, channel, number, midi_message_type)`¶

`make_slider(name, channel, number, midi_message_type)`¶

Classes¶

class `ButtonElement(InputControlElement, ButtonElementMixin)`¶

Properties¶

_last_sent_value
is_feedback_enabled
mapping_sensitivity
resource
script_forwarding
send_depends_on_forwarding
suppress_script_forwarding

Methods¶

`Colors()`¶

`ProxiedInterface(outer=None, *a, **k)`¶

`init(self, is_momentary, msg_type, channel, identifier, is_rgb=False, skin=<ableton.v2.control_surface.skin.Skin object at 0x16311f550>, undo_step_handler=<ableton.v2.control_surface.elements.button.DummyUndoStepHandler object at 0x16311f940>, send_should_depend_on_forwarding=False, *a, **k)`¶

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

`_disconnect_color_listener(self)`¶

`_do_draw(self, color)`¶

`_do_send_value(self, value, channel=None)`¶

`_mapping_feedback_values(self)`¶

`_on_resource_lost(self, client)`¶

`_on_resource_received(self, client, *a, **k)`¶

`_report_value(self, value, is_input)`¶

`_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)`¶

`_send_delayed_messages(self)`¶

`_set_skin_light(self, value)`¶

`_status_byte(self, channel)`¶

`_verify_value(self, value)`¶

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

`begin_gesture(self)`¶

`clear_send_cache(self)`¶

`connect_to(self, parameter)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`end_gesture(self)`¶

`find_disconnectable(self, predicate)`¶

`force_next_send(self)`¶

`has_disconnectable(self, slot)`¶

`identifier_bytes(self)`¶

`install_connections(self, install_translation, install_mapping, install_forwarding)`¶

`is_momentary(self)`¶

`is_pressed(self)`¶

`mapped_parameter(self)`¶

`max_value(self)`¶

`message_channel(self)`¶

`message_identifier(self)`¶

`message_map_mode(self)`¶

`message_sysex_identifier(self)`¶

`message_type(self)`¶

`needs_takeover(self)`¶

`notify_ownership_change(self, client, grabbed, element_ownership_handler=None)`¶

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

`original_channel(self)`¶

`original_identifier(self)`¶

`receive_chunk(self, chunk)`¶

`receive_value(self, value)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`release_parameter(self)`¶

`remove_value_listener(self, slot)`¶

`reset(self)`¶

`reset_state(self)`¶

`script_wants_forwarding(self)`¶

`send_midi(self, message)`¶

`send_value(self, value, force=False, channel=None)`¶

`set_channel(self, channel)`¶

`set_feedback_delay(self, delay)`¶

`set_identifier(self, identifier)`¶

`set_light(self, value)`¶

`set_needs_takeover(self, needs_takeover)`¶

`set_report_values(self, report_input, report_output)`¶

`unregister_disconnectable(self, slot)`¶

`use_default_message(self)`¶

`value_has_listener(self, slot)`¶

`value_listener_count(self)`¶

Attributes¶

_ButtonElement__on_midi_value_changed = None
_has_resource = False - bool(x) -> bool
_has_task_group = False - bool(x) -> bool
_input_signal_listener_count = 0 - int([x]) -> integer
_resource = <ableton.v2.base.util.lazy_attribute object at 0x11b312780>
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x1630c8898>
allow_receiving_chunks = False - bool(x) -> bool
canonical_parent = None
name = '' - str(object='') -> str
num_delayed_messages = 2 - int([x]) -> integer
optimized_send_midi = True - bool(x) -> bool
proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>

class `ButtonMatrixElement(CompoundElement)`¶

Properties¶

resource
submatrix

Methods¶

`ProxiedInterface(outer=None, *a, **k)`¶

`init(self, rows=[], *a, **k)`¶

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

`_connect_nested_control_elements(self)`¶

`_disconnect_nested_control_elements(self)`¶

`_do_get_item(self, index)`¶

`_get_nested_client(self, client)`¶

`_grab_nested_control_elements(self, client, priority=None, **k)`¶

`_on_nested_control_element_lost(self, control)`¶

`_on_nested_control_element_received(self, control)`¶

`_on_resource_lost(self, client)`¶

`_on_resource_received(self, client, *a, **k)`¶

`_release_nested_control_elements(self, client)`¶

`_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)`¶

`add_row(self, buttons)`¶

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

Called when the control element receives a MIDI value from the hardware

`clear_send_cache(self)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`find_disconnectable(self, predicate)`¶

`get_button(self, row, column)`¶

`get_control_element_priority(self, element, priority)`¶

`has_control_element(self, control)`¶

`has_disconnectable(self, slot)`¶

`height(self)`¶

`iterbuttons(self)`¶

`nested_control_elements(self)`¶

`notify_ownership_change(self, client, grabbed, element_ownership_handler=None)`¶

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

Called when the control element receives a MIDI value from the hardware

`on_nested_control_element_lost(self, control)`¶

`on_nested_control_element_received(self, control)`¶

`on_nested_control_element_value(self, value, sender)`¶

`owned_control_elements(self)`¶

`owns_control_element(self, control)`¶

`register_control_element(self, element)`¶

`register_control_elements(self, *elements)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

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

Called when the control element receives a MIDI value from the hardware

`request_listen_nested_control_elements(self)`¶

`reset(self)`¶

`reset_state(self)`¶

`send_midi(self, message)`¶

`send_value(self, column, row, value, force=False)`¶

`set_channel(self, channel)`¶

`set_control_element(self, control, grabbed)`¶

`set_light(self, column, row, value)`¶

`unregister_control_element(self, element)`¶

`unregister_control_elements(self, *elements)`¶

`unregister_disconnectable(self, slot)`¶

`unrequest_listen_nested_control_elements(self)`¶

`value_has_listener(self, slot)`¶

Called when the control element receives a MIDI value from the hardware

`value_listener_count(self)`¶

Called when the control element receives a MIDI value from the hardware

`width(self)`¶

Attributes¶

_CompoundElement__on_nested_control_element_value = None
_has_resource = False - bool(x) -> bool
_has_task_group = False - bool(x) -> bool
_is_resource_based = False - bool(x) -> bool
_resource = <ableton.v2.base.util.lazy_attribute object at 0x11b312780>
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x1630c8898>
canonical_parent = None
name = '' - str(object='') -> str
optimized_send_midi = True - bool(x) -> bool
proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>

class `EncoderElement(InputControlElement)`¶

Properties¶

_last_sent_value
is_feedback_enabled
mapping_sensitivity
resource
script_forwarding
send_depends_on_forwarding
suppress_script_forwarding

Methods¶

`ProxiedInterface(outer=None, *a, **k)`¶

`init(self, msg_type, channel, identifier, map_mode, encoder_sensitivity=None, *a, **k)`¶

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

`_do_send_value(self, value, channel=None)`¶

`_mapping_feedback_values(self)`¶

`_on_resource_lost(self, client)`¶

`_on_resource_received(self, client, *a, **k)`¶

`_report_value(self, value, is_input)`¶

`_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)`¶

`_send_delayed_messages(self)`¶

`_status_byte(self, channel)`¶

`_verify_value(self, value)`¶

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

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

`begin_gesture(self)`¶

`clear_send_cache(self)`¶

`connect_to(self, parameter)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`end_gesture(self)`¶

`find_disconnectable(self, predicate)`¶

`force_next_send(self)`¶

`has_disconnectable(self, slot)`¶

`identifier_bytes(self)`¶

`install_connections(self, install_translation, install_mapping, install_forwarding)`¶

`mapped_parameter(self)`¶

`max_value(self)`¶

`message_channel(self)`¶

`message_identifier(self)`¶

`message_map_mode(self)`¶

`message_sysex_identifier(self)`¶

`message_type(self)`¶

`needs_takeover(self)`¶

`normalize_value(self, value)`¶

`normalized_value_has_listener(self, slot)`¶

`normalized_value_listener_count(self)`¶

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

`notify_ownership_change(self, client, grabbed, element_ownership_handler=None)`¶

`notify_value(self, value)`¶

`original_channel(self)`¶

`original_identifier(self)`¶

`receive_chunk(self, chunk)`¶

`receive_value(self, value)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`relative_value_to_delta(self, value)`¶

`release_parameter(self)`¶

`remove_normalized_value_listener(self, slot)`¶

`remove_value_listener(self, slot)`¶

`reset(self)`¶

`reset_state(self)`¶

`script_wants_forwarding(self)`¶

`send_midi(self, message)`¶

`send_value(self, value, force=False, channel=None)`¶

`set_channel(self, channel)`¶

`set_feedback_delay(self, delay)`¶

`set_identifier(self, identifier)`¶

`set_needs_takeover(self, needs_takeover)`¶

`set_report_values(self, report_input, report_output)`¶

`unregister_disconnectable(self, slot)`¶

`use_default_message(self)`¶

`value_has_listener(self, slot)`¶

`value_listener_count(self)`¶

Attributes¶

_has_resource = False - bool(x) -> bool
_has_task_group = False - bool(x) -> bool
_input_signal_listener_count = 0 - int([x]) -> integer
_resource = <ableton.v2.base.util.lazy_attribute object at 0x11b312780>
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x1630c8898>
allow_receiving_chunks = True - bool(x) -> bool
canonical_parent = None
encoder_sensitivity = 1.0 - Convert a string or number to a floating point number, if possible.
name = '' - str(object='') -> str
num_delayed_messages = 1 - int([x]) -> integer
optimized_send_midi = True - bool(x) -> bool
proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>

class `MidiMap(dict)`¶

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Methods¶

`init(self, /, *args, **kwargs)`¶

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

`add_button(self, name, channel, number, midi_message_type)`¶

`add_matrix(self, name, element_factory, channel, numbers, midi_message_type)`¶

`clear(...)`¶

D.clear() -> None. Remove all items from D.

`copy(...)`¶

D.copy() -> a shallow copy of D

`fromkeys(iterable, value=None, /)`¶

Create a new dictionary with keys from iterable and values set to value.

`get(self, key, default=None, /)`¶

Return the value for key if key is in the dictionary, else default.

`items(...)`¶

D.items() -> a set-like object providing a view on D's items

`keys(...)`¶

D.keys() -> a set-like object providing a view on D's keys

`pop(...)`¶

D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

`popitem(...)`¶

D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

`setdefault(self, key, default=None, /)`¶

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

`update(...)`¶

D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

`values(...)`¶

D.values() -> an object providing a view on D's values

class `SliderElement(EncoderElement)`¶

Properties¶

_last_sent_value
is_feedback_enabled
mapping_sensitivity
resource
script_forwarding
send_depends_on_forwarding
suppress_script_forwarding

Methods¶

`ProxiedInterface(outer=None, *a, **k)`¶

`init(self, msg_type, channel, identifier, *a, **k)`¶

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

`_do_send_value(self, value, channel=None)`¶

`_mapping_feedback_values(self)`¶

`_on_resource_lost(self, client)`¶

`_on_resource_received(self, client, *a, **k)`¶

`_report_value(self, value, is_input)`¶

`_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)`¶

`_send_delayed_messages(self)`¶

`_status_byte(self, channel)`¶

`_verify_value(self, value)`¶

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

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

`begin_gesture(self)`¶

`clear_send_cache(self)`¶

`connect_to(self, parameter)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`end_gesture(self)`¶

`find_disconnectable(self, predicate)`¶

`force_next_send(self)`¶

`has_disconnectable(self, slot)`¶

`identifier_bytes(self)`¶

`install_connections(self, install_translation, install_mapping, install_forwarding)`¶

`mapped_parameter(self)`¶

`max_value(self)`¶

`message_channel(self)`¶

`message_identifier(self)`¶

`message_map_mode(self)`¶

`message_sysex_identifier(self)`¶

`message_type(self)`¶

`needs_takeover(self)`¶

`normalize_value(self, value)`¶

`normalized_value_has_listener(self, slot)`¶

`normalized_value_listener_count(self)`¶

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

`notify_ownership_change(self, client, grabbed, element_ownership_handler=None)`¶

`notify_value(self, value)`¶

`original_channel(self)`¶

`original_identifier(self)`¶

`receive_chunk(self, chunk)`¶

`receive_value(self, value)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`relative_value_to_delta(self, value)`¶

`release_parameter(self)`¶

`remove_normalized_value_listener(self, slot)`¶

`remove_value_listener(self, slot)`¶

`reset(self)`¶

`reset_state(self)`¶

`script_wants_forwarding(self)`¶

`send_midi(self, message)`¶

`send_value(self, value, force=False, channel=None)`¶

`set_channel(self, channel)`¶

`set_feedback_delay(self, delay)`¶

`set_identifier(self, identifier)`¶

`set_needs_takeover(self, needs_takeover)`¶

`set_report_values(self, report_input, report_output)`¶

`unregister_disconnectable(self, slot)`¶

`use_default_message(self)`¶

`value_has_listener(self, slot)`¶

`value_listener_count(self)`¶

Attributes¶

_has_resource = False - bool(x) -> bool
_has_task_group = False - bool(x) -> bool
_input_signal_listener_count = 0 - int([x]) -> integer
_resource = <ableton.v2.base.util.lazy_attribute object at 0x11b312780>
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x1630c8898>
allow_receiving_chunks = True - bool(x) -> bool
canonical_parent = None
encoder_sensitivity = 1.0 - Convert a string or number to a floating point number, if possible.
name = '' - str(object='') -> str
num_delayed_messages = 1 - int([x]) -> integer
optimized_send_midi = True - bool(x) -> bool
proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>

ableton.v2.control_surface.midi_map (runtime)¶

Functions¶

make_button(name, channel, number, midi_message_type)¶

make_encoder(name, channel, number, midi_message_type)¶

make_slider(name, channel, number, midi_message_type)¶

Classes¶

class ButtonElement(InputControlElement, ButtonElementMixin)¶

Properties¶

Methods¶

Colors()¶

ProxiedInterface(outer=None, *a, **k)¶

__init__(self, is_momentary, msg_type, channel, identifier, is_rgb=False, skin=<ableton.v2.control_surface.skin.Skin object at 0x16311f550>, undo_step_handler=<ableton.v2.control_surface.elements.button.DummyUndoStepHandler object at 0x16311f940>, send_should_depend_on_forwarding=False, *a, **k)¶

_disconnect_color_listener(self)¶

_do_draw(self, color)¶

_do_send_value(self, value, channel=None)¶

_mapping_feedback_values(self)¶

_on_resource_lost(self, client)¶

_on_resource_received(self, client, *a, **k)¶

_report_value(self, value, is_input)¶

_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)¶

_send_delayed_messages(self)¶

_set_skin_light(self, value)¶

_status_byte(self, channel)¶

_verify_value(self, value)¶

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

begin_gesture(self)¶

clear_send_cache(self)¶

connect_to(self, parameter)¶

disconnect(self)¶

disconnect_disconnectable(self, slot)¶

end_gesture(self)¶

find_disconnectable(self, predicate)¶

force_next_send(self)¶

has_disconnectable(self, slot)¶

identifier_bytes(self)¶

install_connections(self, install_translation, install_mapping, install_forwarding)¶

is_momentary(self)¶

is_pressed(self)¶

mapped_parameter(self)¶

max_value(self)¶

message_channel(self)¶

message_identifier(self)¶

message_map_mode(self)¶

message_sysex_identifier(self)¶

message_type(self)¶

needs_takeover(self)¶

notify_ownership_change(self, client, grabbed, element_ownership_handler=None)¶

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

original_channel(self)¶

original_identifier(self)¶

receive_chunk(self, chunk)¶

receive_value(self, value)¶

register_disconnectable(self, slot)¶

register_disconnectables(self, disconnectables)¶

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

release_parameter(self)¶

remove_value_listener(self, slot)¶

reset(self)¶

reset_state(self)¶

script_wants_forwarding(self)¶

send_midi(self, message)¶

send_value(self, value, force=False, channel=None)¶

set_channel(self, channel)¶

set_feedback_delay(self, delay)¶

set_identifier(self, identifier)¶

set_light(self, value)¶

set_needs_takeover(self, needs_takeover)¶

set_report_values(self, report_input, report_output)¶

unregister_disconnectable(self, slot)¶

use_default_message(self)¶

value_has_listener(self, slot)¶

value_listener_count(self)¶

Attributes¶

class ButtonMatrixElement(CompoundElement)¶

Properties¶

Methods¶

ProxiedInterface(outer=None, *a, **k)¶

__init__(self, rows=[], *a, **k)¶

_connect_nested_control_elements(self)¶

_disconnect_nested_control_elements(self)¶

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

`make_button(name, channel, number, midi_message_type)`¶

`make_encoder(name, channel, number, midi_message_type)`¶

`make_slider(name, channel, number, midi_message_type)`¶

class `ButtonElement(InputControlElement, ButtonElementMixin)`¶

`Colors()`¶

`ProxiedInterface(outer=None, *a, **k)`¶

`init(self, is_momentary, msg_type, channel, identifier, is_rgb=False, skin=<ableton.v2.control_surface.skin.Skin object at 0x16311f550>, undo_step_handler=<ableton.v2.control_surface.elements.button.DummyUndoStepHandler object at 0x16311f940>, send_should_depend_on_forwarding=False, *a, **k)`¶

`_disconnect_color_listener(self)`¶

`_do_draw(self, color)`¶

`_do_send_value(self, value, channel=None)`¶

`_mapping_feedback_values(self)`¶

`_on_resource_lost(self, client)`¶

`_on_resource_received(self, client, *a, **k)`¶

`_report_value(self, value, is_input)`¶

`_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)`¶

`_send_delayed_messages(self)`¶

`_set_skin_light(self, value)`¶

`_status_byte(self, channel)`¶

`_verify_value(self, value)`¶

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

`begin_gesture(self)`¶

`clear_send_cache(self)`¶

`connect_to(self, parameter)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`end_gesture(self)`¶

`find_disconnectable(self, predicate)`¶

`force_next_send(self)`¶

`has_disconnectable(self, slot)`¶

`identifier_bytes(self)`¶

`install_connections(self, install_translation, install_mapping, install_forwarding)`¶

`is_momentary(self)`¶

`is_pressed(self)`¶

`mapped_parameter(self)`¶

`max_value(self)`¶

`message_channel(self)`¶

`message_identifier(self)`¶

`message_map_mode(self)`¶

`message_sysex_identifier(self)`¶

`message_type(self)`¶

`needs_takeover(self)`¶

`notify_ownership_change(self, client, grabbed, element_ownership_handler=None)`¶

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

`original_channel(self)`¶

`original_identifier(self)`¶

`receive_chunk(self, chunk)`¶

`receive_value(self, value)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`release_parameter(self)`¶

`remove_value_listener(self, slot)`¶

`reset(self)`¶

`reset_state(self)`¶

`script_wants_forwarding(self)`¶

`send_midi(self, message)`¶

`send_value(self, value, force=False, channel=None)`¶

`set_channel(self, channel)`¶

`set_feedback_delay(self, delay)`¶

`set_identifier(self, identifier)`¶

`set_light(self, value)`¶

`set_needs_takeover(self, needs_takeover)`¶

`set_report_values(self, report_input, report_output)`¶

`unregister_disconnectable(self, slot)`¶

`use_default_message(self)`¶

`value_has_listener(self, slot)`¶

`value_listener_count(self)`¶

class `ButtonMatrixElement(CompoundElement)`¶

`ProxiedInterface(outer=None, *a, **k)`¶

`init(self, rows=[], *a, **k)`¶

`_connect_nested_control_elements(self)`¶

`_disconnect_nested_control_elements(self)`¶

`_do_get_item(self, index)`¶

`_get_nested_client(self, client)`¶

`_grab_nested_control_elements(self, client, priority=None, **k)`¶

`_on_nested_control_element_lost(self, control)`¶

`_on_nested_control_element_received(self, control)`¶

`_on_resource_lost(self, client)`¶

`_on_resource_received(self, client, *a, **k)`¶