Skip to content

ableton.v2.control_surface.control.control (runtime)

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

Functions

control_event(event_name)

forward_control(control)

mixin(*args)

nop(*a, **k)

old_hasattr(obj, attr)

Classes

class Connectable(EventObject)

Properties

  • connected_property_value

Methods

__init__(self, *a, **k)

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

_handle_connected_property_changed(self, value=None)
_make_empty_connection(self)
_register_property_slot(self, subject, property_name)
connect_property(self, subject, property_name, transform=<function nop at 0x14def8bf8>)
disconnect(self)
disconnect_disconnectable(self, slot)
disconnect_property(self)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
on_connected_property_changed(self, value)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
unregister_disconnectable(self, slot)

Attributes

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

class Control

Methods

State(control=None, manager=None, *a, **k)
__init__(self, extra_args=None, extra_kws=None, *a, **k)

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

_clear_state(self, manager)
_get_state(self, manager, state_factory=None)
_make_control_state(self, manager)

Attributes

  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class ControlManager(EventObject)

Methods

__init__(self, *a, **k)

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

add_control(self, name, control)
control_notifications_enabled(self)
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)
update(self)

Attributes

  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x1630dd518>

class Disconnectable

Methods

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

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

disconnect(self)

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 InputControl(Control)

Properties

  • value

Methods

State(control=None, channel=None, identifier=None, *a, **k)
__init__(self, extra_args=None, extra_kws=None, *a, **k)

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

_clear_state(self, manager)
_get_state(self, manager, state_factory=None)
_make_control_state(self, manager)

Attributes

  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class NamedTuple

Methods

__init__(self, *others, **k)

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

Attributes

  • _eq_dict = <ableton.v2.base.util.lazy_attribute object at 0x14df25080>

class NullSlot(Disconnectable)

Methods

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

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

disconnect(self)

class ProxyControl

Methods

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

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

_clear_state(self, manager)
_get_state(self, manager, state_factory=None)
_make_control_state(self, manager)

class SendValueControl(Control)

Methods

State(*a, **k)
__init__(self, extra_args=None, extra_kws=None, *a, **k)

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

_clear_state(self, manager)
_get_state(self, manager, state_factory=None)
_make_control_state(self, manager)

Attributes

  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class SendValueMixin

Properties

  • value

Methods

__init__(self, *a, **k)

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

_send_current_value(self)
set_control_element(self, control_element)
update(self)

class control_color

Methods

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

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

class lazy_attribute

Methods

__init__(self, func, name=None)

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

class listenable_property(listenable_property_base, property)

Property attribute.

fget function to be used for getting an attribute value fset function to be used for setting an attribute value fdel function to be used for del'ing an attribute doc docstring

Typical use is to define a managed attribute x:

class C(object): def getx(self): return self._x def setx(self, value): self._x = value def delx(self): del self._x x = property(getx, setx, delx, "I'm the 'x' property.")

Decorators make defining new properties or modifying existing ones easy:

class C(object): @property def x(self): "I am the 'x' property." return self._x @x.setter def x(self, value): self._x = value @x.deleter def x(self): del self._x

Methods

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

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

deleter(...)

Descriptor to change the deleter on a property.

getter(...)

Descriptor to change the getter on a property.

managed(default_value)
set_property_name(self, name)
setter(...)

Descriptor to change the setter on a property.

Attributes

  • fdel = <member 'fdel' of 'property' objects>
  • fget = <member 'fget' of 'property' objects>
  • fset = <member 'fset' of 'property' objects>

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