Skip to content

ableton.v3.control_surface.mode (runtime)

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

Functions

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

make_reenter_behaviour(base_behaviour, on_reenter=None, *a, **k)

pop_last_mode(component, mode)

select_mode_for_main_view(main_view_name, can_select_now=True)

select_mode_on_event_change(event_description, can_select_now=False)

toggle_mode_on_property_change(event_description, return_to_default=False, can_select_now=False)

Classes

class AddLayerMode(LayerModeBase)

Methods

__init__(self, component=None, layer=None, *a, **k)

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

_get_component(self)
enter_mode(self)
leave_mode(self)

class CallFunctionMode(Mode)

Methods

__init__(self, on_enter_fn=<function nop at 0x11afcb240>, on_exit_fn=<function nop at 0x11afcb240>, *a, **k)

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

enter_mode(self)
leave_mode(self)

class CompoundMode(Mode)

Methods

__init__(self, *modes, **k)

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

enter_mode(self)
leave_mode(self)

class DelayMode(Mode)

Methods

__init__(self, mode=None, delay=None, parent_task_group=None, *a, **k)

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

_enter_mode_delayed(self)
enter_mode(self)
leave_mode(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 EnablingMode(Mode)

Methods

__init__(self, enableable=None, *a, **k)

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

enter_mode(self)
leave_mode(self)

class EventDescription(tuple)

EventDescription(subject, event_name, event_state)

Methods

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

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

_asdict(self)
_make(iterable)

Make a new EventDescription object from a sequence or iterable

_replace(self, /, **kwds)

Return a new EventDescription object replacing specified fields with new values

count(self, value, /)

Return number of occurrences of value.

index(self, value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.

Attributes

  • _field_defaults = {'event_state': None} - dict() -> new empty dictionary
  • _fields = ('subject', 'event_name', 'event_state') - Built-in immutable sequence.
  • event_name = _tuplegetter(1, 'Alias for field number 1') - Alias for field number 1
  • event_state = _tuplegetter(2, 'Alias for field number 2') - Alias for field number 2
  • subject = _tuplegetter(0, 'Alias for field number 0') - Alias for field number 0

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 LatchingBehaviour(ImmediateBehaviour)

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 LayerMode(LayerModeBase)

Methods

__init__(self, component=None, layer=None, *a, **k)

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

_get_component(self)
enter_mode(self)
leave_mode(self)

class LayerModeBase(Mode)

Methods

__init__(self, component=None, layer=None, *a, **k)

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

_get_component(self)
enter_mode(self)
leave_mode(self)

class Mode

Methods

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

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

enter_mode(self)
leave_mode(self)

class 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 ModeButtonControl(ButtonControlBase)

Properties

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

Methods

State(modes_component=None, mode_name=None, mode_selected_color=None, mode_unselected_color=None, mode_group_active_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 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 MomentaryBehaviour(ModeButtonBehaviour)

Methods

__init__(self, entry_delay=None, exit_delay=None, immediate_exit_delay=None)

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 ReenterBehaviourMixin

Methods

__init__(self, on_reenter=None, *a, **k)

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

press_immediate(self, component, mode)

class SetAttributeMode(Mode)

Methods

__init__(self, obj=None, attribute=None, value=None, *a, **k)

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

_get_object(self)
enter_mode(self)
leave_mode(self)

class ShowDetailClipMode(Mode)

Methods

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

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

enter_mode(self)
leave_mode(self)

class ToggleBehaviour(ModeButtonBehaviour)

Methods

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

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)