Skip to content

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

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

Functions

nop(*a, **k)

Classes

class BackgroundComponent(Component)

Properties

  • application
  • is_root
  • layer
  • parent
  • song

Methods

__init__(self, add_nop_listeners=False, *a, **k)

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

_add_child(self, component)
_clear_control(self, name, control)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_release_all_layers(self)
_reset_control(self, control)
_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 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 ModifierBackgroundComponent(BackgroundComponent)

Properties

  • application
  • is_root
  • layer
  • parent
  • song

Methods

__init__(self, *a, **k)

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

_add_child(self, component)
_clear_control(self, name, control)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_release_all_layers(self)
_reset_control(self, control)
_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 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