`ableton.v2.control_surface.components.session_navigation` (runtime)¶

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

Functions¶

`listens(event_path, *a, **k)`¶

Classes¶

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 `ScrollComponent(Component, Scrollable)`¶

Properties¶

application
is_root
layer
parent
scrollable
song

Methods¶

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

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

`_add_child(self, component)`¶

`_do_scroll_down(self)`¶

`_do_scroll_up(self)`¶

`_ensure_scroll_one_direction(self)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_make_scroll_task(self, scroll_step)`¶

`_on_scroll_pressed(self, button, scroll_step, scroll_task)`¶

`_on_scroll_released(self, scroll_task)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_update_is_enabled(self)`¶

`_update_scroll_buttons(self)`¶

`add_children(self, *a)`¶

`add_control(self, name, control)`¶

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

`can_scroll_down(self)`¶

`can_scroll_up(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_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)`¶

`scroll_down(self)`¶

`scroll_up(self)`¶

`set_enabled(self, enable)`¶

`set_scroll_down_button(self, button)`¶

`set_scroll_up_button(self, button)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_has_task_group = False - bool(x) -> bool
_layer = None
_scrollable = <ableton.v2.control_surface.components.scroll.Scrollable object at 0x1635110f0>
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x163088ef0>
canonical_parent = None
default_pager = <ableton.v2.control_surface.components.scroll.Scrollable object at 0x163511128>
default_scrollable = <ableton.v2.control_surface.components.scroll.Scrollable object at 0x1635110f0>
is_private = True - bool(x) -> bool
name = '' - str(object='') -> str
scroll_down_button = <ableton.v2.control_surface.control.button.ButtonControl object at 0x163511198>
scroll_up_button = <ableton.v2.control_surface.control.button.ButtonControl object at 0x163511160>
scrolling_delay = 0.3 - Convert a string or number to a floating point number, if possible.
scrolling_step_delay = 0.1 - Convert a string or number to a floating point number, if possible.

class `Scrollable`¶

Methods¶

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

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

`can_scroll_down(self)`¶

`can_scroll_up(self)`¶

`scroll_down(self)`¶

`scroll_up(self)`¶

class `SessionNavigationComponent(Component)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

`init(self, session_ring=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_enabled_recursive(self, enable)`¶

`_update_horizontal(self)`¶

`_update_is_enabled(self)`¶

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

`scene_pager_type(*a, **k)`¶

`scene_scroller_type(session_ring=None, *a, **k)`¶

`set_down_button(self, button)`¶

`set_enabled(self, enable)`¶

`set_left_button(self, button)`¶

`set_page_down_button(self, page_down_button)`¶

`set_page_left_button(self, page_left_button)`¶

`set_page_right_button(self, page_right_button)`¶

`set_page_up_button(self, page_up_button)`¶

`set_right_button(self, button)`¶

`set_up_button(self, button)`¶

`track_pager_type(*a, **k)`¶

`track_scroller_type(session_ring=None, *a, **k)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_SessionNavigationComponent__on_offset_changed = None
_SessionNavigationComponent__on_scene_list_changed = None
_SessionNavigationComponent__on_tracks_changed = None
_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 `SessionRingScenePager(SessionRingScroller)`¶

Methods¶

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

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

`can_scroll_down(self)`¶

`can_scroll_up(self)`¶

`do_scroll_down(self)`¶

`do_scroll_up(self)`¶

`scroll_down(self)`¶

`scroll_up(self)`¶

class `SessionRingSceneScroller(SessionRingScroller)`¶

Methods¶

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

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

`can_scroll_down(self)`¶

`can_scroll_up(self)`¶

`do_scroll_down(self)`¶

`do_scroll_up(self)`¶

`scroll_down(self)`¶

`scroll_up(self)`¶

class `SessionRingScroller(Scrollable)`¶

Methods¶

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

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

`can_scroll_down(self)`¶

`can_scroll_up(self)`¶

`scroll_down(self)`¶

`scroll_up(self)`¶

Attributes¶

do_scroll_down = NotImplemented
do_scroll_up = NotImplemented

class `SessionRingTrackPager(SessionRingScroller)`¶

Methods¶

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

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

`can_scroll_down(self)`¶

`can_scroll_up(self)`¶

`do_scroll_down(self)`¶

`do_scroll_up(self)`¶

`scroll_down(self)`¶

`scroll_up(self)`¶

class `SessionRingTrackScroller(SessionRingScroller)`¶

Methods¶

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

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

`can_scroll_down(self)`¶

`can_scroll_up(self)`¶

`do_scroll_down(self)`¶

`do_scroll_up(self)`¶

`scroll_down(self)`¶

`scroll_up(self)`¶

ableton.v2.control_surface.components.session_navigation (runtime)¶

Functions¶

listens(event_path, *a, **k)¶

Classes¶

class Component(ControlManager)¶

Properties¶

Methods¶

__init__(self, name='', parent=None, register_component=None, song=None, layer=None, is_enabled=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)¶

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

class ScrollComponent(Component, Scrollable)¶

Properties¶

Methods¶

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

_add_child(self, component)¶

_do_scroll_down(self)¶

_do_scroll_up(self)¶

_ensure_scroll_one_direction(self)¶

_get_layer_iterable(self)¶

_grab_all_layers(self)¶

_internal_on_enabled_changed(self)¶

_make_scroll_task(self, scroll_step)¶

_on_scroll_pressed(self, button, scroll_step, scroll_task)¶

_on_scroll_released(self, scroll_task)¶

_release_all_layers(self)¶

_set_enabled_recursive(self, enable)¶

_update_is_enabled(self)¶

_update_scroll_buttons(self)¶

add_children(self, *a)¶

add_control(self, name, control)¶

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

can_scroll_down(self)¶

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

scroll_down(self)¶

scroll_up(self)¶

set_enabled(self, enable)¶

set_scroll_down_button(self, button)¶

set_scroll_up_button(self, button)¶

unregister_disconnectable(self, slot)¶

update(self)¶

`ableton.v2.control_surface.components.session_navigation` (runtime)¶

`listens(event_path, *a, **k)`¶

class `Component(ControlManager)`¶

`init(self, name='', parent=None, register_component=None, song=None, layer=None, is_enabled=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)`¶

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

class `ScrollComponent(Component, Scrollable)`¶

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

`_add_child(self, component)`¶

`_do_scroll_down(self)`¶

`_do_scroll_up(self)`¶

`_ensure_scroll_one_direction(self)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_make_scroll_task(self, scroll_step)`¶

`_on_scroll_pressed(self, button, scroll_step, scroll_task)`¶

`_on_scroll_released(self, scroll_task)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_update_is_enabled(self)`¶

`_update_scroll_buttons(self)`¶

`add_children(self, *a)`¶

`add_control(self, name, control)`¶

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

`can_scroll_down(self)`¶

`can_scroll_up(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_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)`¶

`scroll_down(self)`¶

`scroll_up(self)`¶

`set_enabled(self, enable)`¶

`set_scroll_down_button(self, button)`¶

`set_scroll_up_button(self, button)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

class `Scrollable`¶

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

`can_scroll_down(self)`¶

`can_scroll_up(self)`¶

`scroll_down(self)`¶

`scroll_up(self)`¶

class `SessionNavigationComponent(Component)`¶