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

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

Functions¶

`control_matrix(control_type, *a, **k)`¶

`depends(**dependencies)`¶

`get_bar_length(clip=None)`¶

`is_clip_playing(clip)`¶

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

`liveobj_changed(obj, other)`¶

`liveobj_valid(obj)`¶

`round_to_multiple(value, base)`¶

Classes¶

class `ButtonControl(ButtonControlBase)`¶

Properties¶

double_clicked
pressed
pressed_delayed
released
released_delayed
released_immediately
value

Methods¶

`State(color='DefaultButton.On', on_color=None, *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.
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 `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, is_private=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_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)`¶

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

`set_enabled(self, enable)`¶

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

LiveObjSkinEntry(name, liveobj)

Properties¶

liveobj - Alias for field number 1
name - Alias for field number 0

Methods¶

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

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

`_asdict(self)`¶

`_make(iterable)`¶

Make a new LiveObjSkinEntry object from a sequence or iterable

`_replace(_self, **kwds)`¶

Return a new LiveObjSkinEntry object replacing specified fields with new values

`count(self, value, /)`¶

Return number of occurrences of value.

`index(self, value, start=0, stop=9223372036854775807, /)`¶

Return first index of value.

Raises ValueError if the value is not present.

Attributes¶

_field_defaults = {} - dict() -> new empty dictionary
_field_types = OrderedDict([('name', <class 'str'>), ('liveobj', typing.Any)]) - Dictionary that remembers insertion order
_fields = ('name', 'liveobj') - Built-in immutable sequence.
_fields_defaults = {} - dict() -> new empty dictionary

class `LoopSelectorComponent(Component, Renderable)`¶

Properties¶

application
bar_length
clipboard
is_root
layer
min_page_time
parent
song

Methods¶

`init(self, name='Loop_Selector', target_track=None, sequencer_clip=None, paginator=None, clipboard_component_type=None, *a, **k)`¶

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

`_add_child(self, component)`¶

`_button_position(self, button_index)`¶

`_create_event_handler(self, property_name)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_has_clip(self)`¶

`_increment_page_time(self, delta)`¶

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`_internal_on_enabled_changed(self)`¶

`_on_clip_changed(self)`¶

`_on_matrix_pressed(self, button)`¶

`_on_page_time_changed_via_matrix(self)`¶

`_rectify_page_time(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_update_clipboard(self, button)`¶

`_update_is_enabled(self)`¶

`_update_matrix(self)`¶

`_update_matrix_button(self, button, selected, playing, inside_loop)`¶

`_update_page_buttons(self)`¶

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

`add_children(self, *children)`¶

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

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

`clipboard_has_listener(self, slot)`¶

`clipboard_listener_count(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_clipboard(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_clipboard_listener(self, slot)`¶

`remove_enabled_listener(self, slot)`¶

`set_clip(self, clip)`¶

`set_copy_button(self, button)`¶

`set_enabled(self, enable)`¶

`set_matrix(self, matrix)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_LoopSelectorComponent__on_playing_position_changed = None
_LoopSelectorComponent__on_playing_status_changed = None
_LoopSelectorComponent__on_sequencer_clip_changed = None
_LoopSelectorComponent__on_target_track_color_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
delete_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163b53940>
include_in_top_level_state = True - bool(x) -> bool
matrix = <ableton.v2.base.util.Mixin_MatrixControl_ButtonControl object at 0x163b539e8>
next_page_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163b538d0>
num_layers = 0 - int([x]) -> integer
prev_page_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163b53908>
renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

class `NoteRegionClipboardComponent(BufferedClipboardComponent)`¶

Properties¶

application
buffer
is_root
layer
parent
song

Methods¶

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

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

`_add_child(self, component)`¶

`_create_event_handler(self, property_name)`¶

`_do_copy(self, obj)`¶

`_do_paste(self, obj)`¶

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

`_is_source_valid(self)`¶

`_release_all_layers(self)`¶

`_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_has_content_listener(self, slot, identify_sender=False, *a, **k)`¶

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

`any_clipboard_has_content_has_listener(self, slot)`¶

`any_clipboard_has_content_listener_count(self)`¶

`append_buffer(self, obj)`¶

`clear(self, notify=False)`¶

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

`control_notifications_enabled(self)`¶

`copy(self, obj)`¶

`copy_or_paste(self, obj)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`dispatch_event(self, name: 'str', value)`¶

`enabled_has_listener(self, slot)`¶

`enabled_listener_count(self)`¶

`extend_buffer(self, obj)`¶

`find_disconnectable(self, predicate)`¶

`has_content_has_listener(self, slot)`¶

`has_content_listener_count(self)`¶

`has_disconnectable(self, slot)`¶

`is_copying_has_listener(self, slot)`¶

`is_copying_listener_count(self)`¶

`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_has_content(self, *a, **k)`¶

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

`on_enabled_changed(self)`¶

`paste(self, obj)`¶

`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_has_content_listener(self, slot)`¶

`remove_is_copying_listener(self, slot)`¶

`set_clip(self, clip)`¶

`set_copy_button(self, button)`¶

`set_enabled(self, enable)`¶

`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
copy_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163a6b0b8>
has_content = False - bool(x) -> bool
include_in_top_level_state = True - bool(x) -> bool
is_copying = False - bool(x) -> bool
num_layers = 0 - int([x]) -> integer
renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

class `OptionalSkinEntry(tuple)`¶

OptionalSkinEntry(name, fallback_name)

Properties¶

fallback_name - Alias for field number 1
name - Alias for field number 0

Methods¶

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

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

`_asdict(self)`¶

`_make(iterable)`¶

Make a new OptionalSkinEntry object from a sequence or iterable

`_replace(_self, **kwds)`¶

Return a new OptionalSkinEntry object replacing specified fields with new values

`count(self, value, /)`¶

Return number of occurrences of value.

`index(self, value, start=0, stop=9223372036854775807, /)`¶

Return first index of value.

Raises ValueError if the value is not present.

Attributes¶

_field_defaults = {'fallback_name': None} - dict() -> new empty dictionary
_field_types = OrderedDict([('name', <class 'str'>), ('fallback_name', typing.Union[str, NoneType])]) - Dictionary that remembers insertion order
_fields = ('name', 'fallback_name') - Built-in immutable sequence.
_fields_defaults = {} - 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)`¶

`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 `listenable_property(listenable_property_base, property)`¶

Property attribute.

fget function to be used for getting an attribute value fset function to be used for setting an attribute value fdel function to be used for del'ing an attribute doc docstring

Typical use is to define a managed attribute x:

class C(object): def getx(self): return self._x def setx(self, value): self._x = value def delx(self): del self._x x = property(getx, setx, delx, "I'm the 'x' property.")

Decorators make defining new properties or modifying existing ones easy:

class C(object): @property def x(self): "I am the 'x' property." return self._x @x.setter def x(self, value): self._x = value @x.deleter def x(self): del self._x

Methods¶

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

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

`deleter(...)`¶

Descriptor to change the deleter on a property.

`getter(...)`¶

Descriptor to change the getter on a property.

`managed(default_value)`¶

`set_property_name(self, name)`¶

`setter(...)`¶

Descriptor to change the setter on a property.

Attributes¶

fdel = <member 'fdel' of 'property' objects>
fget = <member 'fget' of 'property' objects>
fset = <member 'fset' of 'property' objects>

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

Functions¶

control_matrix(control_type, *a, **k)¶

depends(**dependencies)¶

get_bar_length(clip=None)¶

is_clip_playing(clip)¶

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

liveobj_changed(obj, other)¶

liveobj_valid(obj)¶

round_to_multiple(value, base)¶

Classes¶

class ButtonControl(ButtonControlBase)¶

Properties¶

Methods¶

State(color='DefaultButton.On', on_color=None, *a, **k)¶

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

_clear_state(self, manager)¶

_get_state(self, manager, state_factory=None)¶

_make_control_state(self, manager)¶

Attributes¶

class Component(ControlManager)¶

Properties¶

Methods¶

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

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

set_enabled(self, enable)¶

unregister_disconnectable(self, slot)¶

update(self)¶

Attributes¶

class LiveObjSkinEntry(tuple)¶

Properties¶

Methods¶

__init__(self, /, *args, **kwargs)¶

_asdict(self)¶

_make(iterable)¶

_replace(_self, **kwds)¶

count(self, value, /)¶

index(self, value, start=0, stop=9223372036854775807, /)¶

Attributes¶

class LoopSelectorComponent(Component, Renderable)¶

Properties¶

Methods¶

__init__(self, name='Loop_Selector', target_track=None, sequencer_clip=None, paginator=None, clipboard_component_type=None, *a, **k)¶

_add_child(self, component)¶

_button_position(self, button_index)¶

_create_event_handler(self, property_name)¶

_get_layer_iterable(self)¶

_grab_all_layers(self)¶

_has_clip(self)¶

_increment_page_time(self, delta)¶

_init_state_from_controls(self, renderable_state)¶

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

`control_matrix(control_type, *a, **k)`¶

`depends(**dependencies)`¶

`get_bar_length(clip=None)`¶

`is_clip_playing(clip)`¶

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

`liveobj_changed(obj, other)`¶

`liveobj_valid(obj)`¶

`round_to_multiple(value, base)`¶

class `ButtonControl(ButtonControlBase)`¶

`State(color='DefaultButton.On', on_color=None, *a, **k)`¶

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

`_clear_state(self, manager)`¶

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

`_make_control_state(self, manager)`¶

class `Component(ControlManager)`¶

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

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

`set_enabled(self, enable)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

class `LiveObjSkinEntry(tuple)`¶

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

`_asdict(self)`¶

`_make(iterable)`¶

`_replace(_self, **kwds)`¶

`count(self, value, /)`¶

`index(self, value, start=0, stop=9223372036854775807, /)`¶

class `LoopSelectorComponent(Component, Renderable)`¶

`init(self, name='Loop_Selector', target_track=None, sequencer_clip=None, paginator=None, clipboard_component_type=None, *a, **k)`¶

`_add_child(self, component)`¶

`_button_position(self, button_index)`¶

`_create_event_handler(self, property_name)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_has_clip(self)`¶

`_increment_page_time(self, delta)`¶

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`_internal_on_enabled_changed(self)`¶

`_on_clip_changed(self)`¶

`_on_matrix_pressed(self, button)`¶

`_on_page_time_changed_via_matrix(self)`¶

`_rectify_page_time(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_update_clipboard(self, button)`¶

`_update_is_enabled(self)`¶

`_update_matrix(self)`¶

`_update_matrix_button(self, button, selected, playing, inside_loop)`¶

`_update_page_buttons(self)`¶