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

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

Classes

class BackgroundComponent(Component)

Properties

• application
• is_root
• layer
• parent
• song

Methods

__init__(self, name='Background', control_type=None, *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_element_for_control(self, name, element)

_set_enabled_recursive(self, enable)

_setup_control_state(self, name, control_state)

_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 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 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 ModifierBackgroundComponent(BackgroundComponent)

Properties

• application
• is_root
• layer
• parent
• song

Methods

__init__(self, name='Modifier_Background', *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_element_for_control(self, name, element)

_set_enabled_recursive(self, enable)

_setup_control_state(self, name, control_state)

_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 NopControl(InputControl)

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 RadioButtonGroup(ControlList, RadioButtonControl)

Properties

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

Methods

State(*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.
• DYNAMIC_CONTROL_COUNT = None
• 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 TranslatingBackgroundComponent(BackgroundComponent)

Properties

• application
• is_root
• layer
• parent
• song

Methods

__init__(self, name='Translating_Background', translation_channel=0, *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_element_for_control(self, name, element)

_set_enabled_recursive(self, enable)

_setup_control_state(self, _, control_state)

_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_channel_selection_buttons(self, buttons)

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
• channel_selection_buttons = <ableton.v2.control_surface.control.control_list.RadioButtonGroup object at 0x13c700b50>
• num_layers = 0 - int([x]) -> integer

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