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

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

Functions¶

`depends(**dependencies)`¶

`display_name(obj: Union[Scene.Scene, Clip.Clip, ClipSlot.ClipSlot, DeviceParameter.DeviceParameter], strip_space=True)`¶

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

`liveobj_changed(obj, other)`¶

`liveobj_valid(obj)`¶

`scene_index(scene=None)`¶

Classes¶

class `ButtonControl(ButtonControlBase)`¶

Properties¶

double_clicked
pressed
pressed_delayed
released
released_delayed
released_immediately
value

Methods¶

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

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

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

`_clear_state(self, manager)`¶

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

`_make_control_state(self, manager)`¶

Attributes¶

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

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

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

`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.
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x163a2a898>
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
delete_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163a636d8>
duplicate_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163a63710>
include_in_top_level_state = False - bool(x) -> bool
launch_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163a63668>
num_layers = 0 - int([x]) -> integer
renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>
select_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163a636a0>

class `Component(ControlManager)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

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

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

`_add_child(self, component)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_update_is_enabled(self)`¶

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

`add_children(self, *children)`¶

`add_control(self, name, control)`¶

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

`any_clipboard_has_content_has_listener(self, slot)`¶

`any_clipboard_has_content_listener_count(self)`¶

`control_notifications_enabled(self)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`enabled_has_listener(self, slot)`¶

`enabled_listener_count(self)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`is_enabled(self, explicit=False)`¶

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

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

`on_enabled_changed(self)`¶

`register_clipboard(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`remove_any_clipboard_has_content_listener(self, slot)`¶

`remove_enabled_listener(self, slot)`¶

`set_enabled(self, enable)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

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

class `LiveObjSkinEntry(tuple)`¶

LiveObjSkinEntry(name, liveobj)

Properties¶

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

Methods¶

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

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

`_asdict(self)`¶

`_make(iterable)`¶

Make a new LiveObjSkinEntry object from a sequence or iterable

`_replace(_self, **kwds)`¶

Return a new LiveObjSkinEntry object replacing specified fields with new values

`count(self, value, /)`¶

Return number of occurrences of value.

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

Return first index of value.

Raises ValueError if the value is not present.

Attributes¶

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

class `Renderable(CompoundDisconnectable)`¶

Methods¶

`init(self, react=None, notifications: 'Optional[Type[Notifications]]' = None, suppress_notifications: 'Optional[Callable]' = None, *a, **k)`¶

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

`_create_event_handler(self, property_name)`¶

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

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

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

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

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

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

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

Attributes¶

include_in_top_level_state = True - bool(x) -> bool
renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

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

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

`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.
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x163a2a898>
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
delete_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163b78d68>
duplicate_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163b78da0>
include_in_top_level_state = False - bool(x) -> bool
launch_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163b78cf8>
num_layers = 0 - int([x]) -> integer
renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>
select_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163b78d30>

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

Functions¶

depends(**dependencies)¶

display_name(obj: Union[Scene.Scene, Clip.Clip, ClipSlot.ClipSlot, DeviceParameter.DeviceParameter], strip_space=True)¶

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

liveobj_changed(obj, other)¶

liveobj_valid(obj)¶

scene_index(scene=None)¶

Classes¶

class ButtonControl(ButtonControlBase)¶

Properties¶

Methods¶

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

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

_clear_state(self, manager)¶

_get_state(self, manager, state_factory=None)¶

_make_control_state(self, manager)¶

Attributes¶

class ClipSlotComponent(Component, Renderable)¶

Properties¶

Methods¶

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

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

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

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¶

class Component(ControlManager)¶

Properties¶

Methods¶

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

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

`depends(**dependencies)`¶

`display_name(obj: Union[Scene.Scene, Clip.Clip, ClipSlot.ClipSlot, DeviceParameter.DeviceParameter], strip_space=True)`¶

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

`liveobj_changed(obj, other)`¶

`liveobj_valid(obj)`¶

`scene_index(scene=None)`¶

class `ButtonControl(ButtonControlBase)`¶

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

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

`_clear_state(self, manager)`¶

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

`_make_control_state(self, manager)`¶

class `ClipSlotComponent(Component, Renderable)`¶

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

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

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

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

class `Component(ControlManager)`¶

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

`_add_child(self, component)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_update_is_enabled(self)`¶

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

`add_children(self, *children)`¶

`add_control(self, name, control)`¶