Skip to content

ableton.v2.control_surface.components.device_navigation (runtime)

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

Functions

collect_devices(track_or_chain, nesting_level=0)

device_to_appoint(device)

first(seq)

index_if(predicate, seq)

is_empty_rack(rack)

listens(event_path, *a, **k)

liveobj_changed(obj, other)

liveobj_valid(obj)

nested_device_parent(device)

Classes

class DeviceNavigationComponent(ItemListerComponent)

Properties

  • application
  • is_root
  • item_offset
  • item_provider
  • items
  • layer
  • parent
  • selected_item
  • song

Methods

__init__(self, device_component=None, item_provider=None, *a, **k)

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

_add_child(self, component)
_adjust_offset(self)
_appoint_device(self, device)
_color_for_button(self, button_index, is_selected)
_create_slot(self, index, item, nesting_level)
_create_slots(self)
_current_track(self)
_do_select_item(self, device)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_items_equal(self, item, selected_item)
_on_items_changed(self)
_on_select_button_pressed(self, button)
_on_select_button_pressed_delayed(self, button)
_on_select_button_released(self, button)
_on_select_button_released_immediately(self, button)
_on_selection_changed(self)
_release_all_layers(self)
_restore_selection(self, selected_track)
_select_item(self, device_or_pad)
_set_enabled_recursive(self, enable)
_show_selected_item(self)
_tasks(self, parent_task_group=None)
_update_button_colors(self)
_update_device(self)
_update_is_enabled(self)
_update_item_provider(self, selection)
_update_selected_track(self)
add_children(self, *a)
add_control(self, name, control)
add_enabled_listener(self, slot, identify_sender=False, *a, **k)
add_items_listener(self, slot, identify_sender=False, *a, **k)
can_scroll_left(self)
can_scroll_right(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)
items_has_listener(self, slot)
items_listener_count(self)
notify_enabled(self, *a, **k)
notify_items(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)
remove_items_listener(self, slot)
reset_offset(self)
scroll_left(self)
scroll_right(self)
set_enabled(self, enable)
unregister_disconnectable(self, slot)
update(self)
update_items(self)

Attributes

  • _DeviceNavigationComponent__on_device_changed = None
  • _ItemListerComponentBase__on_items_changed = None
  • _ItemListerComponent__on_items_changed = None
  • _ItemListerComponent__on_selection_changed = None
  • _device_selection_in_track_changed = None
  • _has_task_group = False - bool(x) -> bool
  • _layer = None
  • _on_selected_track_changed = None
  • canonical_parent = None
  • color_class_name = 'ItemNavigation' - str(object='') -> str
  • is_private = False - bool(x) -> bool
  • name = '' - str(object='') -> str
  • scroll_left_layer = <ableton.v2.base.util.forward_property.<locals>.Descriptor object at 0x13c3ea9d0>
  • scroll_right_layer = <ableton.v2.base.util.forward_property.<locals>.Descriptor object at 0x13c3eaad0>
  • select_buttons = <ableton.v2.base.util.Mixin_ControlList_ButtonControl object at 0x13c3ea6d0>

class EventObject(CompoundDisconnectable)

Methods

__init__(self, *a, **k)

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

disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
unregister_disconnectable(self, slot)

class FlattenedDeviceChain(ItemProvider)

Properties

  • has_invalid_selection
  • items
  • selected_item

Methods

__init__(self, collect_devices_fun=<function collect_devices at 0x13c3d2340>, *a, **k)

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

_update_devices(self, *_)
_update_listeners(self)
add_items_listener(self, slot, identify_sender=False, *a, **k)
add_selected_item_listener(self, slot, identify_sender=False, *a, **k)
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_item(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_items_listener(self, slot)
remove_selected_item_listener(self, slot)
selected_item_has_listener(self, slot)
selected_item_listener_count(self)
set_device_parent(self, parent)
unregister_disconnectable(self, slot)

class ItemListerComponent(ItemListerComponentBase)

Properties

  • application
  • is_root
  • item_offset
  • item_provider
  • items
  • layer
  • parent
  • song

Methods

__init__(self, *a, **k)

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

_add_child(self, component)
_adjust_offset(self)
_color_for_button(self, button_index, is_selected)
_create_slot(self, index, item, nesting_level)
_create_slots(self)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_items_equal(self, item, selected_item)
_on_items_changed(self)
_on_select_button_pressed(self, button)
_on_select_button_pressed_delayed(self, button)
_on_select_button_released(self, button)
_on_select_button_released_immediately(self, button)
_on_selection_changed(self)
_release_all_layers(self)
_set_enabled_recursive(self, enable)
_tasks(self, parent_task_group=None)
_update_button_colors(self)
_update_is_enabled(self)
add_children(self, *a)
add_control(self, name, control)
add_enabled_listener(self, slot, identify_sender=False, *a, **k)
add_items_listener(self, slot, identify_sender=False, *a, **k)
can_scroll_left(self)
can_scroll_right(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)
items_has_listener(self, slot)
items_listener_count(self)
notify_enabled(self, *a, **k)
notify_items(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)
remove_items_listener(self, slot)
reset_offset(self)
scroll_left(self)
scroll_right(self)
set_enabled(self, enable)
unregister_disconnectable(self, slot)
update(self)
update_items(self)

Attributes

  • _ItemListerComponentBase__on_items_changed = None
  • _ItemListerComponent__on_items_changed = None
  • _ItemListerComponent__on_selection_changed = None
  • _has_task_group = False - bool(x) -> bool
  • _layer = None
  • canonical_parent = None
  • color_class_name = 'ItemNavigation' - str(object='') -> str
  • is_private = False - bool(x) -> bool
  • name = '' - str(object='') -> str
  • scroll_left_layer = <ableton.v2.base.util.forward_property.<locals>.Descriptor object at 0x13c3ea9d0>
  • scroll_right_layer = <ableton.v2.base.util.forward_property.<locals>.Descriptor object at 0x13c3eaad0>
  • select_buttons = <ableton.v2.base.util.Mixin_ControlList_ButtonControl object at 0x13c3ea6d0>

class ItemProvider(EventObject)

Properties

  • items
  • selected_item

Methods

__init__(self, *a, **k)

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

add_items_listener(self, slot, identify_sender=False, *a, **k)
add_selected_item_listener(self, slot, identify_sender=False, *a, **k)
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_item(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_items_listener(self, slot)
remove_selected_item_listener(self, slot)
selected_item_has_listener(self, slot)
selected_item_listener_count(self)
unregister_disconnectable(self, slot)

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(iterable, /)

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