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

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

Module constants¶

NUM_BANK_SELECT_BUTTONS = 8

Functions¶

`cast(typ, val)`¶

`ceil(x, /)`¶

Return the ceiling of x as an Integral.

This is the smallest integer >= x.

`depends(**dependencies)`¶

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

Classes¶

class `DeviceBankNavigationComponent(ScrollComponent, Renderable, Scrollable)`¶

Properties¶

application
bank_provider
is_root
layer
parent
scrollable
song

Methods¶

`init(self, name='Device_Bank_Navigation', banking_info=None, device_bank_registry=None, *a, **k)`¶

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

`_add_child(self, component)`¶

`_adjusted_bank_count(self)`¶

`_can_use_roundtrip_banking(self)`¶

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

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

`_on_scroll_released(self, scroll_task)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_should_skip_first_bank(self)`¶

`_sync_registry(self)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_bank_select_buttons(self)`¶

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

`renderable_state(self)`¶

`scroll_down(self)`¶

`scroll_up(self)`¶

`set_bank_scroll_encoder(self, encoder)`¶

`set_bank_select_buttons(self, buttons)`¶

`set_enabled(self, enable)`¶

`set_next_bank_button(self, button)`¶

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

_DeviceBankNavigationComponent__on_parameters_changed_in_device = None
_DeviceBankNavigationComponent__on_provider_bank_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
bank_select_buttons = <ableton.v3.control_surface.controls.control_list.FixedRadioButtonGroup object at 0x13c7a3650>
canonical_parent = None
include_in_top_level_state = True - bool(x) -> bool
num_layers = 0 - int([x]) -> integer
scroll_down_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c7b05d0>
scroll_encoder = <ableton.v3.control_surface.controls.encoder.StepEncoderControl object at 0x13c7b0490>
scroll_up_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c7b0590>
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 `FixedRadioButtonGroup(RadioButtonGroup)`¶

Properties¶

checked
double_clicked
pressed
pressed_delayed
released
released_delayed
released_immediately
value

Methods¶

`State(*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.
DYNAMIC_CONTROL_COUNT = None
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 `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)`¶

`renderable_state(self)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

Attributes¶

include_in_top_level_state = True - bool(x) -> bool

class `ScrollComponent(Component, Scrollable)`¶

Properties¶

application
is_root
layer
parent
scrollable
song

Methods¶

`init(self, scrollable=None, scroll_skin_name=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)`¶

`_tasks(self, parent_task_group=None)`¶

`_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_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.
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 0x13c7b05d0>
scroll_encoder = <ableton.v3.control_surface.controls.encoder.StepEncoderControl object at 0x13c7b0490>
scroll_up_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c7b0590>
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()`¶

`can_scroll_up()`¶

Attributes¶

scroll_down = NotImplemented
scroll_up = NotImplemented

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

Module constants¶

Functions¶

cast(typ, val)¶

ceil(x, /)¶

depends(**dependencies)¶

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

Classes¶

class DeviceBankNavigationComponent(ScrollComponent, Renderable, Scrollable)¶

Properties¶

Methods¶

__init__(self, name='Device_Bank_Navigation', banking_info=None, device_bank_registry=None, *a, **k)¶

_add_child(self, component)¶

_adjusted_bank_count(self)¶

_can_use_roundtrip_banking(self)¶

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

_on_scroll_pressed(self, button, scroll_step, scroll_task)¶

_on_scroll_released(self, scroll_task)¶

_release_all_layers(self)¶

_set_enabled_recursive(self, enable)¶

_should_skip_first_bank(self)¶

_sync_registry(self)¶

_tasks(self, parent_task_group=None)¶

_update_bank_select_buttons(self)¶

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

renderable_state(self)¶

scroll_down(self)¶

scroll_up(self)¶

set_bank_scroll_encoder(self, encoder)¶

set_bank_select_buttons(self, buttons)¶

set_enabled(self, enable)¶

set_next_bank_button(self, button)¶

set_prev_bank_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 FixedRadioButtonGroup(RadioButtonGroup)¶

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

`cast(typ, val)`¶

`ceil(x, /)`¶

`depends(**dependencies)`¶

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

class `DeviceBankNavigationComponent(ScrollComponent, Renderable, Scrollable)`¶

`init(self, name='Device_Bank_Navigation', banking_info=None, device_bank_registry=None, *a, **k)`¶

`_add_child(self, component)`¶

`_adjusted_bank_count(self)`¶

`_can_use_roundtrip_banking(self)`¶

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

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

`_on_scroll_released(self, scroll_task)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_should_skip_first_bank(self)`¶

`_sync_registry(self)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_bank_select_buttons(self)`¶

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

`renderable_state(self)`¶

`scroll_down(self)`¶

`scroll_up(self)`¶

`set_bank_scroll_encoder(self, encoder)`¶

`set_bank_select_buttons(self, buttons)`¶

`set_enabled(self, enable)`¶

`set_next_bank_button(self, button)`¶

`set_prev_bank_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 `FixedRadioButtonGroup(RadioButtonGroup)`¶

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

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

`_clear_state(self, manager)`¶

`_get_state(self, manager, state_factory=None)`¶

`_make_control_state(self, manager)`¶

class `Renderable(CompoundDisconnectable)`¶