`ableton.v3.control_surface.control_surface_mapping` (runtime)¶

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

Classes¶

class `ComponentMap(dict)`¶

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Methods¶

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

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

`_create_component_map(self, specification)`¶

`clear(...)`¶

D.clear() -> None. Remove all items from D.

`copy(...)`¶

D.copy() -> a shallow copy of D

`fromkeys(iterable, value=None, /)`¶

Create a new dictionary with keys from iterable and values set to value.

`get(self, key, **_)`¶

Return the value for key if key is in the dictionary, else default.

`items(...)`¶

D.items() -> a set-like object providing a view on D's items

`keys(...)`¶

D.keys() -> a set-like object providing a view on D's keys

`pop(...)`¶

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

`popitem(self, /)`¶

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

`setdefault(self, key, default=None, /)`¶

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

`update(...)`¶

D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

`values(...)`¶

D.values() -> an object providing a view on D's values

class `ControlSurfaceMappingMixin(Disconnectable)`¶

Methods¶

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

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

`_add_mode(self, mode_name, mode_spec, modes_component)`¶

`_create_component(self, name, component_mappings)`¶

`_create_mode_part(self, mode_mappings)`¶

`_create_modes_component(self, name, modes_config)`¶

`_setup_modes_component(self, name, modes_config)`¶

`disconnect(self)`¶

`setup(self)`¶

class `Disconnectable`¶

Methods¶

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

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

`disconnect(self)`¶

class `EnablingAddLayerMode(LayerModeBase)`¶

Methods¶

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

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

`_get_component(self)`¶

`_possibly_disable_component(self)`¶

`enter_mode(self)`¶

`leave_mode(self)`¶

class `Layer(Layer)`¶

Properties¶

owner
priority

Methods¶

`init(self, priority=None, **elements)`¶

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

`_get_control_client(self, client)`¶

`get_owner(self)`¶

`grab(self, client, *a, **k)`¶

`on_lost(self, client)`¶

`on_received(self, client, *a, **k)`¶

`release(self, client)`¶

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

ableton.v3.control_surface.control_surface_mapping (runtime)¶

Classes¶

class ComponentMap(dict)¶

Methods¶

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

_create_component_map(self, specification)¶

clear(...)¶

copy(...)¶

fromkeys(iterable, value=None, /)¶

get(self, key, **_)¶

items(...)¶

keys(...)¶

pop(...)¶

popitem(self, /)¶

setdefault(self, key, default=None, /)¶

update(...)¶

values(...)¶

class ControlSurfaceMappingMixin(Disconnectable)¶

Methods¶

__init__(self, specification=None, *a, **k)¶

_add_mode(self, mode_name, mode_spec, modes_component)¶

_create_component(self, name, component_mappings)¶

_create_mode_part(self, mode_mappings)¶

_create_modes_component(self, name, modes_config)¶

_setup_modes_component(self, name, modes_config)¶

disconnect(self)¶

setup(self)¶

class Disconnectable¶

Methods¶

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

disconnect(self)¶

class EnablingAddLayerMode(LayerModeBase)¶

Methods¶

__init__(self, parent_task_group=None, *a, **k)¶

_get_component(self)¶

_possibly_disable_component(self)¶

enter_mode(self)¶

leave_mode(self)¶

class Layer(Layer)¶

Properties¶

Methods¶

__init__(self, priority=None, **elements)¶

_get_control_client(self, client)¶

get_owner(self)¶

grab(self, client, *a, **k)¶

on_lost(self, client)¶

on_received(self, client, *a, **k)¶

release(self, client)¶

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

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

`ableton.v3.control_surface.control_surface_mapping` (runtime)¶

class `ComponentMap(dict)`¶

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

`_create_component_map(self, specification)`¶

`clear(...)`¶

`copy(...)`¶

`fromkeys(iterable, value=None, /)`¶

`get(self, key, **_)`¶

`items(...)`¶

`keys(...)`¶

`pop(...)`¶

`popitem(self, /)`¶

`setdefault(self, key, default=None, /)`¶

`update(...)`¶

`values(...)`¶

class `ControlSurfaceMappingMixin(Disconnectable)`¶

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

`_add_mode(self, mode_name, mode_spec, modes_component)`¶

`_create_component(self, name, component_mappings)`¶

`_create_mode_part(self, mode_mappings)`¶

`_create_modes_component(self, name, modes_config)`¶

`_setup_modes_component(self, name, modes_config)`¶

`disconnect(self)`¶

`setup(self)`¶

class `Disconnectable`¶

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

`disconnect(self)`¶

class `EnablingAddLayerMode(LayerModeBase)`¶

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

`_get_component(self)`¶

`_possibly_disable_component(self)`¶

`enter_mode(self)`¶

`leave_mode(self)`¶

class `Layer(Layer)`¶

`init(self, priority=None, **elements)`¶

`_get_control_client(self, client)`¶

`get_owner(self)`¶

`grab(self, client, *a, **k)`¶

`on_lost(self, client)`¶

`on_received(self, client, *a, **k)`¶

`release(self, client)`¶

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

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