`ableton.v2.control_surface.components.session` (runtime)¶

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

Functions¶

`in_range(value, lower_bound, upper_open_bound)`¶

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

`listens_group(event_name, *a, **k)`¶

`product(iter_a, iter_b)`¶

Classes¶

class `ButtonControl(ButtonControlBase)`¶

Properties¶

double_clicked
pressed
pressed_delayed
released
released_delayed
released_immediately
value

Methods¶

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

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

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

`_clear_state(self, manager)`¶

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

`_make_control_state(self, manager)`¶

Attributes¶

DELAY_TIME = 0.3 - Convert a string or number to a floating point number, if possible.
DOUBLE_CLICK_TIME = 0.5 - Convert a string or number to a floating point number, if possible.
REPEAT_RATE = 0.1 - Convert a string or number to a floating point number, if possible.
_extra_args = [] - Built-in mutable sequence.
_extra_kws = {} - dict() -> new empty dictionary

class `Component(ControlManager)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

`init(self, name='', parent=None, register_component=None, song=None, layer=None, is_enabled=True, *a, **k)`¶

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

`_add_child(self, component)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_update_is_enabled(self)`¶

`add_children(self, *a)`¶

`add_control(self, name, control)`¶

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

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

`on_enabled_changed(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`remove_enabled_listener(self, slot)`¶

`set_enabled(self, enable)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_has_task_group = False - bool(x) -> bool
_layer = None
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x163088ef0>
canonical_parent = None
is_private = False - bool(x) -> bool
name = '' - str(object='') -> str

class `EventObject(CompoundDisconnectable)`¶

Methods¶

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

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

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`unregister_disconnectable(self, slot)`¶

class `SceneComponent(Component)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

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

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

`_add_child(self, component)`¶

`_color_value(self, color)`¶

`_create_clip_slot(self)`¶

`_determine_actual_track_offset(self, tracks)`¶

`_do_delete_scene(self, scene_for_overrides)`¶

`_do_duplicate_scene(self, scene_for_overrides)`¶

`_do_launch_scene(self, value)`¶

`_do_select_scene(self, scene_for_overrides)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_on_launch_button_pressed(self)`¶

`_on_launch_button_released(self)`¶

`_on_scene_deleted(self)`¶

`_on_scene_duplicated(self)`¶

`_on_scene_selected(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_update_controlled_tracks(self)`¶

`_update_is_enabled(self)`¶

`_update_launch_button(self)`¶

`add_children(self, *a)`¶

`add_control(self, name, control)`¶

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

`build_clip_slot_list(self)`¶

`clip_slot(self, index)`¶

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

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

`on_enabled_changed(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`remove_enabled_listener(self, slot)`¶

`set_color_palette(self, palette)`¶

`set_color_table(self, table)`¶

`set_delete_button(self, button)`¶

`set_duplicate_button(self, button)`¶

`set_enabled(self, enable)`¶

`set_launch_button(self, button)`¶

`set_scene(self, scene)`¶

`set_select_button(self, button)`¶

`set_track_offset(self, offset)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_SceneComponent__on_is_triggered_changed = None
_SceneComponent__on_scene_color_changed = None
_SceneComponent__on_track_list_changed = None
_has_task_group = False - bool(x) -> bool
_layer = None
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x163088ef0>
canonical_parent = None
is_private = False - bool(x) -> bool
launch_button = <ableton.v2.control_surface.control.button.ButtonControl object at 0x163529c18>
name = '' - str(object='') -> str

class `SessionComponent(Component)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

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

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

`_add_child(self, component)`¶

`_auto_name(self)`¶

`_create_scene(self)`¶

`_end_initialisation(self)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_on_fired_slot_index_changed(self, track_index)`¶

`_on_playing_slot_index_changed(self, track_index)`¶

`_reassign_scenes(self)`¶

`_reassign_scenes_and_tracks(self)`¶

`_reassign_tracks(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_stop_all_value(self, value)`¶

`_update_is_enabled(self)`¶

`_update_stop_all_clips_button(self)`¶

`_update_stop_clips_led(self, index)`¶

`_update_stop_track_clip_buttons(self)`¶

`add_children(self, *a)`¶

`add_control(self, name, control)`¶

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

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

`on_enabled_changed(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`remove_enabled_listener(self, slot)`¶

`scene(self, index)`¶

`scene_component_type(session_ring=None, *a, **k)`¶

`selected_scene(self)`¶

`set_clip_launch_buttons(self, buttons)`¶

`set_enabled(self, enable)`¶

`set_managed_delete_button(self, button)`¶

`set_managed_duplicate_button(self, button)`¶

`set_managed_select_button(self, button)`¶

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

`set_rgb_mode(self, color_palette, color_table, clip_slots_only=False)`¶

`set_scene_launch_buttons(self, buttons)`¶

`set_stop_all_clips_button(self, button)`¶

`set_stop_track_clip_buttons(self, buttons)`¶

`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_scene_list_changed = None
_SessionComponent__on_selected_scene_changed = None
_SessionComponent__on_stop_all_value = None
_SessionComponent__on_stop_track_value = None
_SessionComponent__on_track_list_changed = None
_has_task_group = False - bool(x) -> bool
_layer = None
_session_component_ends_initialisation = True - bool(x) -> bool
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x163088ef0>
canonical_parent = None
is_private = False - bool(x) -> bool
managed_delete_button = <ableton.v2.control_surface.control.button.ButtonControl object at 0x16352fcc0>
managed_duplicate_button = <ableton.v2.control_surface.control.button.ButtonControl object at 0x16352fcf8>
managed_select_button = <ableton.v2.control_surface.control.button.ButtonControl object at 0x16352fc88>
name = '' - str(object='') -> str

class `count`¶

count(start=0, step=1) --> count object

Return a count object whose .next() method returns consecutive values. Equivalent to:

def count(firstval=0, step=1):
    x = firstval
    while 1:
        yield x
        x += step

Methods¶

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

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

ableton.v2.control_surface.components.session (runtime)¶

Functions¶

in_range(value, lower_bound, upper_open_bound)¶

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

listens_group(event_name, *a, **k)¶

product(iter_a, iter_b)¶

Classes¶

class ButtonControl(ButtonControlBase)¶

Properties¶

Methods¶

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

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

_clear_state(self, manager)¶

_get_state(self, manager, state_factory=None)¶

_make_control_state(self, manager)¶

Attributes¶

class Component(ControlManager)¶

Properties¶

Methods¶

__init__(self, name='', parent=None, register_component=None, song=None, layer=None, is_enabled=True, *a, **k)¶

_add_child(self, component)¶

_get_layer_iterable(self)¶

_grab_all_layers(self)¶

_internal_on_enabled_changed(self)¶

_release_all_layers(self)¶

_set_enabled_recursive(self, enable)¶

_update_is_enabled(self)¶

add_children(self, *a)¶

add_control(self, name, control)¶

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

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

on_enabled_changed(self)¶

register_disconnectable(self, slot)¶

register_disconnectables(self, disconnectables)¶

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

remove_enabled_listener(self, slot)¶

set_enabled(self, enable)¶

unregister_disconnectable(self, slot)¶

update(self)¶

Attributes¶

class EventObject(CompoundDisconnectable)¶

Methods¶

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

disconnect(self)¶

disconnect_disconnectable(self, slot)¶

find_disconnectable(self, predicate)¶

has_disconnectable(self, slot)¶

register_disconnectable(self, slot)¶

register_disconnectables(self, disconnectables)¶

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

unregister_disconnectable(self, slot)¶

class SceneComponent(Component)¶

Properties¶

Methods¶

__init__(self, session_ring=None, *a, **k)¶

_add_child(self, component)¶

_color_value(self, color)¶

_create_clip_slot(self)¶

_determine_actual_track_offset(self, tracks)¶

_do_delete_scene(self, scene_for_overrides)¶

_do_duplicate_scene(self, scene_for_overrides)¶

_do_launch_scene(self, value)¶

_do_select_scene(self, scene_for_overrides)¶

_get_layer_iterable(self)¶

_grab_all_layers(self)¶

_internal_on_enabled_changed(self)¶

_on_launch_button_pressed(self)¶

_on_launch_button_released(self)¶

_on_scene_deleted(self)¶

_on_scene_duplicated(self)¶

_on_scene_selected(self)¶

_release_all_layers(self)¶

`ableton.v2.control_surface.components.session` (runtime)¶

`in_range(value, lower_bound, upper_open_bound)`¶

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

`listens_group(event_name, *a, **k)`¶

`product(iter_a, iter_b)`¶

class `ButtonControl(ButtonControlBase)`¶

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

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

`_clear_state(self, manager)`¶

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

`_make_control_state(self, manager)`¶

class `Component(ControlManager)`¶

`init(self, name='', parent=None, register_component=None, song=None, layer=None, is_enabled=True, *a, **k)`¶

`_add_child(self, component)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_update_is_enabled(self)`¶

`add_children(self, *a)`¶

`add_control(self, name, control)`¶

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

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

`on_enabled_changed(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`remove_enabled_listener(self, slot)`¶

`set_enabled(self, enable)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

class `EventObject(CompoundDisconnectable)`¶

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

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`unregister_disconnectable(self, slot)`¶

class `SceneComponent(Component)`¶

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

`_add_child(self, component)`¶

`_color_value(self, color)`¶

`_create_clip_slot(self)`¶

`_determine_actual_track_offset(self, tracks)`¶

`_do_delete_scene(self, scene_for_overrides)`¶

`_do_duplicate_scene(self, scene_for_overrides)`¶

`_do_launch_scene(self, value)`¶

`_do_select_scene(self, scene_for_overrides)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_on_launch_button_pressed(self)`¶

`_on_launch_button_released(self)`¶

`_on_scene_deleted(self)`¶

`_on_scene_duplicated(self)`¶

`_on_scene_selected(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_update_controlled_tracks(self)`¶

`_update_is_enabled(self)`¶

`_update_launch_button(self)`¶

`add_children(self, *a)`¶

`add_control(self, name, control)`¶

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

`build_clip_slot_list(self)`¶

`clip_slot(self, index)`¶

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

`control_notifications_enabled(self)`¶