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

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

Module constants¶

DEFAULT_DRUM_TRANSLATION_CHANNEL = 15
DEFAULT_SIMPLER_TRANSLATION_CHANNEL = 14
DEFAULT_STEP_TRANSLATION_CHANNEL = 1
GRID_RESOLUTIONS = (GridResolution(name='1/32t', step_length=0.08333333333333333, grid=Clip.GridQuantization.g_thirtysecond, is_triplet=True), GridResolution(name='1/32', step_len...

Functions¶

`create_sequencer_clip(track, slot=None, length=None)`¶

Classes¶

class `AccentComponent(Component, Renderable)`¶

Properties¶

activated
application
is_root
layer
parent
song

Methods¶

`init(self, name='Accent', full_velocity=None, *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)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_is_enabled(self)`¶

`activated_has_listener(self, slot)`¶

`activated_listener_count(self)`¶

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

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

`remove_any_clipboard_has_content_listener(self, slot)`¶

`remove_enabled_listener(self, slot)`¶

`renderable_state(self)`¶

`set_enabled(self, enable)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_clipboard_component_instances = [] - Built-in mutable sequence.
accent_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c6e9d90>
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

class `ActiveParameterComponent(Component, Renderable)`¶

Properties¶

application
is_root
layer
parameter
parent
song

Methods¶

`init(self, name='Active_Parameter', timeout=0.75, *a, **k)`¶

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

`_add_child(self, component)`¶

`_cancel_release_task(self, index)`¶

`_clear_release_task(self, index)`¶

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

`_on_pressed_touch_elements_changed(self)`¶

`_on_touch_control_release(self, index)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

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

`any_clipboard_has_content_has_listener(self, slot)`¶

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

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

`on_enabled_changed(self)`¶

`parameter_has_listener(self, slot)`¶

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

`renderable_state(self)`¶

`set_enabled(self, enable)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_ActiveParameterComponent__on_touch_control_parameter_assignment_changed = None
_ActiveParameterComponent__on_touch_control_parameter_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
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
touch_controls = <ableton.v2.base.util.Mixin_MatrixControl_TouchControl object at 0x13c6ea810>

class `ArmedTargetTrackComponent(TargetTrackComponent)`¶

Properties¶

application
is_locked_to_track
is_root
layer
parent
song
target_clip
target_track

Methods¶

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

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

`_refresh_armed_track_list(self)`¶

`_release_all_layers(self)`¶

`_selected_track_changed(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_set_target_track(self)`¶

`_target_clip_from_arrangement(self)`¶

`_target_clip_from_session(self)`¶

`_tasks(self, parent_task_group=None)`¶

`_tracks(self)`¶

`_update_is_enabled(self)`¶

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

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

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

`any_clipboard_has_content_has_listener(self, slot)`¶

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

`is_locked_to_track_has_listener(self, slot)`¶

`is_locked_to_track_listener_count(self)`¶

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

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

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

`remove_is_locked_to_track_listener(self, slot)`¶

`remove_target_clip_listener(self, slot)`¶

`remove_target_track_listener(self, slot)`¶

`renderable_state(self)`¶

`set_enabled(self, enable)`¶

`suppress_notifications(self)`¶

`target_clip_has_listener(self, slot)`¶

`target_clip_listener_count(self)`¶

`target_track_has_listener(self, slot)`¶

`target_track_listener_count(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_ArmedTargetTrackComponent__on_arm_changed = None
_ArmedTargetTrackComponent__on_frozen_state_changed = None
_ArmedTargetTrackComponent__on_tracks_changed = None
_TargetTrackComponent__on_target_clip_slot_has_clip_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
include_in_top_level_state = True - bool(x) -> bool
lock_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c96e8d0>
num_layers = 0 - int([x]) -> integer

class `AutoArmComponent(Component)`¶

Properties¶

application
is_root
layer
needs_restore_auto_arm
parent
song

Methods¶

`init(self, name='Auto_Arm', target_track=None, *a, **k)`¶

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

`_add_child(self, component)`¶

`_auto_arm_target_changed(self, target_track)`¶

`_can_auto_arm(self)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_release_all_layers(self)`¶

`_set_auto_arm_state(self, state)`¶

`_set_enabled_recursive(self, enable)`¶

`_setup_new_auto_arm_target(self, target_track)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_auto_arm(self)`¶

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

_AutoArmComponent__on_arm_changed = None
_AutoArmComponent__on_frozen_state_changed = None
_AutoArmComponent__on_implicit_arm_changed = None
_AutoArmComponent__on_input_routing_type_changed = None
_AutoArmComponent__on_tracks_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
num_layers = 0 - int([x]) -> integer

class `BackgroundComponent(Component)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

`init(self, name='Background', control_type=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_element_for_control(self, name, element)`¶

`_set_enabled_recursive(self, enable)`¶

`_setup_control_state(self, name, control_state)`¶

`_tasks(self, parent_task_group=None)`¶

`_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.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
num_layers = 0 - int([x]) -> integer

class `BasicRecordingMethod(RecordingMethod)`¶

Helper class that provides a standard way to create an ABC using inheritance.

Methods¶

`init(self, song=None, target_track=None, *a, **k)`¶

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

`can_record_into_clip_slot(clip_slot)`¶

`start_recording(self, *_)`¶

`stop_recording(self)`¶

`trigger_recording(self)`¶

Attributes¶

_abc_impl = <_abc._abc_data object at 0x13c934380> - Internal state held by ABC machinery.

class `BufferedClipboardComponent(ClipboardComponent)`¶

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

`_tasks(self, parent_task_group=None)`¶

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

`renderable_state(self)`¶

`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.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
copy_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c711d50>
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

class `ChannelStripComponent(Component, Renderable)`¶

Properties¶

application
is_root
layer
parent
song
track

Methods¶

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

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

`_add_child(self, component)`¶

`_all_controls(self)`¶

`_connect_parameters(self)`¶

`_connect_send_parameters(self, send_controls)`¶

`_create_event_handler(self, property_name)`¶

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

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_arm_button(self)`¶

`_update_crossfade_cycle_button(self)`¶

`_update_is_enabled(self)`¶

`_update_mute_button(self)`¶

`_update_solo_button(self)`¶

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

`other_arm_buttons_pressed(strip)`¶

`other_solo_buttons_pressed(strip)`¶

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

`set_enabled(self, enable)`¶

`set_indexed_send_control(self, control_element, index)`¶

`set_track(self, track)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_active_instances = [] - Built-in mutable sequence.
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
arm_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c703110>
canonical_parent = None
crossfade_cycle_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c7031d0>
include_in_top_level_state = False - bool(x) -> bool
indexed_send_controls = <ableton.v2.base.util.Mixin_ControlList_MappedControl object at 0x11af7f7d0>
mute_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c702fd0>
num_layers = 0 - int([x]) -> integer
pan_control = <ableton.v2.control_surface.control.mapped.MappedControl object at 0x13c701990>
send_controls = <ableton.v2.base.util.Mixin_ControlList_MappedControl object at 0x13c701a10>
shift_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c703290>
solo_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c703050>
track_select_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c702ed0>
volume_control = <ableton.v2.control_surface.control.mapped.MappedControl object at 0x13c701950>

class `ClipActionsComponent(Component, Renderable)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

`init(self, name='Clip_Actions', target_track=None, *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)`¶

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

`_quantize_clip(self, clip)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_action_buttons(self)`¶

`_update_delete_button(self)`¶

`_update_double_button(self)`¶

`_update_duplicate_button(self)`¶

`_update_is_enabled(self)`¶

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

`set_enabled(self, enable)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_ClipActionsComponent__on_record_quantization_changed = None
_ClipActionsComponent__on_target_clip_playing_status_changed = None
_ClipActionsComponent__on_target_clip_recording_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
delete_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x11af506d0>
double_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c703890>
duplicate_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c703950>
include_in_top_level_state = True - bool(x) -> bool
num_layers = 0 - int([x]) -> integer
quantize_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c703a10>

class `ClipSlotClipboardComponent(ClipboardComponent)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

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

`_tasks(self, parent_task_group=None)`¶

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

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

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

`renderable_state(self)`¶

`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.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
copy_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c711d50>
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

class `ClipSlotComponent(Component, Renderable)`¶

Properties¶

application
clip_slot
is_root
layer
parent
song

Methods¶

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

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

`_add_child(self, component)`¶

`_any_modifier_pressed(self)`¶

`_create_event_handler(self, property_name)`¶

`_do_launch_slot(self)`¶

`_feedback_value(self, track, slot_or_clip)`¶

`_get_layer_iterable(self)`¶

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

`_is_copying(self)`¶

`_on_launch_button_pressed(self)`¶

`_on_launch_button_released(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_triggered_color(slot_or_clip, is_clip)`¶

`_update_clip_property_slots(self, update_launch_button=True)`¶

`_update_is_enabled(self)`¶

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

`set_clip_slot(self, clip_slot)`¶

`set_enabled(self, enable)`¶

`set_launch_button(self, button)`¶

`set_non_player_track(self, track)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_ClipSlotComponent__on_slot_triggered_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
delete_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c710e10>
duplicate_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c710ed0>
include_in_top_level_state = False - bool(x) -> bool
launch_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c710c10>
num_layers = 0 - int([x]) -> integer
select_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c710d10>

class `ClipboardComponent(Component, Renderable)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

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

`_tasks(self, parent_task_group=None)`¶

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

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

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

`renderable_state(self)`¶

`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.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
copy_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c711d50>
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

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 `DeviceComponent(ParameterProvider, Component, Renderable)`¶

Properties¶

application
bank_index
bank_name
device
is_root
layer
parameters
parent
song

Methods¶

`init(self, name='Device', continuous_parameter_sensitivity=1.0, quantized_parameter_sensitivity=0.1, parameters_component_type=None, bank_size=8, bank_definitions=None, bank_navigation_component_type=None, device_provider=None, device_bank_registry=None, device_decorator_factory=None, toggle_lock=None, show_message=None, *a, **k)`¶

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

`_add_child(self, component)`¶

`_create_event_handler(self, property_name)`¶

`_create_parameter_info(self, parameter, name)`¶

`_current_bank_details(self)`¶

`_disconnect_decorated_device(self)`¶

`_get_decorated_device(self, device)`¶

`_get_layer_iterable(self)`¶

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

`_on_device_changed(self, device)`¶

`_on_device_on_off_pressed(self)`¶

`_release_all_layers(self)`¶

`_set_bank_index(self, bank)`¶

`_set_decorated_device(self, decorated_device)`¶

`_set_device(self, device)`¶

`_set_enabled_recursive(self, enable)`¶

`_setup_bank(self, device, bank_factory=<function create_parameter_bank at 0x13c618360>)`¶

`_show_device_and_bank_info(self)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_device_lock_button(self)`¶

`_update_is_enabled(self)`¶

`_update_parameters(self)`¶

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

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

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

`add_children(self, *children)`¶

`add_control(self, name, control)`¶

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

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

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

`any_clipboard_has_content_has_listener(self, slot)`¶

`any_clipboard_has_content_listener_count(self)`¶

`bank_index_has_listener(self, slot)`¶

`bank_index_listener_count(self)`¶

`bank_name_has_listener(self, slot)`¶

`bank_name_listener_count(self)`¶

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

`control_notifications_enabled(self)`¶

`device_has_listener(self, slot)`¶

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

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

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

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

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

`on_enabled_changed(self)`¶

`parameters_has_listener(self, slot)`¶

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

`remove_bank_name_listener(self, slot)`¶

`remove_device_listener(self, slot)`¶

`remove_enabled_listener(self, slot)`¶

`remove_parameters_listener(self, slot)`¶

`renderable_state(self)`¶

`set_enabled(self, enable)`¶

`set_parameter_controls(self, controls)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_DeviceComponent__on_bank_changed = None
_DeviceComponent__on_bank_parameters_changed = None
_DeviceComponent__on_is_showing_chain_devices_changed = None
_DeviceComponent__on_parameters_changed_in_device = None
_DeviceComponent__on_provided_device_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
device_fold_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c713890>
device_lock_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c7b0e50>
device_on_off_button = <ableton.v3.control_surface.controls.mapped.MappedButtonControl object at 0x13c73fed0>
include_in_top_level_state = True - bool(x) -> bool
num_layers = 0 - int([x]) -> integer

class `DeviceNavigationComponent(ItemListComponent, Renderable)`¶

Properties¶

application
is_root
layer
parent
scrollable
song

Methods¶

`init(self, name='Device_Navigation', device_provider=None, item_provider=None, *a, **k)`¶

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

`_add_child(self, component)`¶

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

`_on_devices_scrolled(self)`¶

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

`_on_scroll_released(self, scroll_task)`¶

`_release_all_layers(self)`¶

`_select_device(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_show_device_chain(self)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_device_selection(self)`¶

`_update_is_enabled(self)`¶

`_update_scroll_controls(self)`¶

`_update_track_selection(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_enabled(self, enable)`¶

`set_next_button(self, button)`¶

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

_DeviceNavigationComponent__on_selected_device_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
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
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 `DeviceParametersComponent(Component)`¶

Properties¶

application
is_root
layer
parameter_provider
parent
song

Methods¶

`init(self, parameter_provider=None, name='Device_Parameters', *a, **k)`¶

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

`_add_child(self, component)`¶

`_connect_parameters(self)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_is_enabled(self)`¶

`_update_parameters(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_parameter_controls(self, encoders)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_DeviceParametersComponent__on_parameters_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
controls = <ableton.v2.base.util.Mixin_ControlList_MappedSensitivitySettingControl object at 0x13c7b0f10>
num_layers = 0 - int([x]) -> integer

class `DrumGroupComponent(PlayableComponent, PitchProvider, Renderable)`¶

Properties¶

application
assigned_drum_pads
clipboard
has_assigned_drum_pads
height
is_root
layer
parent
song
width

Methods¶

`init(self, name='Drum_Group', translation_channel=15, set_pad_translations=None, target_track=None, scroll_component_type=None, clipboard_component_type=None, *a, **k)`¶

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

`_add_child(self, component)`¶

`_any_modifier_pressed(self)`¶

`_button_coordinates_to_pad_index(self, first_note, coordinates)`¶

`_button_should_be_enabled(self, button)`¶

`_can_set_pad_translations(self)`¶

`_color_for_pad(self, pad)`¶

`_create_and_set_pad_translations(self)`¶

`_create_event_handler(self, property_name)`¶

`_do_delete_pad(self, pad, pad_name)`¶

`_do_mute_pad(self, pad, pad_name)`¶

`_do_select_pad(self, pad, pad_name)`¶

`_do_solo_pad(self, pad, pad_name)`¶

`_filled_color(pad)`¶

`_get_layer_iterable(self)`¶

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

`_note_translation_for_button(self, button)`¶

`_on_matrix_pressed(self, button)`¶

`_on_matrix_released(self, button)`¶

`_pad_for_button(self, button)`¶

`_release_all_layers(self)`¶

`_reset_selected_pads(self)`¶

`_set_button_control_properties(self, button)`¶

`_set_control_pads_from_script(self, takeover_pads)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_assigned_drum_pads(self)`¶

`_update_button_color(self, button)`¶

`_update_control_from_script(self)`¶

`_update_drum_pad_listeners(self)`¶

`_update_is_enabled(self)`¶

`_update_led_feedback(self)`¶

`_update_note_translations(self)`¶

`_update_provided_pitches(self)`¶

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

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

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

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

`create_modifier_buttons(self, *button_names)`¶

`delete_pitch(self, drum_pad)`¶

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

`is_polyphonic_has_listener(self, slot)`¶

`is_polyphonic_listener_count(self)`¶

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

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

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

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

`on_enabled_changed(self)`¶

`pitches_has_listener(self, slot)`¶

`pitches_listener_count(self)`¶

`pressed_pads_has_listener(self, slot)`¶

`pressed_pads_listener_count(self)`¶

`quantize_pitch(self, note)`¶

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

`remove_is_polyphonic_listener(self, slot)`¶

`remove_pitches_listener(self, slot)`¶

`remove_pressed_pads_listener(self, slot)`¶

`renderable_state(self)`¶

`select_drum_pad(self, drum_pad)`¶

`set_copy_button(self, button)`¶

`set_drum_group_device(self, drum_group_device)`¶

`set_enabled(self, enable)`¶

`set_matrix(self, matrix)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_DrumGroupComponent__on_chains_changed = None
_DrumGroupComponent__on_color_changed = None
_DrumGroupComponent__on_drum_pads_scroll_position_changed = None
_DrumGroupComponent__on_mute_changed = None
_DrumGroupComponent__on_muted_via_solo_changed = None
_DrumGroupComponent__on_selected_drum_pad_changed = None
_DrumGroupComponent__on_solo_changed = None
_DrumGroupComponent__on_visible_drum_pads_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
include_in_top_level_state = True - bool(x) -> bool
is_polyphonic = False - bool(x) -> bool
matrix = <ableton.v2.base.util.Mixin_MatrixControl_PlayableControl object at 0x13c7dba90>
num_layers = 0 - int([x]) -> integer
pitches = [36] - Built-in mutable sequence.
pressed_pads = [] - Built-in mutable sequence.

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

`_tasks(self, parent_task_group=None)`¶

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

`renderable_state(self)`¶

`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.
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

class `DrumPadClipboardComponent(ClipboardComponent)`¶

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

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

`_tasks(self, parent_task_group=None)`¶

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

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

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

`renderable_state(self)`¶

`set_copy_button(self, button)`¶

`set_drum_group_device(self, drum_group)`¶

`set_enabled(self, enable)`¶

`suppress_notifications(self)`¶

`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
copy_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c711d50>
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

class `FlattenedDeviceChain(ItemProvider)`¶

Properties¶

has_valid_selection
items
selected_index
selected_item
track

Methods¶

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

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

`_on_items_changed(self)`¶

`_update_devices(self, *_)`¶

`_update_listeners(self)`¶

`_update_selected_index(self)`¶

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

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

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

`can_scroll_down(self)`¶

`can_scroll_up(self)`¶

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

`remove_selected_item_listener(self, slot)`¶

`scroll_down(self)`¶

`scroll_up(self)`¶

`selected_index_has_listener(self, slot)`¶

`selected_index_listener_count(self)`¶

`selected_item_has_listener(self, slot)`¶

`selected_item_listener_count(self)`¶

`unregister_disconnectable(self, slot)`¶

class `GridResolutionComponent(Component)`¶

Properties¶

application
clip_grid
index
is_root
is_triplet
layer
parent
song
step_length

Methods¶

`init(self, name='Grid_Resolution', resolutions=None, default_index=3, *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)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_is_enabled(self)`¶

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

`index_has_listener(self, slot)`¶

`index_listener_count(self)`¶

`is_enabled(self, explicit=False)`¶

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

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

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

`remove_index_listener(self, slot)`¶

`set_enabled(self, enable)`¶

`set_to(self, name)`¶

`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
resolution_buttons = <ableton.v3.control_surface.controls.control_list.FixedRadioButtonGroup object at 0x11af5a1d0>

class `ItemListComponent(ScrollComponent)`¶

Properties¶

application
is_root
layer
parent
scrollable
song

Methods¶

`init(self, item_provider=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_next_button(self, button)`¶

`set_prev_button(self, button)`¶

`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 `ItemProvider(EventObject, Scrollable)`¶

Properties¶

has_valid_selection
items
selected_index
selected_item

Methods¶

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

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

`_on_items_changed(self)`¶

`_update_selected_index(self)`¶

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

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

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

`can_scroll_down(self)`¶

`can_scroll_up(self)`¶

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

`remove_selected_item_listener(self, slot)`¶

`scroll_down(self)`¶

`scroll_up(self)`¶

`selected_index_has_listener(self, slot)`¶

`selected_index_listener_count(self)`¶

`selected_item_has_listener(self, slot)`¶

`selected_item_listener_count(self)`¶

`unregister_disconnectable(self, slot)`¶

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

`_tasks(self, parent_task_group=None)`¶

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

`renderable_state(self)`¶

`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.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
delete_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c7fae10>
include_in_top_level_state = True - bool(x) -> bool
matrix = <ableton.v2.base.util.Mixin_MatrixControl_ButtonControl object at 0x13c7fae50>
next_page_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c7fac90>
num_layers = 0 - int([x]) -> integer
prev_page_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c7fad10>

class `MixerComponent(Component)`¶

Properties¶

application
is_root
layer
master_strip
num_send_controls_per_strip
parent
song
target_strip

Methods¶

`init(self, name='Mixer', session_ring=None, target_track=None, channel_strip_component_type=None, send_index_control_component_type=None, target_can_be_master=True, *a, **k)`¶

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

`_add_child(self, component)`¶

`_clear_send_controls(self)`¶

`_create_channel_strip(self, is_master=False, is_target=False)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_on_send_index_changed(self)`¶

`_reassign_tracks(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_set_indexed_send_controls(self, send_index, controls)`¶

`_set_master_or_target_strip_control(strip, name, control)`¶

`_set_strip_controls(self, name, controls)`¶

`_set_target_strip_indexed_send_control(self, send_index, control)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_is_enabled(self)`¶

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

`channel_strip(self, index)`¶

`control_notifications_enabled(self)`¶

`cycle_send_index(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_crossfader_control(self, control)`¶

`set_cycle_send_index_button(self, button)`¶

`set_enabled(self, enable)`¶

`set_next_send_index_button(self, button)`¶

`set_prehear_volume_control(self, control)`¶

`set_prev_send_index_button(self, button)`¶

`set_send_controls(self, controls)`¶

`set_shift_button(self, button)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_MixerComponent__on_offset_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
crossfader_control = <ableton.v2.control_surface.control.mapped.MappedControl object at 0x13c918810>
num_layers = 0 - int([x]) -> integer
prehear_volume_control = <ableton.v2.control_surface.control.mapped.MappedControl object at 0x13c7fbf90>

class `ModifierBackgroundComponent(BackgroundComponent)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

`init(self, name='Modifier_Background', *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_element_for_control(self, name, element)`¶

`_set_enabled_recursive(self, enable)`¶

`_setup_control_state(self, name, control_state)`¶

`_tasks(self, parent_task_group=None)`¶

`_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.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
num_layers = 0 - int([x]) -> integer

class `NextSlotRecordingMethod(RecordingMethod)`¶

Helper class that provides a standard way to create an ABC using inheritance.

Methods¶

`init(self, song=None, target_track=None, *a, **k)`¶

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

`can_record_into_clip_slot(clip_slot)`¶

`start_recording(self, *_)`¶

`stop_recording(self)`¶

`trigger_recording(self)`¶

Attributes¶

_abc_impl = <_abc._abc_data object at 0x13c934400> - Internal state held by ABC machinery.

class `NextSlotWithOverdubRecordingMethod(NextSlotRecordingMethod)`¶

Helper class that provides a standard way to create an ABC using inheritance.

Methods¶

`init(self, song=None, target_track=None, *a, **k)`¶

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

`can_record_into_clip_slot(clip_slot)`¶

`start_recording(self, *_)`¶

`stop_recording(self)`¶

`trigger_recording(self)`¶

Attributes¶

_abc_impl = <_abc._abc_data object at 0x13c9344c0> - Internal state held by ABC machinery.

class `NoteEditorComponent(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_note_in_step(self, pitch, time)`¶

`_adjust_duration_of_last_held_step_notes(self, destination_step)`¶

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

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

`_tasks(self, parent_task_group=None)`¶

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

`renderable_state(self)`¶

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

class `NoteEditorPaginator(Component, Paginator)`¶

Properties¶

application
is_root
layer
page_time
parent
song

Methods¶

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

`_tasks(self, parent_task_group=None)`¶

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

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

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

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

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

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

`on_enabled_changed(self)`¶

`page_has_listener(self, slot)`¶

`page_length_has_listener(self, slot)`¶

`page_length_listener_count(self)`¶

`page_listener_count(self)`¶

`page_time_has_listener(self, slot)`¶

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

`remove_page_listener(self, slot)`¶

`remove_page_time_listener(self, slot)`¶

`set_enabled(self, enable)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_NoteEditorPaginator__on_active_steps_changed = None
_NoteEditorPaginator__on_page_length_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
can_change_page = <ableton.v2.base.util.forward_property.<locals>.Descriptor object at 0x13c91a650>
canonical_parent = None
num_layers = 0 - int([x]) -> integer
page_length = <ableton.v2.base.util.forward_property.<locals>.Descriptor object at 0x13c91a750>

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

`_tasks(self, parent_task_group=None)`¶

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

`renderable_state(self)`¶

`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.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
copy_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c711d50>
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

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

`_tasks(self, parent_task_group=None)`¶

`_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.
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 `Paginator(EventObject)`¶

Methods¶

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

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

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

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

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

`can_change_page()`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

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

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

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

`page_has_listener(self, slot)`¶

`page_length_has_listener(self, slot)`¶

`page_length_listener_count(self)`¶

`page_listener_count(self)`¶

`page_time_has_listener(self, slot)`¶

`page_time_listener_count(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`remove_page_length_listener(self, slot)`¶

`remove_page_listener(self, slot)`¶

`remove_page_time_listener(self, slot)`¶

`unregister_disconnectable(self, slot)`¶

Attributes¶

page_length = NotImplemented
page_time = NotImplemented

class `PitchProvider(EventObject)`¶

Methods¶

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

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

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

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

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`is_polyphonic_has_listener(self, slot)`¶

`is_polyphonic_listener_count(self)`¶

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

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

`pitches_has_listener(self, slot)`¶

`pitches_listener_count(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`remove_is_polyphonic_listener(self, slot)`¶

`remove_pitches_listener(self, slot)`¶

`unregister_disconnectable(self, slot)`¶

Attributes¶

is_polyphonic = False - bool(x) -> bool
pitches = [36] - Built-in mutable sequence.

class `PlayableComponent(Component)`¶

Properties¶

application
height
is_root
layer
parent
song
width

Methods¶

`init(self, name='Playable', matrix_always_listenable=False, *a, **k)`¶

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

`_add_child(self, component)`¶

`_any_modifier_pressed(self)`¶

`_button_should_be_enabled(self, button)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_note_translation_for_button(self, button)`¶

`_on_matrix_pressed(self, button)`¶

`_on_matrix_released(self, button)`¶

`_release_all_layers(self)`¶

`_reset_selected_pads(self)`¶

`_set_button_control_properties(self, button)`¶

`_set_control_pads_from_script(self, takeover_pads)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_button_color(self, button)`¶

`_update_control_from_script(self)`¶

`_update_is_enabled(self)`¶

`_update_led_feedback(self)`¶

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

`create_modifier_buttons(self, *button_names)`¶

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

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

`on_enabled_changed(self)`¶

`pressed_pads_has_listener(self, slot)`¶

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

`set_enabled(self, enable)`¶

`set_matrix(self, matrix)`¶

`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
matrix = <ableton.v2.base.util.Mixin_MatrixControl_PlayableControl object at 0x13c7dba90>
num_layers = 0 - int([x]) -> integer
pressed_pads = [] - Built-in mutable sequence.

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

`_tasks(self, parent_task_group=None)`¶

`_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.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
num_layers = 0 - int([x]) -> integer

class `RecordingComponent(Component, Renderable)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

`init(self, target_track=None, recording_method_type=None, name='Recording', *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)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_is_enabled(self)`¶

`_update_new_button(self)`¶

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

`set_enabled(self, enable)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
arrangement_overdub_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c9347d0>
arrangement_record_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c934710>
canonical_parent = None
include_in_top_level_state = True - bool(x) -> bool
new_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c934890>
num_layers = 0 - int([x]) -> integer
session_overdub_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c934650>
session_record_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c934590>

class `RecordingMethod(ABC)`¶

Helper class that provides a standard way to create an ABC using inheritance.

Methods¶

`init(self, song=None, target_track=None, *a, **k)`¶

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

`can_record_into_clip_slot(clip_slot)`¶

`start_recording(self, *_)`¶

`stop_recording(self)`¶

`trigger_recording(self)`¶

Attributes¶

_abc_impl = <_abc._abc_data object at 0x13c9342c0> - Internal state held by ABC machinery.

class `SceneComponent(Component, Renderable)`¶

Properties¶

application
is_root
layer
parent
scene
song

Methods¶

`init(self, session_ring=None, clip_slot_component_type=None, *a, **k)`¶

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

`_add_child(self, component)`¶

`_any_modifier_pressed(self)`¶

`_create_event_handler(self, property_name)`¶

`_do_launch_scene(self)`¶

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

`_on_launch_button_pressed(self)`¶

`_on_launch_button_released(self)`¶

`_reassign_clip_slots(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_is_enabled(self)`¶

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

`clip_slot(self, index)`¶

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

`set_enabled(self, enable)`¶

`set_launch_button(self, button)`¶

`set_scene(self, scene)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_SceneComponent__on_is_triggered_changed = None
_SceneComponent__on_scene_color_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
delete_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c935150>
duplicate_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c935210>
include_in_top_level_state = False - bool(x) -> bool
launch_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c934b50>
num_layers = 0 - int([x]) -> integer
select_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c935050>

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

class `SelectedSlotRecordingMethod(RecordingMethod)`¶

Helper class that provides a standard way to create an ABC using inheritance.

Methods¶

`init(self, song=None, target_track=None, *a, **k)`¶

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

`_record_in_slot(self, slot)`¶

`can_record_into_clip_slot(clip_slot)`¶

`start_recording(self, *_)`¶

`stop_recording(self)`¶

`trigger_recording(self)`¶

Attributes¶

_abc_impl = <_abc._abc_data object at 0x13c934540> - Internal state held by ABC machinery.

class `SendIndexControlComponent(Component, Renderable)`¶

Properties¶

application
is_root
layer
num_sends
parent
send_index
song

Methods¶

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

`_notify_send_range(self, range_name)`¶

`_quantize_to_cycle_size(self, value)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_is_enabled(self)`¶

`_update_send_index(self)`¶

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

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

`any_clipboard_has_content_has_listener(self, slot)`¶

`any_clipboard_has_content_listener_count(self)`¶

`can_increment_send_index(self, delta)`¶

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

`control_notifications_enabled(self)`¶

`cycle_send_index(self, range_name='Send')`¶

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

`increment_send_index(self, delta, range_name='Send')`¶

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

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

`num_sends_has_listener(self, slot)`¶

`num_sends_listener_count(self)`¶

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

`remove_num_sends_listener(self, slot)`¶

`remove_send_index_listener(self, slot)`¶

`renderable_state(self)`¶

`send_index_has_listener(self, slot)`¶

`send_index_listener_count(self)`¶

`set_cycle_size(self, size)`¶

`set_enabled(self, enable)`¶

`set_increment_size(self, size)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_SendIndexControlComponent__on_return_tracks_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
cycle_send_index_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c9191d0>
include_in_top_level_state = True - bool(x) -> bool
next_send_index_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c9193d0>
num_layers = 0 - int([x]) -> integer
prev_send_index_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c919310>

class `SequencerClip(EventObject)`¶

Properties¶

bar_length
clip
length
num_bars

Methods¶

`init(self, target_track=None, can_be_audio_clip=False, *a, **k)`¶

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

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

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

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

`bar_length_has_listener(self, slot)`¶

`bar_length_listener_count(self)`¶

`clip_has_listener(self, slot)`¶

`clip_listener_count(self)`¶

`create_clip(self, length=None)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`length_has_listener(self, slot)`¶

`length_listener_count(self)`¶

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

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

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

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`remove_bar_length_listener(self, slot)`¶

`remove_clip_listener(self, slot)`¶

`remove_length_listener(self, slot)`¶

`unregister_disconnectable(self, slot)`¶

Attributes¶

_SequencerClip__on_loop_end_changed = None
_SequencerClip__on_loop_start_changed = None
_SequencerClip__on_looping_changed = None
_SequencerClip__on_signature_denominator_changed = None
_SequencerClip__on_signature_numerator_changed = None
_SequencerClip__on_target_clip_changed = None

class `SessionComponent(Component, Renderable)`¶

Properties¶

application
clipboard
is_root
layer
parent
song

Methods¶

`init(self, name='Session', session_ring=None, scene_component_type=None, clip_slot_component_type=None, clipboard_component_type=None, *a, **k)`¶

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

`_add_child(self, component)`¶

`_create_event_handler(self, property_name)`¶

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

`_reassign_scenes(self)`¶

`_reassign_tracks(self)`¶

`_reassign_tracks_and_scenes(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_is_enabled(self)`¶

`_update_stop_clips_led(self, index)`¶

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

`renderable_state(self)`¶

`scene(self, index)`¶

`selected_scene(self)`¶

`set_clip_launch_buttons(self, buttons)`¶

`set_clip_slot_select_button(self, button)`¶

`set_copy_button(self, button)`¶

`set_delete_button(self, button)`¶

`set_duplicate_button(self, button)`¶

`set_enabled(self, enable)`¶

`set_modifier_button(self, button, name, clip_slots_only=False)`¶

`set_scene_launch_buttons(self, buttons)`¶

`set_select_button(self, button)`¶

`set_stop_track_clip_buttons(self, buttons)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_SessionComponent__on_fired_slot_index_changed = None
_SessionComponent__on_offsets_changed = None
_SessionComponent__on_playing_slot_index_changed = None
_SessionComponent__on_selected_scene_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
_session_component_ends_initialisation = True - bool(x) -> bool
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
stop_all_clips_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c9362d0>
stop_track_clip_buttons = <ableton.v2.base.util.Mixin_ControlList_ButtonControl object at 0x13c936410>

class `SessionNavigationComponent(Component)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

`init(self, name='Session_Navigation', session_ring=None, respect_borders=False, snap_track_offset=False, *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)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_horizontal(self)`¶

`_update_is_enabled(self)`¶

`_update_vertical(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_down_button(self, button)`¶

`set_enabled(self, enable)`¶

`set_horizontal_encoder(self, control)`¶

`set_left_button(self, button)`¶

`set_page_down_button(self, button)`¶

`set_page_left_button(self, button)`¶

`set_page_right_button(self, button)`¶

`set_page_up_button(self, button)`¶

`set_right_button(self, button)`¶

`set_up_button(self, button)`¶

`set_vertical_encoder(self, control)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_SessionNavigationComponent__on_offset_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
num_layers = 0 - int([x]) -> integer

class `SessionOverviewComponent(Component)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

`init(self, name='Session_Overview', session_ring=None, *a, **k)`¶

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

`_add_child(self, component)`¶

`_block_has_playing_clips(self, tracks, num_tracks, num_scenes, track_offset, scene_offset)`¶

`_block_is_within_selection(self, x, y, num_tracks, num_scenes)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_bank_offsets(self)`¶

`_update_is_enabled(self)`¶

`_update_matrix(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_matrix(self, matrix)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_SessionOverviewComponent__on_playing_slot_index_changed = None
_SessionOverviewComponent__on_session_offset_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
matrix = <ableton.v2.base.util.Mixin_MatrixControl_ButtonControl object at 0x13c944790>
num_layers = 0 - int([x]) -> integer

class `SessionRingComponent(Component, Renderable)`¶

Properties¶

application
is_root
layer
num_scenes
num_tracks
offset
parent
scene_offset
scenes
song
track_offset
tracks

Methods¶

`init(self, name='Session_Ring', num_tracks=0, num_scenes=0, include_returns=False, include_master=False, right_align_non_player_tracks=False, tracks_to_use=None, snap_track_offset=False, set_session_highlight=<function nop at 0x11afcb240>, is_private=False, *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)`¶

`_get_tracks_to_use(self, include_returns, include_master)`¶

`_grab_all_layers(self)`¶

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`_internal_on_enabled_changed(self)`¶

`_pad_tracks(self, tracks)`¶

`_release_all_layers(self)`¶

`_right_align_non_player_tracks(self, tracks)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_highlight(self)`¶

`_update_is_enabled(self)`¶

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

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

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

`any_clipboard_has_content_has_listener(self, slot)`¶

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

`move(self, tracks, scenes)`¶

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

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

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

`offset_has_listener(self, slot)`¶

`offset_listener_count(self)`¶

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

`remove_offset_listener(self, slot)`¶

`remove_scenes_listener(self, slot)`¶

`remove_tracks_listener(self, slot)`¶

`renderable_state(self)`¶

`scenes_has_listener(self, slot)`¶

`scenes_listener_count(self)`¶

`scenes_to_use(self)`¶

`set_enabled(self, enable)`¶

`set_offsets(self, track_offset, scene_offset)`¶

`suppress_notifications(self)`¶

`tracks_has_listener(self, slot)`¶

`tracks_listener_count(self)`¶

`tracks_to_use(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_SessionRingComponent__on_scene_list_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
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

class `SlicedSimplerComponent(PlayableComponent, PageComponent, Pageable, PitchProvider, Renderable)`¶

Properties¶

application
height
is_root
layer
parent
position
song
width

Methods¶

`init(self, name='Sliced_Simpler', translation_channel=14, target_track=None, *a, **k)`¶

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

`_add_child(self, component)`¶

`_any_modifier_pressed(self)`¶

`_button_should_be_enabled(self, button)`¶

`_coordinate_to_slice_index(self, coordinate)`¶

`_create_event_handler(self, property_name)`¶

`_delete_slice_at_index(self, index)`¶

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

`_note_translation_for_button(self, button)`¶

`_on_matrix_pressed(self, button)`¶

`_on_matrix_released(self, button)`¶

`_release_all_layers(self)`¶

`_reset_selected_pads(self)`¶

`_scroll_page(self, sign)`¶

`_scroll_position(self, delta)`¶

`_select_slice_at_index(self, index)`¶

`_selected_slice(self)`¶

`_set_button_control_properties(self, button)`¶

`_set_control_pads_from_script(self, takeover_pads)`¶

`_set_enabled_recursive(self, enable)`¶

`_should_show_next_slice(self, index, length_of_slices)`¶

`_simpler_setup_is_valid(self)`¶

`_slices(self)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_button_color(self, button)`¶

`_update_control_from_script(self)`¶

`_update_is_enabled(self)`¶

`_update_led_feedback(self)`¶

`_update_note_translations(self)`¶

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

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

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

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

`create_modifier_buttons(self, *button_names)`¶

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

`is_polyphonic_has_listener(self, slot)`¶

`is_polyphonic_listener_count(self)`¶

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

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

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

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

`on_enabled_changed(self)`¶

`pitches_has_listener(self, slot)`¶

`pitches_listener_count(self)`¶

`position_has_listener(self, slot)`¶

`position_listener_count(self)`¶

`pressed_pads_has_listener(self, slot)`¶

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

`remove_pitches_listener(self, slot)`¶

`remove_position_listener(self, slot)`¶

`remove_pressed_pads_listener(self, slot)`¶

`renderable_state(self)`¶

`scroll_down(self)`¶

`scroll_page_down(self)`¶

`scroll_page_up(self)`¶

`scroll_up(self)`¶

`set_enabled(self, enable)`¶

`set_matrix(self, matrix)`¶

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

`set_simpler_device(self, simpler_device)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_SlicedSimplerComponent__on_file_changed = None
_SlicedSimplerComponent__on_pad_slicing_changed = None
_SlicedSimplerComponent__on_selected_slice_changed = None
_SlicedSimplerComponent__on_slices_changed = None
_SlicedSimplerComponent__on_slicing_style_changed = None
_SlicedSimplerComponent__on_track_color_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
include_in_top_level_state = True - bool(x) -> bool
is_polyphonic = False - bool(x) -> bool
matrix = <ableton.v2.base.util.Mixin_MatrixControl_PlayableControl object at 0x13c7dba90>
num_layers = 0 - int([x]) -> integer
page_length = 4 - int([x]) -> integer
page_offset = 0 - int([x]) -> integer
pitches = [36] - Built-in mutable sequence.
position_count = 16 - int([x]) -> integer
pressed_pads = [] - Built-in mutable sequence.

class `StepSequenceComponent(Component)`¶

Properties¶

application
is_root
layer
note_editor
parent
song

Methods¶

`init(self, name='Step_Sequence', grid_resolution=None, note_editor_component_type=None, note_editor_paginator_type=None, loop_selector_component_type=None, playhead_component_type=None, playhead_notes=None, playhead_triplet_notes=None, playhead_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)`¶

`_tasks(self, parent_task_group=None)`¶

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

`set_loop_buttons(self, matrix)`¶

`set_loop_copy_button(self, button)`¶

`set_loop_delete_button(self, button)`¶

`set_next_page_button(self, button)`¶

`set_note_copy_button(self, button)`¶

`set_pitch_provider(self, provider)`¶

`set_prev_page_button(self, button)`¶

`set_resolution_buttons(self, buttons)`¶

`set_step_buttons(self, buttons)`¶

`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

class `TargetChannelStripComponent(ChannelStripComponent)`¶

Properties¶

application
is_root
layer
parent
song
track

Methods¶

`init(self, name='Target_Channel_Strip', target_track=None, send_range_name='Send', *a, **k)`¶

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

`_add_child(self, component)`¶

`_all_controls(self)`¶

`_connect_parameters(self)`¶

`_connect_send_parameters(self, send_controls)`¶

`_create_event_handler(self, property_name)`¶

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

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_set_indexed_send_control(self, send_index, control)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_arm_button(self)`¶

`_update_crossfade_cycle_button(self)`¶

`_update_is_enabled(self)`¶

`_update_mute_button(self)`¶

`_update_send_controls(self)`¶

`_update_solo_button(self)`¶

`_update_target_track(self)`¶

`_update_track_select_button(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_base_type(extra_args=None, extra_kws=None, *a, **k)`¶

`control_notifications_enabled(self)`¶

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

`other_arm_buttons_pressed(strip)`¶

`other_solo_buttons_pressed(strip)`¶

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

`set_cycle_send_index_button(self, button)`¶

`set_enabled(self, enable)`¶

`set_indexed_send_control(self, control_element, index)`¶

`set_next_send_index_button(self, button)`¶

`set_prev_send_index_button(self, button)`¶

`set_send_controls(self, controls)`¶

`set_track(self, track)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_active_instances = [] - Built-in mutable sequence.
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
arm_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c703110>
canonical_parent = None
crossfade_cycle_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c7031d0>
include_in_top_level_state = False - bool(x) -> bool
indexed_send_controls = <ableton.v2.base.util.Mixin_ControlList_MappedControl object at 0x11af7f7d0>
mute_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c702fd0>
num_layers = 0 - int([x]) -> integer
pan_control = <ableton.v2.control_surface.control.mapped.MappedControl object at 0x13c701990>
send_controls = <ableton.v2.base.util.Mixin_ControlList_MappedControl object at 0x13c701a10>
shift_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c703290>
solo_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c703050>
track_select_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c702ed0>
volume_control = <ableton.v2.control_surface.control.mapped.MappedControl object at 0x13c701950>

class `TargetTrackComponent(Component, Renderable)`¶

Properties¶

application
is_locked_to_track
is_root
layer
parent
song
target_clip
target_track

Methods¶

`init(self, name='Target_Track', is_private=False, *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)`¶

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

`_selected_track_changed(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_set_target_track(self)`¶

`_target_clip_from_arrangement(self)`¶

`_target_clip_from_session(self)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_is_enabled(self)`¶

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

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

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

`any_clipboard_has_content_has_listener(self, slot)`¶

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

`is_locked_to_track_has_listener(self, slot)`¶

`is_locked_to_track_listener_count(self)`¶

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

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

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

`remove_is_locked_to_track_listener(self, slot)`¶

`remove_target_clip_listener(self, slot)`¶

`remove_target_track_listener(self, slot)`¶

`renderable_state(self)`¶

`set_enabled(self, enable)`¶

`suppress_notifications(self)`¶

`target_clip_has_listener(self, slot)`¶

`target_clip_listener_count(self)`¶

`target_track_has_listener(self, slot)`¶

`target_track_listener_count(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_TargetTrackComponent__on_target_clip_slot_has_clip_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
include_in_top_level_state = True - bool(x) -> bool
lock_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c96e8d0>
num_layers = 0 - int([x]) -> integer

class `TranslatingBackgroundComponent(BackgroundComponent)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

`init(self, name='Translating_Background', translation_channel=0, *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_element_for_control(self, name, element)`¶

`_set_enabled_recursive(self, enable)`¶

`_setup_control_state(self, _, control_state)`¶

`_tasks(self, parent_task_group=None)`¶

`_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_channel_selection_buttons(self, buttons)`¶

`set_enabled(self, enable)`¶

`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
channel_selection_buttons = <ableton.v2.control_surface.control.control_list.RadioButtonGroup object at 0x13c700b50>
num_layers = 0 - int([x]) -> integer

class `TransportComponent(Component, Renderable)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

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

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_toggle_record_quantize(self)`¶

`_trigger_tap_tempo(self)`¶

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

`set_enabled(self, enable)`¶

`set_position_encoders_use_bar_increments(self, use_bar)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_TransportComponent__on_can_capture_midi_changed = None
_TransportComponent__on_can_jump_to_next_cue_changed = None
_TransportComponent__on_can_jump_to_prev_cue_changed = None
_TransportComponent__on_is_playing_changed = None
_TransportComponent__on_re_enable_automation_enabled_changed = None
_TransportComponent__on_record_quantization_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
arrangement_position_encoder = <ableton.v3.control_surface.controls.encoder.StepEncoderControl object at 0x13c984710>
automation_arm_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c984f90>
canonical_parent = None
capture_midi_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c985110>
cue_encoder = <ableton.v3.control_surface.controls.encoder.StepEncoderControl object at 0x13c984b10>
fastforward_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c985810>
include_in_top_level_state = True - bool(x) -> bool
loop_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c9851d0>
loop_length_encoder = <ableton.v3.control_surface.controls.encoder.StepEncoderControl object at 0x13c9848d0>
loop_start_encoder = <ableton.v3.control_surface.controls.encoder.StepEncoderControl object at 0x13c984810>
metronome_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c985290>
next_cue_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c985990>
nudge_down_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c985590>
nudge_up_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c985650>
num_layers = 0 - int([x]) -> integer
play_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c984bd0>
play_pause_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c984d90>
play_toggle_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c984cd0>
prev_cue_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c9858d0>
punch_in_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c985350>
punch_out_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c985410>
re_enable_automation_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c985050>
record_quantize_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c985b10>
rewind_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c985710>
seek_dict = {'color': 'Transport.Seek', 'pressed_color': 'Transport.SeekPressed', 'repeat': True, 'delay_time': 0} - dict() -> new empty dictionary
set_cue_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c985a50>
stop_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c984ed0>
tap_tempo_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c9854d0>
tempo_coarse_encoder = <ableton.v3.control_surface.controls.encoder.StepEncoderControl object at 0x13c984990>
tempo_fine_encoder = <ableton.v3.control_surface.controls.encoder.StepEncoderControl object at 0x13c984a50>

class `UndoRedoComponent(Component, Renderable)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

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

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

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

`set_enabled(self, enable)`¶

`suppress_notifications(self)`¶

`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
include_in_top_level_state = True - bool(x) -> bool
num_layers = 0 - int([x]) -> integer
redo_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c986a90>
undo_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c986950>

class `ViewBasedRecordingComponent(RecordingComponent)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

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

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_is_enabled(self)`¶

`_update_new_button(self)`¶

`_update_overdub_button_assignments(self)`¶

`_update_record_button_assignments(self)`¶

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

`set_enabled(self, enable)`¶

`set_overdub_button(self, button)`¶

`set_record_button(self, button)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_clipboard_component_instances = [] - Built-in mutable sequence.
any_clipboard_has_content = False - bool(x) -> bool
arrangement_overdub_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c9347d0>
arrangement_record_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c934710>
canonical_parent = None
include_in_top_level_state = True - bool(x) -> bool
new_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c934890>
num_layers = 0 - int([x]) -> integer
session_overdub_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c934650>
session_record_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x13c934590>

class `ViewControlComponent(Component, Renderable)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

`init(self, name='View_Control', session_ring=None, *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)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_is_enabled(self)`¶

`_update_scene_scrollers(self)`¶

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

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

`any_clipboard_has_content_has_listener(self, slot)`¶

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

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

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

`remove_scene_selection_scrolled_listener(self, slot)`¶

`remove_track_selection_scrolled_listener(self, slot)`¶

`renderable_state(self)`¶

`scene_selection_scrolled_has_listener(self, slot)`¶

`scene_selection_scrolled_listener_count(self)`¶

`set_enabled(self, enable)`¶

`set_next_scene_button(self, button)`¶

`set_next_scene_page_button(self, button)`¶

`set_next_track_button(self, button)`¶

`set_next_track_page_button(self, button)`¶

`set_prev_scene_button(self, button)`¶

`set_prev_scene_page_button(self, button)`¶

`set_prev_track_button(self, button)`¶

`set_prev_track_page_button(self, button)`¶

`set_scene_encoder(self, control)`¶

`set_scene_page_encoder(self, control)`¶

`set_track_encoder(self, control)`¶

`set_track_page_encoder(self, control)`¶

`suppress_notifications(self)`¶

`track_selection_scrolled_has_listener(self, slot)`¶

`track_selection_scrolled_listener_count(self)`¶

`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
include_in_top_level_state = True - bool(x) -> bool
num_layers = 0 - int([x]) -> integer

class `ViewToggleComponent(Component)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

`_ViewToggleComponent__update_view_toggle_buttons(self)`¶

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

`_show_or_hide_view(self, show_view, view_name)`¶

`_tasks(self, parent_task_group=None)`¶

`_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.
any_clipboard_has_content = False - bool(x) -> bool
browser_view_toggle_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c98c590>
canonical_parent = None
clip_view_toggle_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c98c4d0>
detail_view_toggle_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c98c3d0>
main_view_toggle_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x13c98c390>
num_layers = 0 - int([x]) -> integer

class `ZoomComponent(Component)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

`init(self, name='Zoom', arrangement_only=False, zoom_all_tracks=False, *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)`¶

`_tasks(self, parent_task_group=None)`¶

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

`set_horizontal_zoom_encoder(self, encoder)`¶

`set_horizontal_zoom_in_button(self, button)`¶

`set_horizontal_zoom_out_button(self, button)`¶

`set_vertical_zoom_encoder(self, encoder)`¶

`set_vertical_zoom_in_button(self, button)`¶

`set_vertical_zoom_out_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

ableton.v3.control_surface.components (runtime)¶

Module constants¶

Functions¶

create_sequencer_clip(track, slot=None, length=None)¶

Classes¶

class AccentComponent(Component, Renderable)¶

Properties¶

Methods¶

__init__(self, name='Accent', full_velocity=None, *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)¶

_set_enabled_recursive(self, enable)¶

_tasks(self, parent_task_group=None)¶

_update_is_enabled(self)¶

activated_has_listener(self, slot)¶

activated_listener_count(self)¶

add_activated_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_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_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_activated(self, *a, **k)¶

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

remove_any_clipboard_has_content_listener(self, slot)¶

remove_enabled_listener(self, slot)¶

renderable_state(self)¶

set_enabled(self, enable)¶

suppress_notifications(self)¶

unregister_disconnectable(self, slot)¶

update(self)¶

Attributes¶

class ActiveParameterComponent(Component, Renderable)¶

Properties¶

Methods¶

__init__(self, name='Active_Parameter', timeout=0.75, *a, **k)¶

_add_child(self, component)¶

_cancel_release_task(self, index)¶

_clear_release_task(self, index)¶

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

_on_pressed_touch_elements_changed(self)¶

_on_touch_control_release(self, index)¶

_release_all_layers(self)¶

_set_enabled_recursive(self, enable)¶

_tasks(self, parent_task_group=None)¶

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

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

`create_sequencer_clip(track, slot=None, length=None)`¶

class `AccentComponent(Component, Renderable)`¶

`init(self, name='Accent', full_velocity=None, *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)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

`_update_is_enabled(self)`¶

`activated_has_listener(self, slot)`¶

`activated_listener_count(self)`¶

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

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

`remove_any_clipboard_has_content_listener(self, slot)`¶

`remove_enabled_listener(self, slot)`¶

`renderable_state(self)`¶

`set_enabled(self, enable)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

class `ActiveParameterComponent(Component, Renderable)`¶

`init(self, name='Active_Parameter', timeout=0.75, *a, **k)`¶

`_add_child(self, component)`¶

`_cancel_release_task(self, index)`¶

`_clear_release_task(self, index)`¶

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

`_on_pressed_touch_elements_changed(self)`¶

`_on_touch_control_release(self, index)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_tasks(self, parent_task_group=None)`¶

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

`any_clipboard_has_content_has_listener(self, slot)`¶

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