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

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

Functions¶

`calculate_page_points(page_length, bar_length)`¶

`get_adjusted_step_count(clip, page_time, page_length, step_length, default_step_count=16)`¶

`get_bar_length(clip=None)`¶

`get_relative_page_time(current_page_time, page_length, bar_length, delta)`¶

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

`liveobj_valid(obj)`¶

`memoize(function)`¶

`normalize_page_time(page_time, bar_length)`¶

`round_to_multiple(value, base)`¶

Classes¶

class `LoopSelectorComponent(LoopSelectorComponent)`¶

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

`_notify_page_time(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 `LoopSelectorComponentBase(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 `NamedTuple`¶

Methods¶

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

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

Attributes¶

_root = True - bool(x) -> bool

class `NoteEditorComponent(NoteEditorComponent)`¶

Properties¶

active_steps
application
can_change_page
clipboard
height
is_root
layer
page_length
page_time
parent
pitch_provider
song
step_count
step_length
width

Methods¶

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

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

`_add_child(self, component)`¶

`_add_new_note_in_step(self, pitch, time)`¶

`_add_note_in_step(self, step, pitch)`¶

`_adjust_step_count(self)`¶

`_can_edit(self)`¶

`_can_press_or_release_step(self, step)`¶

`_create_event_handler(self, property_name)`¶

`_delete_notes_in_step(self, step)`¶

`_get_alternate_color_for_step(self, index, visible_steps)`¶

`_get_clip_notes_time_range(self)`¶

`_get_color_for_step(self, index, visible_steps)`¶

`_get_layer_iterable(self)`¶

`_get_notes_info_from_step(self, step)`¶

`_get_property_range_string(self, property_name, value_range_fn, str_fmt=<built-in method format of str object at 0x163b21c00>)`¶

`_get_step_offset_range_string(self, property_name)`¶

`_get_step_start_time(self, step)`¶

`_get_step_time_range(self, step)`¶

`_grab_all_layers(self)`¶

`_has_clip(self)`¶

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`_internal_on_enabled_changed(self)`¶

`_modify_duration(time_step, duration_offset, note)`¶

`_modify_note(self, time_step, duration_offset, nudge_offset, note)`¶

`_modify_note_property(self, note_property, value)`¶

`_modify_step_notes(self, steps)`¶

`_on_pad_pressed(self, pad)`¶

`_on_pad_released(self, pad, **k)`¶

`_on_release_step(self, step, can_add_or_remove=False)`¶

`_refresh_active_steps(self)`¶

`_release_active_steps(self)`¶

`_release_all_layers(self)`¶

`_reset_modifications(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_time_step(self, time)`¶

`_update_clipboard(self, pad)`¶

`_update_editor_matrix(self)`¶

`_update_from_grid(self)`¶

`_update_is_enabled(self)`¶

`_visible_steps(self)`¶

`active_steps_has_listener(self, slot)`¶

`active_steps_listener_count(self)`¶

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

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

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

`add_children(self, *children)`¶

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

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

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

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

`adjusted_step_count_has_listener(self, slot)`¶

`adjusted_step_count_listener_count(self)`¶

`any_clipboard_has_content_has_listener(self, slot)`¶

`any_clipboard_has_content_listener_count(self)`¶

`can_nudge_by_offset(self, offset)`¶

`clip_notes_has_listener(self, slot)`¶

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

`get_duration_fine_range_string(self)`¶

`get_duration_range_string(self)`¶

`get_note_property_ranges(self)`¶

`get_nudge_offset_range_string(self)`¶

`get_velocity_range_string(self)`¶

`has_disconnectable(self, slot)`¶

`is_enabled(self, explicit=False)`¶

`is_pitch_active(self, pitch)`¶

`notify(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')`¶

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

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

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

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

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

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

`notify_page_length(self)`¶

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

`on_enabled_changed(self)`¶

`page_length_has_listener(self, slot)`¶

`page_length_listener_count(self)`¶

`page_time_changed(self)`¶

`pitch_provider_has_listener(self, slot)`¶

`pitch_provider_listener_count(self)`¶

`register_clipboard(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`remove_active_steps_listener(self, slot)`¶

`remove_adjusted_step_count_listener(self, slot)`¶

`remove_any_clipboard_has_content_listener(self, slot)`¶

`remove_clip_notes_listener(self, slot)`¶

`remove_clipboard_listener(self, slot)`¶

`remove_enabled_listener(self, slot)`¶

`remove_page_length_listener(self, slot)`¶

`remove_pitch_provider_listener(self, slot)`¶

`set_clip(self, clip)`¶

`set_copy_button(self, button)`¶

`set_duration_offset(self, value)`¶

`set_enabled(self, enable)`¶

`set_matrix(self, matrix)`¶

`set_nudge_offset(self, value)`¶

`set_pitch_offset(self, value)`¶

`set_pitches(self, pitches)`¶

`set_velocity_offset(self, value)`¶

`suppress_notifications(self)`¶

`toggle_pitch_for_all_active_steps(self, pitch)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_NoteEditorComponent__on_clip_notes_changed = None
_NoteEditorComponent__on_provided_pitches_changed = None
_NoteEditorComponent__on_provider_polyphony_changed = None
_NoteEditorComponent__on_resolution_changed = None
_NoteEditorComponent__on_sequencer_clip_changed = None
_NoteEditorComponent__on_target_track_color_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x163a2a898>
adjusted_step_count = 0 - int([x]) -> integer
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
include_in_top_level_state = True - bool(x) -> bool
matrix = <ableton.v2.base.util.Mixin_MatrixControl_StepButtonControl object at 0x163b33470>
num_layers = 0 - int([x]) -> integer
renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

class `NoteEditorComponentBase(Component, Renderable)`¶

Properties¶

active_steps
application
can_change_page
clipboard
height
is_root
layer
page_length
page_time
parent
pitch_provider
song
step_count
step_length
width

Methods¶

`init(self, name='Note_Editor', translation_channel=1, full_velocity=None, target_track=None, sequencer_clip=None, grid_resolution=None, clipboard_component_type=None, *a, **k)`¶

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

`_add_child(self, component)`¶

`_add_new_note_in_step(self, pitch, time)`¶

`_add_note_in_step(self, step, pitch)`¶

`_can_edit(self)`¶

`_can_press_or_release_step(self, step)`¶

`_create_event_handler(self, property_name)`¶

`_delete_notes_in_step(self, step)`¶

`_get_alternate_color_for_step(self, index, visible_steps)`¶

`_get_clip_notes_time_range(self)`¶

`_get_color_for_step(self, index, visible_steps)`¶

`_get_layer_iterable(self)`¶

`_get_notes_info_from_step(self, step)`¶

`_get_property_range_string(self, property_name, value_range_fn, str_fmt=<built-in method format of str object at 0x163b21c00>)`¶

`_get_step_offset_range_string(self, property_name)`¶

`_get_step_start_time(self, step)`¶

`_get_step_time_range(self, step)`¶

`_grab_all_layers(self)`¶

`_has_clip(self)`¶

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`_internal_on_enabled_changed(self)`¶

`_modify_duration(time_step, duration_offset, note)`¶

`_modify_note(self, time_step, duration_offset, nudge_offset, note)`¶

`_modify_note_property(self, note_property, value)`¶

`_modify_step_notes(self, steps)`¶

`_on_pad_pressed(self, pad)`¶

`_on_pad_released(self, pad, **k)`¶

`_on_release_step(self, step, can_add_or_remove=False)`¶

`_refresh_active_steps(self)`¶

`_release_active_steps(self)`¶

`_release_all_layers(self)`¶

`_reset_modifications(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_time_step(self, time)`¶

`_update_clipboard(self, pad)`¶

`_update_editor_matrix(self)`¶

`_update_from_grid(self)`¶

`_update_is_enabled(self)`¶

`_visible_steps(self)`¶

`active_steps_has_listener(self, slot)`¶

`active_steps_listener_count(self)`¶

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

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

`add_children(self, *children)`¶

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

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

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

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

`any_clipboard_has_content_has_listener(self, slot)`¶

`any_clipboard_has_content_listener_count(self)`¶

`can_nudge_by_offset(self, offset)`¶

`clip_notes_has_listener(self, slot)`¶

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

`get_duration_fine_range_string(self)`¶

`get_duration_range_string(self)`¶

`get_note_property_ranges(self)`¶

`get_nudge_offset_range_string(self)`¶

`get_velocity_range_string(self)`¶

`has_disconnectable(self, slot)`¶

`is_enabled(self, explicit=False)`¶

`is_pitch_active(self, pitch)`¶

`notify(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')`¶

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

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

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

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

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

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

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

`on_enabled_changed(self)`¶

`page_length_has_listener(self, slot)`¶

`page_length_listener_count(self)`¶

`page_time_changed(self)`¶

`pitch_provider_has_listener(self, slot)`¶

`pitch_provider_listener_count(self)`¶

`register_clipboard(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`remove_active_steps_listener(self, slot)`¶

`remove_any_clipboard_has_content_listener(self, slot)`¶

`remove_clip_notes_listener(self, slot)`¶

`remove_clipboard_listener(self, slot)`¶

`remove_enabled_listener(self, slot)`¶

`remove_page_length_listener(self, slot)`¶

`remove_pitch_provider_listener(self, slot)`¶

`set_clip(self, clip)`¶

`set_copy_button(self, button)`¶

`set_duration_offset(self, value)`¶

`set_enabled(self, enable)`¶

`set_matrix(self, matrix)`¶

`set_nudge_offset(self, value)`¶

`set_pitch_offset(self, value)`¶

`set_pitches(self, pitches)`¶

`set_velocity_offset(self, value)`¶

`suppress_notifications(self)`¶

`toggle_pitch_for_all_active_steps(self, pitch)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_NoteEditorComponent__on_clip_notes_changed = None
_NoteEditorComponent__on_provided_pitches_changed = None
_NoteEditorComponent__on_provider_polyphony_changed = None
_NoteEditorComponent__on_resolution_changed = None
_NoteEditorComponent__on_sequencer_clip_changed = None
_NoteEditorComponent__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
include_in_top_level_state = True - bool(x) -> bool
matrix = <ableton.v2.base.util.Mixin_MatrixControl_StepButtonControl object at 0x163b33470>
num_layers = 0 - int([x]) -> integer
renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

class `PagePoint(tuple)`¶

PagePoint(page_num, prev_page, next_page)

Properties¶

distances
next_page - Alias for field number 2
page_num - Alias for field number 0
prev_page - Alias for field number 1

Methods¶

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

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

`_asdict(self)`¶

`_make(iterable)`¶

Make a new PagePoint object from a sequence or iterable

`_replace(_self, **kwds)`¶

Return a new PagePoint 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([('page_num', <class 'int'>), ('prev_page', <class 'float'>), ('next_page', <class 'float'>)]) - Dictionary that remembers insertion order
_fields = ('page_num', 'prev_page', 'next_page') - Built-in immutable sequence.
_fields_defaults = {} - dict() -> new empty dictionary

class `PlayheadComponent(PlayheadComponent)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

`init(self, *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)`¶

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

`set_note_editor(self, note_editor)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_PlayheadComponent__on_sequencer_clip_playing_status_changed = None
_PlayheadComponent__on_step_count_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
num_layers = 0 - int([x]) -> integer

class `PlayheadComponentBase(Component)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

`init(self, name='Playhead', playhead=None, sequencer_clip=None, grid_resolution=None, paginator=None, notes=None, triplet_notes=None, channels=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)`¶

`_set_enabled_recursive(self, enable)`¶

`_update_is_enabled(self)`¶

`_update_playhead_notes(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¶

_PlayheadComponent__on_sequencer_clip_playing_status_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
num_layers = 0 - int([x]) -> integer

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.bar_based_sequence (runtime)¶

Functions¶

calculate_page_points(page_length, bar_length)¶

get_adjusted_step_count(clip, page_time, page_length, step_length, default_step_count=16)¶

get_bar_length(clip=None)¶

get_relative_page_time(current_page_time, page_length, bar_length, delta)¶

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

liveobj_valid(obj)¶

memoize(function)¶

normalize_page_time(page_time, bar_length)¶

round_to_multiple(value, base)¶

Classes¶

class LoopSelectorComponent(LoopSelectorComponent)¶

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

_init_state_from_listenable_properties(self, renderable_state)¶

_internal_on_enabled_changed(self)¶

_notify_page_time(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¶

class LoopSelectorComponentBase(Component, Renderable)¶

Properties¶

Methods¶

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

`calculate_page_points(page_length, bar_length)`¶

`get_adjusted_step_count(clip, page_time, page_length, step_length, default_step_count=16)`¶

`get_bar_length(clip=None)`¶

`get_relative_page_time(current_page_time, page_length, bar_length, delta)`¶

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

`liveobj_valid(obj)`¶

`memoize(function)`¶

`normalize_page_time(page_time, bar_length)`¶

`round_to_multiple(value, base)`¶

class `LoopSelectorComponent(LoopSelectorComponent)`¶

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

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

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