Skip to content

ableton.v3.control_surface.elements (runtime)

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

Functions

adjust_string(original, length)

create_rgb_color(values)

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_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_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)
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)
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
  • _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
  • 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
  • proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>
  • renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

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_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)
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)
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)
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
  • _resource = <ableton.v2.base.util.lazy_attribute object at 0x11b312780>
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x1630c8898>
  • canonical_parent = None
  • include_in_top_level_state = True - bool(x) -> bool
  • name = '' - str(object='') -> str
  • optimized_send_midi = True - bool(x) -> bool
  • proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>
  • renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639e9710>

class CachingSendMessageGenerator

Methods

__call__(self, *a, **k)

Call self as a function.

__init__(self, generator)

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

_update_cached_values_from_kwargs(self, kwargs)

Attributes

  • _cached_argument_values = <ableton.v2.base.util.lazy_attribute object at 0x163a2a0f0>

class Color(ABC)

Properties

  • midi_value

Methods

__init__(self, /, *args, **kwargs)

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

draw(self, interface)

Attributes

  • _abc_impl = <_abc_data object at 0x1639e2690>

class ColorPart(tuple)

ColorPart(value, channel)

Properties

  • channel - Alias for field number 1
  • value - Alias for field number 0

Methods

__init__(self, /, *args, **kwargs)

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

_asdict(self)
_make(iterable)

Make a new ColorPart object from a sequence or iterable

_replace(_self, **kwds)

Return a new ColorPart object replacing specified fields with new values

count(self, value, /)

Return number of occurrences of value.

index(self, value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.

Attributes

  • _field_defaults = {'channel': None} - dict() -> new empty dictionary
  • _field_types = OrderedDict([('value', <class 'int'>), ('channel', typing.Union[int, NoneType])]) - Dictionary that remembers insertion order
  • _fields = ('value', 'channel') - Built-in immutable sequence.
  • _fields_defaults = {} - dict() -> new empty dictionary

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_type(on_received_callback=None, on_lost_callback=None, *a, **k)
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)
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
  • _resource = <ableton.v2.base.util.lazy_attribute object at 0x11b312780>
  • _skip_wrapper_lookup = None
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x1630c8898>
  • 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.
  • proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>

class ComplexColor(Color)

Properties

  • midi_value

Methods

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

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

draw(self, interface)

Attributes

  • _abc_impl = <_abc_data object at 0x1639e27b0>

class DiscreteValuesElement(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, identifier, channel=0, msg_type=1, values=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_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)
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_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 = 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
  • proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>

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 0x1639f2f28>, 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_type(on_received_callback=None, on_lost_callback=None, *a, **k)
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

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
  • _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(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_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)
_unblock_internal_parameter_feedback(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)
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)
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
  • _resource = <ableton.v2.base.util.lazy_attribute object at 0x11b312780>
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x1630c8898>
  • _unblock_internal_parameter_feedback_task = <ableton.v2.base.util.lazy_attribute object at 0x163a17b38>
  • 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
  • proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>
  • renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

class FallbackColor(Color)

Properties

  • midi_value

Methods

__init__(self, rgb_color, fallback_color, *a, **k)

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

draw(self, interface)

Attributes

  • _abc_impl = <_abc_data object at 0x1639e28d0>

class LockableButtonElement(LockableButtonElementMixin, 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, double_click_time=0.5, *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_press(self)
_on_release(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_type(on_received_callback=None, on_lost_callback=None, *a, **k)
_send_delayed_messages(self)
_set_is_locked(self, is_locked, do_notify=True)
_set_skin_light(self, value)
_status_byte(self, channel)
_verify_value(self, value)
add_is_locked_listener(self, slot, identify_sender=False, *a, **k)
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_locked_has_listener(self, slot)
is_locked_listener_count(self)
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_locked(self, *a, **k)
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)
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_locked_listener(self, slot)
remove_is_pressed_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_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
  • _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
  • include_in_top_level_state = True - bool(x) -> bool
  • is_locked = False - bool(x) -> bool
  • 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>
  • renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

class LockableButtonElementMixin(EventObject, Renderable)

Methods

__init__(self, double_click_time=0.5, *a, **k)

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

_create_event_handler(self, property_name)
_init_state_from_controls(self, renderable_state)
_init_state_from_listenable_properties(self, renderable_state)
_on_press(self)
_on_release(self)
_set_is_locked(self, is_locked, do_notify=True)
_set_skin_light(self, value)
add_is_locked_listener(self, slot, identify_sender=False, *a, **k)
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)
has_disconnectable(self, slot)
is_locked_has_listener(self, slot)
is_locked_listener_count(self)
notify(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')
notify_is_locked(self, *a, **k)
receive_value(self, value)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_is_locked_listener(self, slot)
reset(self)
suppress_notifications(self)
unregister_disconnectable(self, slot)

Attributes

  • include_in_top_level_state = True - bool(x) -> bool
  • is_locked = False - bool(x) -> bool
  • renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

class LockableComboElement(ComboElement)

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_type(on_received_callback=None, on_lost_callback=None, *a, **k)
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)
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
  • _resource = <ableton.v2.base.util.lazy_attribute object at 0x11b312780>
  • _skip_wrapper_lookup = None
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x1630c8898>
  • 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.
  • proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>

class NullFullVelocity

Methods

__init__(self, /, *args, **kwargs)

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

Attributes

  • enabled = False - bool(x) -> bool

class RgbColor(Color)

Properties

  • midi_value

Methods

__init__(self, *values, **k)

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

draw(self, interface)

Attributes

  • _abc_impl = <_abc_data object at 0x1639e2750>

class SimpleColor(Color)

Properties

  • midi_value

Methods

__init__(self, value, channel=None, *a, **k)

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

draw(self, interface)

Attributes

  • _abc_impl = <_abc_data object at 0x1639e26f0>

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_type(on_received_callback=None, on_lost_callback=None, *a, **k)
_send_delayed_messages(self)
_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)
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)
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
  • _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 = 1 - int([x]) -> integer
  • optimized_send_midi = True - bool(x) -> bool
  • proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>

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_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_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)
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)
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
  • _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
  • 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
  • proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>
  • renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

class TouchElement(ButtonElement)

Properties

  • _last_sent_value
  • controlled_parameter
  • 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, *a, encoder=None, **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_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_assignment_listener(self, slot, identify_sender=False, *a, **k)
add_controlled_parameter_listener(self, slot, identify_sender=False, *a, **k)
add_is_pressed_listener(self, slot, identify_sender=False, *a, **k)
add_value_listener(self, slot, identify_sender=False, *a, **k)
assignment_has_listener(self, slot)
assignment_listener_count(self)
begin_gesture(self)
clear_send_cache(self)
connect_to(self, parameter)
control_base_type(extra_args=None, extra_kws=None, *a, **k)
controlled_parameter_has_listener(self, slot)
controlled_parameter_listener_count(self)
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_assignment(self, *a, **k)
notify_controlled_parameter(self, *a, **k)
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)
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_assignment_listener(self, slot)
remove_controlled_parameter_listener(self, slot)
remove_is_pressed_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_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
  • _TouchElement__on_parameter_changed = None
  • _TouchElement__on_parameter_name_changed = None
  • _TouchElement__on_parameter_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
  • 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
  • proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>
  • renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>