`ableton.v3.control_surface.elements_base` (runtime)¶

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

Functions¶

`chunks(lst, chunk_size)`¶

`create_button(identifier, name, **k)`¶

`create_combo_element(control=None, modifier=None, name=None, is_private=True)`¶

`create_encoder(identifier, name, **k)`¶

`create_matrix_identifiers(start, stop, width=1, flip_rows=False)`¶

`create_name_for_modified_control(control=None, modifier=None)`¶

`create_sysex_element(identifier, name, send_message_generator=None, is_private=True, **k)`¶

`create_sysex_sending_button(identifier, name, sysex_identifier, **k)`¶

`flatten(list)`¶

`is_iterable(value)`¶

`recursive_map(fn, element, sequence_type=None)`¶

Classes¶

class `ButtonElement(ButtonElement, Renderable)`¶

Properties¶

_last_sent_value
is_feedback_enabled
is_momentary
is_pressed
mapping_sensitivity
resource
script_forwarding
send_depends_on_forwarding
suppress_script_forwarding

Methods¶

`Colors()`¶

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

`init(self, identifier, channel=0, msg_type=1, is_momentary=True, led_channel=None, *a, **k)`¶

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

`_create_event_handler(self, property_name)`¶

`_disconnect_color_listener(self)`¶

`_do_draw(self, color)`¶

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

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`_mapping_feedback_values(self)`¶

`_on_resource_lost(self, client)`¶

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

`_report_value(self, value, is_input)`¶

`_request_rebuild_and_release(self)`¶

`_resource(self)`¶

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

`_tasks(self, parent_task_group=None)`¶

`_verify_value(self, value)`¶

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

`control_base_type(extra_args=None, extra_kws=None, *a, **k)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`dispatch_event(self, name: 'str', value)`¶

`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_pressed_has_listener(self, slot)`¶

`is_pressed_listener_count(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(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')`¶

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

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

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

`original_channel(self)`¶

`original_identifier(self)`¶

`proxied_interface(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_is_pressed_listener(self, slot)`¶

`remove_value_listener(self, slot)`¶

`renderable_state(self)`¶

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

`suppress_notifications(self)`¶

`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
allow_receiving_chunks = False - bool(x) -> bool
canonical_parent = None
include_in_top_level_state = True - bool(x) -> bool
name = '' - str(object='') -> str
num_delayed_messages = 2 - int([x]) -> integer
optimized_send_midi = True - bool(x) -> bool

class `ButtonMatrixElement(ButtonMatrixElement, Renderable)`¶

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

`_create_event_handler(self, property_name)`¶

`_disconnect_nested_control_elements(self)`¶

`_do_get_item(self, index)`¶

`_get_nested_client(self, client)`¶

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

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

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

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

`_tasks(self, parent_task_group=None)`¶

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

`control_base_type(extra_args=None, extra_kws=None, *a, **k)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`dispatch_event(self, name: 'str', value)`¶

`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(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')`¶

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

`proxied_interface(self)`¶

`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

`renderable_state(self)`¶

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

`suppress_notifications(self)`¶

`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
canonical_parent = None
include_in_top_level_state = True - bool(x) -> bool
name = '' - str(object='') -> str
optimized_send_midi = True - bool(x) -> bool

class `ComboElement(WrapperElement)`¶

Properties¶

proxied_object
resource
wrapped_control

Methods¶

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

`init(self, control=None, modifier=[], *a, **k)`¶

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

`_combo_is_on(self)`¶

`_connect_nested_control_elements(self)`¶

`_disconnect_nested_control_elements(self)`¶

`_enforce_control_invariant(self)`¶

`_get_nested_client(self, client)`¶

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

`_is_initialized(self)`¶

`_modifier_is_valid(self, mod)`¶

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

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

`_tasks(self, parent_task_group=None)`¶

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

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

`clear_send_cache(self)`¶

`connect_to(self, parameter)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`find_disconnectable(self, predicate)`¶

`get_control_element_priority(self, element, priority)`¶

`has_control_element(self, control)`¶

`has_disconnectable(self, slot)`¶

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

`owned_control_elements(self)`¶

`owns_control_element(self, control)`¶

`proxied_interface(self)`¶

`proxy_old_hasattr(self, attr)`¶

`register_control_element(self, element)`¶

`register_control_elements(self, *elements)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`register_wrapped(self)`¶

`release_parameter(self)`¶

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

`set_control_element(self, control, grabbed)`¶

`unregister_control_element(self, element)`¶

`unregister_control_elements(self, *elements)`¶

`unregister_disconnectable(self, slot)`¶

`unregister_wrapped(self)`¶

`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

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
_skip_wrapper_lookup = None
canonical_parent = None
name = '' - str(object='') -> str
optimized_send_midi = True - bool(x) -> bool
priority_increment = 0.5 - Convert a string or number to a floating point number, if possible.

class `ControlElement(Disconnectable)`¶

Properties¶

resource

Methods¶

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

`init(self, name='', is_private=False, resource_type=None, optimized_send_midi=None, send_midi=None, register_control=None, *a, **k)`¶

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

`_on_resource_lost(self, client)`¶

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

`_resource(self)`¶

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

`_tasks(self, parent_task_group=None)`¶

`clear_send_cache(self)`¶

`disconnect(self)`¶

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

`proxied_interface(self)`¶

`reset(self)`¶

`reset_state(self)`¶

`send_midi(self, message)`¶

Attributes¶

_has_resource = False - bool(x) -> bool
_has_task_group = False - bool(x) -> bool
canonical_parent = None
name = '' - str(object='') -> str
optimized_send_midi = True - bool(x) -> bool

class `DisplayLineElement(NotifyingControlElement, Generic)`¶

Properties¶

grabbed
resource

Methods¶

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

`init(self, display_fn: Callable[[~DisplayDataType], Any], formatting_fn: Callable[[ableton.v3.control_surface.display.text.Text], ~DisplayDataType] = <function DisplayLineElement.<lambda> at 0x13c682840>, default_formatting='', *a, **k)`¶

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

`_apply_default_formatting(self, text: ableton.v3.control_surface.display.text.Text)`¶

`_do_display(self, message: Union[ableton.v3.control_surface.display.text.Text, str])`¶

`_on_resource_lost(self, client)`¶

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

`_redisplay_last_native_content(self)`¶

`_resource(self)`¶

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

`_tasks(self, parent_task_group=None)`¶

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

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

`clear_send_cache(self)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`display_message(self, text)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`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

`proxied_interface(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`remove_value_listener(self, slot)`¶

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

`reset(self)`¶

`reset_state(self)`¶

`send_midi(self, message)`¶

`unregister_disconnectable(self, slot)`¶

`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

Attributes¶

_has_resource = False - bool(x) -> bool
_has_task_group = False - bool(x) -> bool
_is_protocol = False - bool(x) -> bool
canonical_parent = None
name = '' - str(object='') -> str
optimized_send_midi = True - bool(x) -> bool

class `ElementsBase`¶

Methods¶

`init(self, global_channel=0, *a, **k)`¶

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

`_add_modified_matrix(self, matrix, modifier, name, element_factory, is_private)`¶

`_add_raw_elements(self, base_name, elements)`¶

`_create_attribute_name(self, name)`¶

`add_button(self, identifier, name, **k)`¶

`add_button_matrix(self, identifiers, base_name, channels=None, *a, **k)`¶

`add_element(self, name, element_factory, *a, **k)`¶

`add_encoder(self, identifier, name, **k)`¶

`add_encoder_matrix(self, identifiers, base_name, channels=None, *a, **k)`¶

`add_matrix(self, identifiers, base_name, channels=None, element_factory=None, name_factory=None, is_private=False, **k)`¶

`add_modified_control(self, control=None, modifier=None, name=None, element_factory=<function create_combo_element at 0x13c9c6e80>, is_private=True)`¶

`add_modifier_button(self, identifier, name, *a, **k)`¶

`add_submatrix(self, matrix, name, columns=None, rows=None, is_private=True)`¶

`add_sysex_display_line(self, identifier, name, send_message_generator=None, default_formatting=None, formatting_fn=None, **k)`¶

`add_sysex_element(self, identifier, name, send_message_generator=None, **k)`¶

class `EncoderElement(EncoderElement, Renderable)`¶

Properties¶

_last_sent_value
is_feedback_enabled
mapping_sensitivity
parameter
parameter_name
parameter_value
resource
script_forwarding
send_depends_on_forwarding
suppress_script_forwarding

Methods¶

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

`init(self, identifier, channel=0, msg_type=1, map_mode=MidiMap.MapMode.absolute, mapping_sensitivity=1.0, sensitivity_modifier=None, needs_takeover=True, is_feedback_enabled=False, feedback_delay=0, *a, **k)`¶

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

`_clear_parameter_listeners(self)`¶

`_create_event_handler(self, property_name)`¶

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

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`_mapping_feedback_values(self)`¶

`_on_resource_lost(self, client)`¶

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

`_parameter_value_changed(self)`¶

`_report_value(self, value, is_input)`¶

`_resource(self)`¶

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

`_send_delayed_messages(self)`¶

`_set_sensitivity(self, use_fine_grain)`¶

`_status_byte(self, channel)`¶

`_tasks(self, parent_task_group=None)`¶

`_unblock_internal_parameter_feedback(self)`¶

`_unblock_internal_parameter_feedback_task(self)`¶

`_update_parameter_listeners(self)`¶

`_verify_value(self, value)`¶

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

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

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

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

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

`control_base_type(extra_args=None, extra_kws=None, *a, **k)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`dispatch_event(self, name: 'str', value)`¶

`end_gesture(self)`¶

`find_disconnectable(self, predicate)`¶

`force_next_send(self)`¶

`has_disconnectable(self, slot)`¶

`identifier_bytes(self)`¶

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

`is_mapped_manually(self)`¶

`is_mapped_to_parameter(self)`¶

`mapped_object_has_listener(self, slot)`¶

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

`normalize_value(self, value)`¶

`normalized_value_has_listener(self, slot)`¶

`normalized_value_listener_count(self)`¶

`notify(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')`¶

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

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

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

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

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

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

`notify_value(self, value)`¶

`original_channel(self)`¶

`original_identifier(self)`¶

`parameter_has_listener(self, slot)`¶

`parameter_listener_count(self)`¶

`parameter_name_has_listener(self, slot)`¶

`parameter_name_listener_count(self)`¶

`parameter_value_has_listener(self, slot)`¶

`parameter_value_listener_count(self)`¶

`proxied_interface(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_mapped_object_listener(self, slot)`¶

`remove_normalized_value_listener(self, slot)`¶

`remove_parameter_listener(self, slot)`¶

`remove_parameter_name_listener(self, slot)`¶

`remove_parameter_value_listener(self, slot)`¶

`remove_value_listener(self, slot)`¶

`renderable_state(self)`¶

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

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`use_default_message(self)`¶

`value_has_listener(self, slot)`¶

`value_listener_count(self)`¶

Attributes¶

_EncoderElement__on_parameter_name_changed = None
_EncoderElement__on_parameter_value_changed = None
_EncoderElement__on_sensitivity_modifier_value = None
_has_resource = False - bool(x) -> bool
_has_task_group = False - bool(x) -> bool
_input_signal_listener_count = 0 - int([x]) -> integer
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.
include_in_top_level_state = True - bool(x) -> bool
mapped_object = None
name = '' - str(object='') -> str
num_delayed_messages = 1 - int([x]) -> integer
optimized_send_midi = True - bool(x) -> bool

class `MapMode`¶

Methods¶

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

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

Attributes¶

Absolute = MidiMap.MapMode.absolute
Absolute14Bit = MidiMap.MapMode.absolute_14_bit
AccelBinaryOffset = MidiMap.MapMode.relative_binary_offset
AccelSignedBit = MidiMap.MapMode.relative_signed_bit
AccelSignedBit2 = MidiMap.MapMode.relative_signed_bit2
AccelTwoCompliment = MidiMap.MapMode.relative_two_compliment
LinearBinaryOffset = MidiMap.MapMode.relative_smooth_binary_offset
LinearSignedBit = MidiMap.MapMode.relative_smooth_signed_bit
LinearSignedBit2 = MidiMap.MapMode.relative_smooth_signed_bit2
LinearTwoCompliment = MidiMap.MapMode.relative_smooth_two_compliment

class `PrioritizedResource(StackingResource)`¶

Properties¶

clients
max_priority
owner
owners
stack_size

Methods¶

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

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

`_actual_owners(self)`¶

`_add_client(self, client, priority)`¶

`_on_lost_set(self, clients)`¶

`_on_received_set(self, clients)`¶

`_remove_client(self, client)`¶

`get_owner(self)`¶

`grab(self, client, priority=None)`¶

`on_lost(self, client)`¶

`on_received(self, client)`¶

`release(self, client)`¶

`release_all(self)`¶

`release_stacked(self)`¶

class `SysexElement(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, send_message_generator=None, enquire_message=None, default_value=None, optimized=False, use_first_byte_as_value=False, *a, **k)`¶

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

`_do_send_value(self, message)`¶

`_mapping_feedback_values(self)`¶

`_on_resource_lost(self, client)`¶

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

`_report_value(self, value, is_input)`¶

`_resource(self)`¶

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

`_send_delayed_messages(self)`¶

`_status_byte(self, channel)`¶

`_tasks(self, parent_task_group=None)`¶

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

`deferring_send(self)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`end_gesture(self)`¶

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

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

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

`original_channel(self)`¶

`original_identifier(self)`¶

`proxied_interface(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, *a, **k)`¶

`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
allow_receiving_chunks = False - bool(x) -> bool
canonical_parent = None
name = '' - str(object='') -> str
num_delayed_messages = 1 - int([x]) -> integer
optimized_send_midi = True - bool(x) -> bool

class `SysexSendingButtonElement(ButtonElement)`¶

Properties¶

_last_sent_value
is_feedback_enabled
is_momentary
is_pressed
mapping_sensitivity
resource
script_forwarding
send_depends_on_forwarding
suppress_script_forwarding

Methods¶

`Colors()`¶

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

`init(self, identifier, sysex_identifier, optimized=True, tail=(247,), *a, **k)`¶

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

`_create_event_handler(self, property_name)`¶

`_disconnect_color_listener(self)`¶

`_do_draw(self, color)`¶

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

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`_mapping_feedback_values(self)`¶

`_on_resource_lost(self, client)`¶

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

`_report_value(self, value, is_input)`¶

`_request_rebuild_and_release(self)`¶

`_resource(self)`¶

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

`_tasks(self, parent_task_group=None)`¶

`_verify_value(self, value)`¶

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

`control_base_type(extra_args=None, extra_kws=None, *a, **k)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`dispatch_event(self, name: 'str', value)`¶

`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_pressed_has_listener(self, slot)`¶

`is_pressed_listener_count(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(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')`¶

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

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

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

`original_channel(self)`¶

`original_identifier(self)`¶

`proxied_interface(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_is_pressed_listener(self, slot)`¶

`remove_value_listener(self, slot)`¶

`renderable_state(self)`¶

`reset(self)`¶

`reset_state(self)`¶

`script_wants_forwarding(self)`¶

`send_midi(self, message)`¶

`send_value(self, *value, **_)`¶

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

`suppress_notifications(self)`¶

`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
allow_receiving_chunks = False - bool(x) -> bool
canonical_parent = None
include_in_top_level_state = True - bool(x) -> bool
name = '' - str(object='') -> str
num_delayed_messages = 2 - int([x]) -> integer
optimized_send_midi = True - bool(x) -> bool

class `partial`¶

partial(func, args, *keywords) - new function with partial application of the given arguments and keywords.

Methods¶

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

Call self as a function.

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

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

Attributes¶

args = <member 'args' of 'functools.partial' objects> - tuple of arguments to future partial calls
func = <member 'func' of 'functools.partial' objects> - function object to use in future partial calls
keywords = <member 'keywords' of 'functools.partial' objects> - dictionary of keyword arguments to future partial calls

ableton.v3.control_surface.elements_base (runtime)¶

Functions¶

chunks(lst, chunk_size)¶

create_button(identifier, name, **k)¶

create_combo_element(control=None, modifier=None, name=None, is_private=True)¶

create_encoder(identifier, name, **k)¶

create_matrix_identifiers(start, stop, width=1, flip_rows=False)¶

create_name_for_modified_control(control=None, modifier=None)¶

create_sysex_element(identifier, name, send_message_generator=None, is_private=True, **k)¶

create_sysex_sending_button(identifier, name, sysex_identifier, **k)¶

flatten(list)¶

is_iterable(value)¶

recursive_map(fn, element, sequence_type=None)¶

Classes¶

class ButtonElement(ButtonElement, Renderable)¶

Properties¶

Methods¶

Colors()¶

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

__init__(self, identifier, channel=0, msg_type=1, is_momentary=True, led_channel=None, *a, **k)¶

_create_event_handler(self, property_name)¶

_disconnect_color_listener(self)¶

_do_draw(self, color)¶

_do_send_value(self, value, channel=None)¶

_init_state_from_controls(self, renderable_state)¶

_init_state_from_listenable_properties(self, renderable_state)¶

_mapping_feedback_values(self)¶

_on_resource_lost(self, client)¶

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

_report_value(self, value, is_input)¶

_request_rebuild_and_release(self)¶

_resource(self)¶

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

_tasks(self, parent_task_group=None)¶

_verify_value(self, value)¶

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

control_base_type(extra_args=None, extra_kws=None, *a, **k)¶

disconnect(self)¶

disconnect_disconnectable(self, slot)¶

dispatch_event(self, name: 'str', value)¶

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_pressed_has_listener(self, slot)¶

is_pressed_listener_count(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(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')¶

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

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

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

original_channel(self)¶

original_identifier(self)¶

proxied_interface(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_is_pressed_listener(self, slot)¶

remove_value_listener(self, slot)¶

renderable_state(self)¶

reset(self)¶

`ableton.v3.control_surface.elements_base` (runtime)¶

`chunks(lst, chunk_size)`¶

`create_button(identifier, name, **k)`¶

`create_combo_element(control=None, modifier=None, name=None, is_private=True)`¶

`create_encoder(identifier, name, **k)`¶

`create_matrix_identifiers(start, stop, width=1, flip_rows=False)`¶

`create_name_for_modified_control(control=None, modifier=None)`¶

`create_sysex_element(identifier, name, send_message_generator=None, is_private=True, **k)`¶

`create_sysex_sending_button(identifier, name, sysex_identifier, **k)`¶

`flatten(list)`¶

`is_iterable(value)`¶

`recursive_map(fn, element, sequence_type=None)`¶

class `ButtonElement(ButtonElement, Renderable)`¶

`Colors()`¶

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

`init(self, identifier, channel=0, msg_type=1, is_momentary=True, led_channel=None, *a, **k)`¶

`_create_event_handler(self, property_name)`¶

`_disconnect_color_listener(self)`¶

`_do_draw(self, color)`¶

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

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`_mapping_feedback_values(self)`¶

`_on_resource_lost(self, client)`¶

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

`_report_value(self, value, is_input)`¶

`_request_rebuild_and_release(self)`¶

`_resource(self)`¶

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

`_tasks(self, parent_task_group=None)`¶

`_verify_value(self, value)`¶

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

`control_base_type(extra_args=None, extra_kws=None, *a, **k)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`dispatch_event(self, name: 'str', value)`¶

`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_pressed_has_listener(self, slot)`¶

`is_pressed_listener_count(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(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')`¶

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

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

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

`original_channel(self)`¶

`original_identifier(self)`¶

`proxied_interface(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_is_pressed_listener(self, slot)`¶

`remove_value_listener(self, slot)`¶

`renderable_state(self)`¶

`reset(self)`¶

`reset_state(self)`¶

`script_wants_forwarding(self)`¶

`send_midi(self, message)`¶

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