ableton.v2.control_surface.control_element (runtime)

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

Module constants

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

Functions

const(value)

depends(**dependencies)

get_element(obj, element_container=None)

nop(*a, **k)

second(seq)

Classes

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

clear_send_cache(self)

disconnect(self)

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

reset(self)

reset_state(self)

send_midi(self, message)

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 ControlElementClient

Methods

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

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

set_control_element(self, control_element, grabbed)

class Disconnectable

Methods

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

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

disconnect(self)

class ElementOwnershipHandler

Methods

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

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

handle_ownership_change(self, control, client, status)

class Event(NamedTuple)

Methods

__init__(self, *others, **k)

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

signal(combiner=<function default_combiner at 0x14def8950>, sender=None, *a, **k)

Attributes

• _eq_dict = <ableton.v2.base.util.lazy_attribute object at 0x14df25080>
• doc = '' - str(object='') -> str
• name = None
• override = False - 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 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 OptimizedOwnershipHandler(ElementOwnershipHandler)

Methods

__init__(self, *a, **k)

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

commit_ownership_changes(self, traceback=None)

handle_ownership_change(self, control, client, status)

class StackingResource(Resource)

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 lazy_attribute

Methods

__init__(self, func, name=None)

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