Skip to content

ableton.v2.control_surface.elements.combo (runtime)

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

Module constants

  • DEFAULT_PRIORITY = 0
  • PY3 = True

Functions

GLOBAL_DOUBLE_PRESS_CONTEXT_PROVIDER(*a, **k)

const(value)

contextmanager(func)

depends(**dependencies)

find_if(predicate, seq)

get_element(obj, element_container=None)

is_iterable(value)

listens(event_path, *a, **k)

liveobj_valid(obj)

nop(*a, **k)

Classes

class ButtonElementMixin

Methods

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

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

set_light(self, value)

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 CompoundElement(NotifyingControlElement, ControlElementClient)

Properties

  • resource

Methods

ProxiedInterface(outer=None, *a, **k)
__init__(self, control_elements=None, *a, **k)

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

_connect_nested_control_elements(self)
_disconnect_nested_control_elements(self)
_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_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_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)
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)
set_control_element(self, control, grabbed)
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

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 DoublePressContext(EventObject)

Methods

__init__(self, *a, **k)

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

add_break_double_press_listener(self, slot, identify_sender=False, *a, **k)
break_double_press(self)
break_double_press_has_listener(self, slot)
break_double_press_listener_count(self)
breaking_double_press(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
notify_break_double_press(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_break_double_press_listener(self, slot)
unregister_disconnectable(self, slot)

class DoublePressElement(WrapperElement)

Properties

  • proxied_object
  • resource
  • wrapped_control

Methods

ProxiedInterface(outer=None, *a, **k)
__init__(self, wrapped_control=None, double_press_context=None, *a, **k)

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

_connect_nested_control_elements(self)
_disconnect_nested_control_elements(self)
_get_nested_client(self, client)
_grab_nested_control_elements(self, client, priority=None, **k)
_is_initialized(self)
_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_double_press_listener(self, slot, identify_sender=False, *a, **k)
add_single_press_listener(self, slot, identify_sender=False, *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)
double_press_has_listener(self, slot)
double_press_listener_count(self)
find_disconnectable(self, predicate)
finish_double_press(self)
finish_single_press(self)
get_control_element_priority(self, element, priority)
has_control_element(self, control)
has_disconnectable(self, slot)
nested_control_elements(self)
notify_double_press(self, *a, **k)
notify_ownership_change(self, client, grabbed, element_ownership_handler=None)
notify_single_press(self, *a, **k)
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_double_press_listener(self, slot)
remove_single_press_listener(self, slot)
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)
single_press_has_listener(self, slot)
single_press_listener_count(self)
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

  • DOUBLE_PRESS_MAX_DELAY = 0.3 - Convert a string or number to a floating point number, if possible.
  • _CompoundElement__on_nested_control_element_value = None
  • _DoublePressElement__on_break_double_press = 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
  • double_press = <ableton.v2.base.util.lazy_attribute object at 0x163150a58>
  • name = '' - str(object='') -> str
  • optimized_send_midi = True - bool(x) -> bool
  • proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>
  • single_press = <ableton.v2.base.util.lazy_attribute object at 0x11df1f7f0>

class EventElement(NotifyingControlElement, ProxyBase, ButtonElementMixin)

Properties

  • proxied_interface
  • proxied_object
  • resource

Methods

ProxiedInterface(outer=None, *a, **k)
__init__(self, subject=None, event_name=None, *a, **k)

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

_on_event(self, *a, **k)
_on_resource_lost(self, client)
_on_resource_received(self, client, *a, **k)
_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)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
is_momentary(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

proxy_old_hasattr(self, attr)
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)
send_value(self, *a, **k)
set_light(self, *a, **k)
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>
  • _skip_wrapper_lookup = None
  • _subject = None
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x1630c8898>
  • canonical_parent = None
  • event_value = 1 - int([x]) -> integer
  • name = '' - str(object='') -> str
  • optimized_send_midi = True - bool(x) -> bool

class EventObject(CompoundDisconnectable)

Methods

__init__(self, *a, **k)

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

disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
unregister_disconnectable(self, slot)

class MultiElement(CompoundElement, ButtonElementMixin)

Properties

  • resource

Methods

ProxiedInterface(outer=None, *a, **k)
__init__(self, *controls, **k)

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

_connect_nested_control_elements(self)
_disconnect_nested_control_elements(self)
_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_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_control_element_priority(self, element, priority)
has_control_element(self, control)
has_disconnectable(self, slot)
is_momentary(self)
is_pressed(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, control)
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, value)
set_control_element(self, control, grabbed)
set_light(self, 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

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 NotifyingControlElement(EventObject, ControlElement)

Properties

  • resource

Methods

ProxiedInterface(outer=None, *a, **k)
__init__(self, *a, **k)

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

_on_resource_lost(self, client)
_on_resource_received(self, client, *a, **k)
_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)
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 ParameterSlot(Disconnectable)

Properties

  • control
  • parameter

Methods

__init__(self, parameter=None, control=None, *a, **k)

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

connect(self)
disconnect(self)
soft_disconnect(self)

Attributes

  • _control = None
  • _parameter = None

class ProxyBase

Properties

  • proxied_interface
  • proxied_object

Methods

__init__(self, *a, **k)

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

proxy_old_hasattr(self, attr)

Attributes

  • _skip_wrapper_lookup = None

class ToggleElement(WrapperElement)

Properties

  • proxied_object
  • resource
  • wrapped_control

Methods

ProxiedInterface(outer=None, *a, **k)
__init__(self, on_control=None, off_control=None, *a, **k)

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

_connect_nested_control_elements(self)
_disconnect_nested_control_elements(self)
_get_nested_client(self, client)
_grab_nested_control_elements(self, client, priority=None, **k)
_is_initialized(self)
_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)
_update_toggled(self)
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)
set_toggled(self, value)
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
  • proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>

class WrapperElement(CompoundElement, ProxyBase)

Properties

  • proxied_object
  • resource
  • wrapped_control

Methods

ProxiedInterface(outer=None, *a, **k)
__init__(self, wrapped_control=None, *a, **k)

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

_connect_nested_control_elements(self)
_disconnect_nested_control_elements(self)
_get_nested_client(self, client)
_grab_nested_control_elements(self, client, priority=None, **k)
_is_initialized(self)
_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
  • proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>

class lazy_attribute

Methods

__init__(self, func, name=None)

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