`ableton.v3.control_surface.mode.modes` (runtime)¶

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

Functions¶

`cast(typ, val)`¶

`make_mode_button_control(modes_component, mode_name, behaviour, **k)`¶

`tomode(thing)`¶

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 `ImmediateBehaviour(ModeButtonBehaviour)`¶

Methods¶

`init(self, /, *args, **kwargs)`¶

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

`press_delayed(self, component, mode)`¶

`press_immediate(self, component, mode)`¶

`release_delayed(self, component, mode)`¶

`release_immediate(self, component, mode)`¶

`update_button(self, component, mode, selected_mode)`¶

class `ModesComponent(Component, Renderable)`¶

Properties¶

active_modes
application
is_root
layer
modes
parent
selected_mode
song

Methods¶

`init(self, name=None, support_momentary_mode_cycling=True, default_behaviour=None, is_private=False, *a, **k)`¶

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

`_add_child(self, component)`¶

`_add_mode_to_list_and_map(self, name, mode_or_component, behaviour, groups)`¶

`_cancel_pop_mode_task(self, mode)`¶

`_cancel_push_mode_task(self, mode)`¶

`_create_event_handler(self, property_name)`¶

`_do_enter_mode(self, name)`¶

`_do_leave_mode(self, name)`¶

`_do_pop_mode(self, mode)`¶

`_do_push_mode(self, mode)`¶

`_get_layer_iterable(self)`¶

`_get_mode_behaviour(self, name)`¶

`_get_mode_color_base_name(self, mode_name)`¶

`_grab_all_layers(self)`¶

`_handle_mode_selection_control_value(self, value)`¶

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`_internal_on_enabled_changed(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_is_enabled(self)`¶

`_update_mode_controls(self, selected_mode)`¶

`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_mode(self, name, mode_or_component, groups=None, behaviour=None, selector=None, index=None)`¶

`add_mode_button_control(self, mode_name, behaviour)`¶

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

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

`any_clipboard_has_content_has_listener(self, slot)`¶

`any_clipboard_has_content_listener_count(self)`¶

`control_base_type(extra_args=None, extra_kws=None, *a, **k)`¶

`control_notifications_enabled(self)`¶

`cycle_mode(self, delta=1)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`dispatch_event(self, name: 'str', value)`¶

`enabled_has_listener(self, slot)`¶

`enabled_listener_count(self)`¶

`find_disconnectable(self, predicate)`¶

`get_mode(self, name)`¶

`get_mode_button(self, name)`¶

`get_mode_groups(self, name)`¶

`has_disconnectable(self, slot)`¶

`is_enabled(self, explicit=False)`¶

`notify(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')`¶

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

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

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

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

`on_enabled_changed(self)`¶

`pop_groups(self, groups)`¶

`pop_mode(self, mode, delay=0)`¶

`pop_unselected_modes(self)`¶

`previous_mode_has_listener(self, slot)`¶

`previous_mode_listener_count(self)`¶

`push_mode(self, mode, delay=0)`¶

`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_previous_mode_listener(self, slot)`¶

`remove_selected_mode_listener(self, slot)`¶

`renderable_state(self)`¶

`selected_mode_has_listener(self, slot)`¶

`selected_mode_listener_count(self)`¶

`set_enabled(self, enable)`¶

`suppress_notifications(self)`¶

`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
cycle_mode_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c98fa90>
default_behaviour = <ableton.v2.control_surface.mode.ImmediateBehaviour object at 0x13c98fb50>
include_in_top_level_state = True - bool(x) -> bool
mode_selection_control = <ableton.v3.control_surface.controls.control.SendValueInputControl object at 0x13c98fa10>
num_layers = 0 - int([x]) -> integer
previous_mode = None

class `Renderable(CompoundDisconnectable)`¶

Methods¶

`init(self, react=None, notifications: 'Optional[Type[Notifications]]' = None, suppress_notifications: 'Optional[Callable]' = None, *a, **k)`¶

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

`_create_event_handler(self, property_name)`¶

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`control_base_type(extra_args=None, extra_kws=None, *a, **k)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`dispatch_event(self, name: 'str', value)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`notify(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`renderable_state(self)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

Attributes¶

include_in_top_level_state = True - bool(x) -> bool

class `SendValueInputControl(InputControl)`¶

Properties¶

value

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 `StackingResource(Resource)`¶

Properties¶

clients
max_priority
owner
owners
stack_size

Methods¶

`init(self, on_received_callback=None, on_lost_callback=None, *a, **k)`¶

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

`_actual_owners(self)`¶

`_add_client(self, client, priority)`¶

`_on_lost_set(self, clients)`¶

`_on_received_set(self, clients)`¶

`_remove_client(self, client)`¶

`get_owner(self)`¶

`grab(self, client, priority=None)`¶

`on_lost(self, client)`¶

`on_received(self, client)`¶

`release(self, client)`¶

`release_all(self)`¶

`release_stacked(self)`¶

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.mode.modes (runtime)¶

Functions¶

cast(typ, val)¶

make_mode_button_control(modes_component, mode_name, behaviour, **k)¶

tomode(thing)¶

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 ImmediateBehaviour(ModeButtonBehaviour)¶

Methods¶

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

press_delayed(self, component, mode)¶

press_immediate(self, component, mode)¶

release_delayed(self, component, mode)¶

release_immediate(self, component, mode)¶

update_button(self, component, mode, selected_mode)¶

class ModesComponent(Component, Renderable)¶

Properties¶

Methods¶

__init__(self, name=None, support_momentary_mode_cycling=True, default_behaviour=None, is_private=False, *a, **k)¶

_add_child(self, component)¶

_add_mode_to_list_and_map(self, name, mode_or_component, behaviour, groups)¶

_cancel_pop_mode_task(self, mode)¶

_cancel_push_mode_task(self, mode)¶

_create_event_handler(self, property_name)¶

_do_enter_mode(self, name)¶

_do_leave_mode(self, name)¶

_do_pop_mode(self, mode)¶

_do_push_mode(self, mode)¶

_get_layer_iterable(self)¶

_get_mode_behaviour(self, name)¶

_get_mode_color_base_name(self, mode_name)¶

_grab_all_layers(self)¶

_handle_mode_selection_control_value(self, value)¶

`ableton.v3.control_surface.mode.modes` (runtime)¶

`cast(typ, val)`¶

`make_mode_button_control(modes_component, mode_name, behaviour, **k)`¶

`tomode(thing)`¶

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 `ImmediateBehaviour(ModeButtonBehaviour)`¶

`init(self, /, *args, **kwargs)`¶

`press_delayed(self, component, mode)`¶

`press_immediate(self, component, mode)`¶

`release_delayed(self, component, mode)`¶

`release_immediate(self, component, mode)`¶

`update_button(self, component, mode, selected_mode)`¶

class `ModesComponent(Component, Renderable)`¶

`init(self, name=None, support_momentary_mode_cycling=True, default_behaviour=None, is_private=False, *a, **k)`¶

`_add_child(self, component)`¶

`_add_mode_to_list_and_map(self, name, mode_or_component, behaviour, groups)`¶

`_cancel_pop_mode_task(self, mode)`¶

`_cancel_push_mode_task(self, mode)`¶

`_create_event_handler(self, property_name)`¶

`_do_enter_mode(self, name)`¶

`_do_leave_mode(self, name)`¶

`_do_pop_mode(self, mode)`¶

`_do_push_mode(self, mode)`¶

`_get_layer_iterable(self)`¶

`_get_mode_behaviour(self, name)`¶

`_get_mode_color_base_name(self, mode_name)`¶

`_grab_all_layers(self)`¶

`_handle_mode_selection_control_value(self, value)`¶

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`_internal_on_enabled_changed(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_is_enabled(self)`¶

`_update_mode_controls(self, selected_mode)`¶

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

`add_children(self, *children)`¶

`add_control(self, name, control)`¶