`ableton.v3.control_surface.components.device_navigation` (runtime)¶

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

Functions¶

`cast(typ, val)`¶

`depends(**dependencies)`¶

`find_parent_device(device)`¶

`flatten_device_chain(track_or_chain)`¶

`is_device_rack(device)`¶

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

`liveobj_changed(obj, other)`¶

`liveobj_valid(obj)`¶

Classes¶

class `DeviceNavigationComponent(ItemListComponent, Renderable)`¶

Properties¶

application
is_root
layer
parent
scrollable
song

Methods¶

`init(self, name='Device_Navigation', device_provider=None, item_provider=None, *a, **k)`¶

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

`_add_child(self, component)`¶

`_create_event_handler(self, property_name)`¶

`_do_scroll_down(self)`¶

`_do_scroll_up(self)`¶

`_ensure_scroll_one_direction(self)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`_internal_on_enabled_changed(self)`¶

`_make_scroll_task(self, scroll_step)`¶

`_notify_device_selection(self, _)`¶

`_on_devices_scrolled(self)`¶

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

`_on_scroll_released(self, scroll_task)`¶

`_release_all_layers(self)`¶

`_select_device(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_show_device_chain(self)`¶

`_update_device_selection(self)`¶

`_update_is_enabled(self)`¶

`_update_scroll_controls(self)`¶

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

`can_scroll_down(self)`¶

`can_scroll_up(self)`¶

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

`control_notifications_enabled(self)`¶

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

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

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

`scroll_down(self)`¶

`scroll_up(self)`¶

`set_enabled(self, enable)`¶

`set_next_button(self, button)`¶

`set_prev_button(self, button)`¶

`set_scroll_down_button(self, button)`¶

`set_scroll_encoder(self, encoder)`¶

`set_scroll_up_button(self, button)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_DeviceNavigationComponent__on_selected_device_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x163a2a898>
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
include_in_top_level_state = True - bool(x) -> bool
num_layers = 0 - int([x]) -> integer
renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>
scroll_down_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163af0da0>
scroll_encoder = <ableton.v3.control_surface.controls.encoder.StepEncoderControl object at 0x163af0d30>
scroll_up_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163af0d68>
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 `FlattenedDeviceChain(ItemProvider)`¶

Properties¶

has_valid_selection
items
selected_index
selected_item
track

Methods¶

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

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

`_on_items_changed(self)`¶

`_update_devices(self, *_)`¶

`_update_listeners(self)`¶

`_update_selected_index(self)`¶

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

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

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

`can_scroll_down(self)`¶

`can_scroll_up(self)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`items_has_listener(self, slot)`¶

`items_listener_count(self)`¶

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

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

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

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`remove_items_listener(self, slot)`¶

`remove_selected_index_listener(self, slot)`¶

`remove_selected_item_listener(self, slot)`¶

`scroll_down(self)`¶

`scroll_up(self)`¶

`selected_index_has_listener(self, slot)`¶

`selected_index_listener_count(self)`¶

`selected_item_has_listener(self, slot)`¶

`selected_item_listener_count(self)`¶

`unregister_disconnectable(self, slot)`¶

class `ItemListComponent(ScrollComponent)`¶

Properties¶

application
is_root
layer
parent
scrollable
song

Methods¶

`init(self, item_provider=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_controls(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)`¶

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

`scroll_down(self)`¶

`scroll_up(self)`¶

`set_enabled(self, enable)`¶

`set_next_button(self, button)`¶

`set_prev_button(self, button)`¶

`set_scroll_down_button(self, button)`¶

`set_scroll_encoder(self, encoder)`¶

`set_scroll_up_button(self, button)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_clipboard_component_instances = [] - Built-in mutable sequence.
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x163a2a898>
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
num_layers = 0 - int([x]) -> integer
scroll_down_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163af0da0>
scroll_encoder = <ableton.v3.control_surface.controls.encoder.StepEncoderControl object at 0x163af0d30>
scroll_up_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163af0d68>
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 `ItemProvider(EventObject, Scrollable)`¶

Properties¶

has_valid_selection
items
selected_index
selected_item

Methods¶

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

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

`_on_items_changed(self)`¶

`_update_selected_index(self)`¶

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

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

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

`can_scroll_down(self)`¶

`can_scroll_up(self)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`items_has_listener(self, slot)`¶

`items_listener_count(self)`¶

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

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

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

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`remove_items_listener(self, slot)`¶

`remove_selected_index_listener(self, slot)`¶

`remove_selected_item_listener(self, slot)`¶

`scroll_down(self)`¶

`scroll_up(self)`¶

`selected_index_has_listener(self, slot)`¶

`selected_index_listener_count(self)`¶

`selected_item_has_listener(self, slot)`¶

`selected_item_listener_count(self)`¶

`unregister_disconnectable(self, slot)`¶

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

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

Attributes¶

include_in_top_level_state = True - bool(x) -> bool
renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

class `SlotGroup(EventObject)`¶

Methods¶

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

Call self as a function.

`init(self, listener=None, event_name=None, extra_kws=None, extra_args=None, *a, **k)`¶

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

`_listener_for_subject(self, identifier)`¶

`add_subject(self, subject, identifier=None)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`has_subject(self, subject)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`remove_subject(self, subject)`¶

`replace_subjects(self, subjects, identifiers=repeat(None))`¶

`unregister_disconnectable(self, slot)`¶

Attributes¶

_extra_args = None
_extra_kws = None
listener = None

class `chain`¶

chain(*iterables) --> chain object

Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

Methods¶

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

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

`from_iterable(...)`¶

chain.from_iterable(iterable) --> chain object

Alternate chain() constructor taking a single iterable argument that evaluates lazily.

ableton.v3.control_surface.components.device_navigation (runtime)¶

Functions¶

cast(typ, val)¶

depends(**dependencies)¶

find_parent_device(device)¶

flatten_device_chain(track_or_chain)¶

is_device_rack(device)¶

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

liveobj_changed(obj, other)¶

liveobj_valid(obj)¶

Classes¶

class DeviceNavigationComponent(ItemListComponent, Renderable)¶

Properties¶

Methods¶

__init__(self, name='Device_Navigation', device_provider=None, item_provider=None, *a, **k)¶

_add_child(self, component)¶

_create_event_handler(self, property_name)¶

_do_scroll_down(self)¶

_do_scroll_up(self)¶

_ensure_scroll_one_direction(self)¶

_get_layer_iterable(self)¶

_grab_all_layers(self)¶

_init_state_from_controls(self, renderable_state)¶

_init_state_from_listenable_properties(self, renderable_state)¶

_internal_on_enabled_changed(self)¶

_make_scroll_task(self, scroll_step)¶

_notify_device_selection(self, _)¶

_on_devices_scrolled(self)¶

_on_scroll_pressed(self, button, scroll_step, scroll_task)¶

_on_scroll_released(self, scroll_task)¶

_release_all_layers(self)¶

_select_device(self)¶

_set_enabled_recursive(self, enable)¶

_show_device_chain(self)¶

_update_device_selection(self)¶

_update_is_enabled(self)¶

_update_scroll_controls(self)¶

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

can_scroll_down(self)¶

can_scroll_up(self)¶

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

control_notifications_enabled(self)¶

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

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

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

scroll_down(self)¶

scroll_up(self)¶

set_enabled(self, enable)¶

set_next_button(self, button)¶

set_prev_button(self, button)¶

set_scroll_down_button(self, button)¶

set_scroll_encoder(self, encoder)¶

set_scroll_up_button(self, button)¶

suppress_notifications(self)¶

unregister_disconnectable(self, slot)¶

update(self)¶

Attributes¶

class FlattenedDeviceChain(ItemProvider)¶

Properties¶

`ableton.v3.control_surface.components.device_navigation` (runtime)¶

`cast(typ, val)`¶

`depends(**dependencies)`¶

`find_parent_device(device)`¶

`flatten_device_chain(track_or_chain)`¶

`is_device_rack(device)`¶

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

`liveobj_changed(obj, other)`¶

`liveobj_valid(obj)`¶

class `DeviceNavigationComponent(ItemListComponent, Renderable)`¶

`init(self, name='Device_Navigation', device_provider=None, item_provider=None, *a, **k)`¶

`_add_child(self, component)`¶

`_create_event_handler(self, property_name)`¶

`_do_scroll_down(self)`¶

`_do_scroll_up(self)`¶

`_ensure_scroll_one_direction(self)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`_internal_on_enabled_changed(self)`¶

`_make_scroll_task(self, scroll_step)`¶

`_notify_device_selection(self, _)`¶

`_on_devices_scrolled(self)`¶

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

`_on_scroll_released(self, scroll_task)`¶

`_release_all_layers(self)`¶

`_select_device(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_show_device_chain(self)`¶

`_update_device_selection(self)`¶

`_update_is_enabled(self)`¶

`_update_scroll_controls(self)`¶

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

`can_scroll_down(self)`¶

`can_scroll_up(self)`¶

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

`control_notifications_enabled(self)`¶

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

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

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

`scroll_down(self)`¶

`scroll_up(self)`¶

`set_enabled(self, enable)`¶

`set_next_button(self, button)`¶

`set_prev_button(self, button)`¶

`set_scroll_down_button(self, button)`¶

`set_scroll_encoder(self, encoder)`¶

`set_scroll_up_button(self, button)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

class `FlattenedDeviceChain(ItemProvider)`¶

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

`_on_items_changed(self)`¶

`_update_devices(self, *_)`¶

`_update_listeners(self)`¶

`_update_selected_index(self)`¶

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