`ableton.v3.control_surface.components.playable` (runtime)¶

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

Functions¶

`control_matrix(control_type, *a, **k)`¶

Classes¶

class `ButtonControl(ButtonControlBase)`¶

Properties¶

double_clicked
pressed
pressed_delayed
released
released_delayed
released_immediately
value

Methods¶

`State(color='DefaultButton.On', on_color=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 `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, is_private=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)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_is_enabled(self)`¶

`add_any_clipboard_has_content_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_children(self, *children)`¶

`add_control(self, name, control)`¶

`add_enabled_listener(self, slot, identify_sender=False, *a, **k)`¶

`any_clipboard_has_content_has_listener(self, slot)`¶

`any_clipboard_has_content_listener_count(self)`¶

`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_any_clipboard_has_content(self, *a, **k)`¶

`notify_enabled(self, *a, **k)`¶

`on_enabled_changed(self)`¶

`register_clipboard(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`register_slot(self, *a, **k)`¶

`remove_any_clipboard_has_content_listener(self, slot)`¶

`remove_enabled_listener(self, slot)`¶

`set_enabled(self, enable)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
num_layers = 0 - int([x]) -> integer

class `PlayableComponent(Component)`¶

Properties¶

application
height
is_root
layer
parent
song
width

Methods¶

`init(self, name='Playable', matrix_always_listenable=False, *a, **k)`¶

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

`_add_child(self, component)`¶

`_any_modifier_pressed(self)`¶

`_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)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_button_color(self, button)`¶

`_update_control_from_script(self)`¶

`_update_is_enabled(self)`¶

`_update_led_feedback(self)`¶

`_update_note_translations(self)`¶

`add_any_clipboard_has_content_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_children(self, *children)`¶

`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)`¶

`any_clipboard_has_content_has_listener(self, slot)`¶

`any_clipboard_has_content_listener_count(self)`¶

`control_notifications_enabled(self)`¶

`create_modifier_buttons(self, *button_names)`¶

`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_any_clipboard_has_content(self, *a, **k)`¶

`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_clipboard(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`register_slot(self, *a, **k)`¶

`remove_any_clipboard_has_content_listener(self, slot)`¶

`remove_enabled_listener(self, slot)`¶

`remove_pressed_pads_listener(self, slot)`¶

`set_enabled(self, enable)`¶

`set_matrix(self, matrix)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
matrix = <ableton.v2.base.util.Mixin_MatrixControl_PlayableControl object at 0x13c7dba90>
num_layers = 0 - int([x]) -> integer
pressed_pads = [] - Built-in mutable sequence.

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 obtain a copy of the property with a different deleter.

`getter(...)`¶

Descriptor to obtain a copy of the property with a different getter.

`managed(default_value)`¶

`set_property_name(self, name)`¶

`setter(...)`¶

Descriptor to obtain a copy of the property with a different setter.

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

ableton.v3.control_surface.components.playable (runtime)¶

Functions¶

control_matrix(control_type, *a, **k)¶

Classes¶

class ButtonControl(ButtonControlBase)¶

Properties¶

Methods¶

State(color='DefaultButton.On', on_color=None, *a, **k)¶

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

_clear_state(self, manager)¶

_get_state(self, manager, state_factory=None)¶

_make_control_state(self, manager)¶

Attributes¶

class Component(ControlManager)¶

Properties¶

Methods¶

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

_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)¶

_tasks(self, parent_task_group=None)¶

_update_is_enabled(self)¶

add_any_clipboard_has_content_listener(self, slot, identify_sender=False, *a, **k)¶

add_children(self, *children)¶

add_control(self, name, control)¶

add_enabled_listener(self, slot, identify_sender=False, *a, **k)¶

any_clipboard_has_content_has_listener(self, slot)¶

any_clipboard_has_content_listener_count(self)¶

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_any_clipboard_has_content(self, *a, **k)¶

notify_enabled(self, *a, **k)¶

on_enabled_changed(self)¶

register_clipboard(self)¶

register_disconnectable(self, slot)¶

register_disconnectables(self, disconnectables)¶

register_slot(self, *a, **k)¶

remove_any_clipboard_has_content_listener(self, slot)¶

remove_enabled_listener(self, slot)¶

set_enabled(self, enable)¶

unregister_disconnectable(self, slot)¶

update(self)¶

Attributes¶

class PlayableComponent(Component)¶

Properties¶

Methods¶

__init__(self, name='Playable', matrix_always_listenable=False, *a, **k)¶

_add_child(self, component)¶

_any_modifier_pressed(self)¶

_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)¶

_tasks(self, parent_task_group=None)¶

_update_button_color(self, button)¶

_update_control_from_script(self)¶

_update_is_enabled(self)¶

_update_led_feedback(self)¶

_update_note_translations(self)¶

add_any_clipboard_has_content_listener(self, slot, identify_sender=False, *a, **k)¶

add_children(self, *children)¶

add_control(self, name, control)¶

add_enabled_listener(self, slot, identify_sender=False, *a, **k)¶

`ableton.v3.control_surface.components.playable` (runtime)¶

`control_matrix(control_type, *a, **k)`¶

class `ButtonControl(ButtonControlBase)`¶

`State(color='DefaultButton.On', on_color=None, *a, **k)`¶

`init(self, *a, **k)`¶

`_clear_state(self, manager)`¶

`_get_state(self, manager, state_factory=None)`¶

`_make_control_state(self, manager)`¶

class `Component(ControlManager)`¶

`init(self, name='', parent=None, register_component=None, song=None, layer=None, is_enabled=True, is_private=True, *a, **k)`¶

`_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)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_is_enabled(self)`¶

`add_any_clipboard_has_content_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_children(self, *children)`¶

`add_control(self, name, control)`¶

`add_enabled_listener(self, slot, identify_sender=False, *a, **k)`¶

`any_clipboard_has_content_has_listener(self, slot)`¶

`any_clipboard_has_content_listener_count(self)`¶

`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_any_clipboard_has_content(self, *a, **k)`¶

`notify_enabled(self, *a, **k)`¶

`on_enabled_changed(self)`¶

`register_clipboard(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`register_slot(self, *a, **k)`¶

`remove_any_clipboard_has_content_listener(self, slot)`¶

`remove_enabled_listener(self, slot)`¶

`set_enabled(self, enable)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

class `PlayableComponent(Component)`¶

`init(self, name='Playable', matrix_always_listenable=False, *a, **k)`¶

`_add_child(self, component)`¶

`_any_modifier_pressed(self)`¶

`_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)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_button_color(self, button)`¶

`_update_control_from_script(self)`¶

`_update_is_enabled(self)`¶

`_update_led_feedback(self)`¶

`_update_note_translations(self)`¶

`add_any_clipboard_has_content_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_children(self, *children)`¶

`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)`¶

`any_clipboard_has_content_has_listener(self, slot)`¶

`any_clipboard_has_content_listener_count(self)`¶

`control_notifications_enabled(self)`¶

`create_modifier_buttons(self, *button_names)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`enabled_has_listener(self, slot)`¶

`enabled_listener_count(self)`¶

`find_disconnectable(self, predicate)`¶