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

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

Module constants¶

MAX_DRUM_GROUP_SCROLL_POSITION = 28

Functions¶

`liveobj_valid(obj)`¶

Classes¶

class `DrumGroupScrollComponent(PageComponent, Pageable, Renderable)`¶

Properties¶

application
is_root
layer
parent
position
song

Methods¶

`init(self, name='Drum_Group_Scroll', *a, **k)`¶

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

`_add_child(self, component)`¶

`_create_event_handler(self, property_name)`¶

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

`_release_all_layers(self)`¶

`_scroll_page(self, sign)`¶

`_scroll_position(self, delta)`¶

`_set_enabled_recursive(self, enable)`¶

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

`add_position_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_page_down(self)`¶

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

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

`on_enabled_changed(self)`¶

`position_has_listener(self, slot)`¶

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

`remove_position_listener(self, slot)`¶

`scroll_down(self)`¶

`scroll_page_down(self)`¶

`scroll_page_up(self)`¶

`scroll_up(self)`¶

`set_drum_group_device(self, drum_group_device)`¶

`set_enabled(self, enable)`¶

`set_scroll_down_button(self, button)`¶

`set_scroll_encoder(self, encoder)`¶

`set_scroll_page_down_button(self, button)`¶

`set_scroll_page_encoder(self, encoder)`¶

`set_scroll_page_up_button(self, button)`¶

`set_scroll_up_button(self, button)`¶

`suppress_notifications(self)`¶

`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
include_in_top_level_state = True - bool(x) -> bool
num_layers = 0 - int([x]) -> integer
page_length = 4 - int([x]) -> integer
page_offset = 1 - int([x]) -> integer
position_count = 32 - int([x]) -> integer
renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

class `PageComponent(Component, Scrollable)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

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

`_scroll_page(self, sign)`¶

`_scroll_position(self, delta)`¶

`_set_enabled_recursive(self, enable)`¶

`_update_is_enabled(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_page_down(self)`¶

`can_scroll_page_up(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_page_down(self)`¶

`scroll_page_up(self)`¶

`scroll_up(self)`¶

`set_enabled(self, enable)`¶

`set_scroll_down_button(self, button)`¶

`set_scroll_encoder(self, encoder)`¶

`set_scroll_page_down_button(self, button)`¶

`set_scroll_page_encoder(self, encoder)`¶

`set_scroll_page_up_button(self, button)`¶

`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

class `Pageable(EventObject)`¶

Methods¶

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

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

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

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

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

`position_has_listener(self, slot)`¶

`position_listener_count(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`remove_position_listener(self, slot)`¶

`unregister_disconnectable(self, slot)`¶

Attributes¶

page_length = NotImplemented
page_offset = NotImplemented
position = NotImplemented
position_count = NotImplemented

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>

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

Module constants¶

Functions¶

liveobj_valid(obj)¶

Classes¶

class DrumGroupScrollComponent(PageComponent, Pageable, Renderable)¶

Properties¶

Methods¶

__init__(self, name='Drum_Group_Scroll', *a, **k)¶

_add_child(self, component)¶

_create_event_handler(self, property_name)¶

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

_release_all_layers(self)¶

_scroll_page(self, sign)¶

_scroll_position(self, delta)¶

_set_enabled_recursive(self, enable)¶

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

add_position_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_page_down(self)¶

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

notify_position(self, *a, **k)¶

on_enabled_changed(self)¶

position_has_listener(self, slot)¶

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

remove_position_listener(self, slot)¶

scroll_down(self)¶

scroll_page_down(self)¶

scroll_page_up(self)¶

scroll_up(self)¶

set_drum_group_device(self, drum_group_device)¶

set_enabled(self, enable)¶

set_scroll_down_button(self, button)¶

set_scroll_encoder(self, encoder)¶

set_scroll_page_down_button(self, button)¶

set_scroll_page_encoder(self, encoder)¶

set_scroll_page_up_button(self, button)¶

set_scroll_up_button(self, button)¶

suppress_notifications(self)¶

unregister_disconnectable(self, slot)¶

update(self)¶

Attributes¶

class PageComponent(Component, Scrollable)¶

Properties¶

Methods¶

__init__(self, pageable=None, scroll_skin_name=None, *a, **k)¶

_add_child(self, component)¶

_get_layer_iterable(self)¶

_grab_all_layers(self)¶

_internal_on_enabled_changed(self)¶

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

`liveobj_valid(obj)`¶

class `DrumGroupScrollComponent(PageComponent, Pageable, Renderable)`¶

`init(self, name='Drum_Group_Scroll', *a, **k)`¶

`_add_child(self, component)`¶

`_create_event_handler(self, property_name)`¶

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

`_release_all_layers(self)`¶

`_scroll_page(self, sign)`¶

`_scroll_position(self, delta)`¶

`_set_enabled_recursive(self, enable)`¶

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

`add_position_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_page_down(self)`¶

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

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

`on_enabled_changed(self)`¶

`position_has_listener(self, slot)`¶

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

`remove_position_listener(self, slot)`¶

`scroll_down(self)`¶

`scroll_page_down(self)`¶

`scroll_page_up(self)`¶

`scroll_up(self)`¶

`set_drum_group_device(self, drum_group_device)`¶

`set_enabled(self, enable)`¶

`set_scroll_down_button(self, button)`¶

`set_scroll_encoder(self, encoder)`¶

`set_scroll_page_down_button(self, button)`¶

`set_scroll_page_encoder(self, encoder)`¶

`set_scroll_page_up_button(self, button)`¶

`set_scroll_up_button(self, button)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

class `PageComponent(Component, Scrollable)`¶

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

`_add_child(self, component)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_release_all_layers(self)`¶

`_scroll_page(self, sign)`¶

`_scroll_position(self, delta)`¶

`_set_enabled_recursive(self, enable)`¶

`_update_is_enabled(self)`¶

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

`add_children(self, *children)`¶

`add_control(self, name, control)`¶