Skip to content

ableton.v2.control_surface.components.playable (runtime)

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

Functions

apply_to_list(original_list, operation, item)

control_matrix(control_type, *a, **k)

Classes

class AccentComponent(Component)

Properties

  • activated
  • application
  • is_root
  • layer
  • parent
  • song

Methods

__init__(self, *a, **k)

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

_add_child(self, component)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_release_all_layers(self)
_set_enabled_recursive(self, enable)
_update_is_enabled(self)
activated_has_listener(self, slot)
activated_listener_count(self)
add_activated_listener(self, slot, identify_sender=False, *a, **k)
add_children(self, *a)
add_control(self, name, control)
add_enabled_listener(self, slot, identify_sender=False, *a, **k)
control_notifications_enabled(self)
disconnect(self)
disconnect_disconnectable(self, slot)
enabled_has_listener(self, slot)
enabled_listener_count(self)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
is_enabled(self, explicit=False)
notify_activated(self, *a, **k)
notify_enabled(self, *a, **k)
on_enabled_changed(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_activated_listener(self, slot)
remove_enabled_listener(self, slot)
set_enabled(self, enable)
set_full_velocity(self, full_velocity)
unregister_disconnectable(self, slot)
update(self)

Attributes

  • _has_task_group = False - bool(x) -> bool
  • _layer = None
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x163088ef0>
  • accent_button = <ableton.v2.control_surface.control.toggle_button.ToggleButtonControl object at 0x163493588>
  • canonical_parent = None
  • is_private = False - bool(x) -> bool
  • name = '' - str(object='') -> str

class ButtonControl(ButtonControlBase)

Properties

  • double_clicked
  • pressed
  • pressed_delayed
  • released
  • released_delayed
  • released_immediately
  • value

Methods

State(color='DefaultButton.On', *a, **k)
__init__(self, *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

  • DELAY_TIME = 0.3 - Convert a string or number to a floating point number, if possible.
  • DOUBLE_CLICK_TIME = 0.5 - Convert a string or number to a floating point number, if possible.
  • REPEAT_RATE = 0.1 - Convert a string or number to a floating point number, if possible.
  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class Component(ControlManager)

Properties

  • application
  • is_root
  • layer
  • parent
  • song

Methods

__init__(self, name='', parent=None, register_component=None, song=None, layer=None, is_enabled=True, *a, **k)

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

_add_child(self, component)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_release_all_layers(self)
_set_enabled_recursive(self, enable)
_update_is_enabled(self)
add_children(self, *a)
add_control(self, name, control)
add_enabled_listener(self, slot, identify_sender=False, *a, **k)
control_notifications_enabled(self)
disconnect(self)
disconnect_disconnectable(self, slot)
enabled_has_listener(self, slot)
enabled_listener_count(self)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
is_enabled(self, explicit=False)
notify_enabled(self, *a, **k)
on_enabled_changed(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_enabled_listener(self, slot)
set_enabled(self, enable)
unregister_disconnectable(self, slot)
update(self)

Attributes

  • _has_task_group = False - bool(x) -> bool
  • _layer = None
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x163088ef0>
  • canonical_parent = None
  • is_private = False - bool(x) -> bool
  • name = '' - str(object='') -> str

class Number

Methods

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

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

Attributes

  • _abc_impl = <_abc_data object at 0x14deec3f0>

class PlayableComponent(Component)

Properties

  • application
  • height
  • is_root
  • layer
  • parent
  • song
  • width

Methods

__init__(self, *a, **k)

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

_add_child(self, component)
_button_should_be_enabled(self, button)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_note_translation_for_button(self, button)
_on_matrix_pressed(self, button)
_on_matrix_released(self, button)
_release_all_layers(self)
_reset_selected_pads(self)
_set_button_control_properties(self, button)
_set_control_pads_from_script(self, takeover_pads)
_set_enabled_recursive(self, enable)
_update_button_color(self, button)
_update_control_from_script(self)
_update_is_enabled(self)
_update_led_feedback(self)
_update_note_translations(self)
add_children(self, *a)
add_control(self, name, control)
add_enabled_listener(self, slot, identify_sender=False, *a, **k)
add_pressed_pads_listener(self, slot, identify_sender=False, *a, **k)
control_notifications_enabled(self)
disconnect(self)
disconnect_disconnectable(self, slot)
enabled_has_listener(self, slot)
enabled_listener_count(self)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
is_enabled(self, explicit=False)
notify_enabled(self, *a, **k)
notify_pressed_pads(self, *a, **k)
on_enabled_changed(self)
pressed_pads_has_listener(self, slot)
pressed_pads_listener_count(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_enabled_listener(self, slot)
remove_pressed_pads_listener(self, slot)
set_accent_button(self, button)
set_enabled(self, enable)
set_full_velocity(self, full_velocity)
set_matrix(self, matrix)
unregister_disconnectable(self, slot)
update(self)

Attributes

  • _has_task_group = False - bool(x) -> bool
  • _layer = None
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x163088ef0>
  • canonical_parent = None
  • is_private = False - bool(x) -> bool
  • matrix = <ableton.v2.base.util.Mixin_MatrixControl_PlayableControl object at 0x163502748>
  • name = '' - str(object='') -> str
  • pressed_pads = [] - Built-in mutable sequence.
  • select_button = <ableton.v2.control_surface.control.button.ButtonControl object at 0x163502780>

class PlayableControl(ButtonControl)

Properties

  • double_clicked
  • pressed
  • pressed_delayed
  • released
  • released_delayed
  • released_immediately
  • value

Methods

Mode(...)

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

State(mode=None, *a, **k)
__init__(self, *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

  • DELAY_TIME = 0.3 - Convert a string or number to a floating point number, if possible.
  • DOUBLE_CLICK_TIME = 0.5 - Convert a string or number to a floating point number, if possible.
  • REPEAT_RATE = 0.1 - Convert a string or number to a floating point number, if possible.
  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

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>