ableton.v3.control_surface.components.session (runtime)¶
Live 11 — Live Object Model & framework reference (descriptions and signatures).
Functions¶
const(value)¶
control_list(control_type, *a, **k)¶
depends(**dependencies)¶
inject(**k)¶
listens(event_path, *a, **k)¶
listens_group(event_name, *a, **k)¶
liveobj_valid(obj)¶
Classes¶
class ButtonControl(ButtonControlBase)¶
Properties¶
double_clickedpressedpressed_delayedreleasedreleased_delayedreleased_immediatelyvalue
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 ClipSlotClipboardComponent(ClipboardComponent)¶
Properties¶
applicationis_rootlayerparentsong
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)¶
_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)¶
set_copy_button(self, button)¶
set_enabled(self, enable)¶
suppress_notifications(self)¶
unregister_disconnectable(self, slot)¶
update(self)¶
Attributes¶
_clipboard_component_instances=[]- Built-in mutable sequence._tasks=<ableton.v2.base.util.lazy_attribute object at 0x163a2a898>any_clipboard_has_content=False- bool(x) -> boolcanonical_parent=Nonecopy_button=<ableton.v3.control_surface.controls.button.ButtonControl object at 0x163a6b0b8>has_content=False- bool(x) -> boolinclude_in_top_level_state=True- bool(x) -> boolis_copying=False- bool(x) -> boolnum_layers=0- int([x]) -> integerrenderable_state=<ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>
class ClipboardComponent(Component, Renderable)¶
Properties¶
applicationis_rootlayerparentsong
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)¶
_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)¶
set_copy_button(self, button)¶
set_enabled(self, enable)¶
suppress_notifications(self)¶
unregister_disconnectable(self, slot)¶
update(self)¶
Attributes¶
_clipboard_component_instances=[]- Built-in mutable sequence._tasks=<ableton.v2.base.util.lazy_attribute object at 0x163a2a898>any_clipboard_has_content=False- bool(x) -> boolcanonical_parent=Nonecopy_button=<ableton.v3.control_surface.controls.button.ButtonControl object at 0x163a6b0b8>has_content=False- bool(x) -> boolinclude_in_top_level_state=True- bool(x) -> boolis_copying=False- bool(x) -> boolnum_layers=0- int([x]) -> integerrenderable_state=<ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>
class Component(ControlManager)¶
Properties¶
applicationis_rootlayerparentsong
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) -> boolcanonical_parent=Nonenum_layers=0- int([x]) -> integer
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) -> boolrenderable_state=<ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>
class SceneComponent(Component, Renderable)¶
Properties¶
applicationis_rootlayerparentscenesong
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) -> boolcanonical_parent=Nonedelete_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) -> boollaunch_button=<ableton.v3.control_surface.controls.button.ButtonControl object at 0x163b78cf8>num_layers=0- int([x]) -> integerrenderable_state=<ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>select_button=<ableton.v3.control_surface.controls.button.ButtonControl object at 0x163b78d30>
class SessionComponent(Component, Renderable)¶
Properties¶
applicationclipboardis_rootlayerparentsong
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)¶
_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)¶
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_tasks=<ableton.v2.base.util.lazy_attribute object at 0x163a2a898>any_clipboard_has_content=False- bool(x) -> boolcanonical_parent=Noneinclude_in_top_level_state=True- bool(x) -> boolnum_layers=0- int([x]) -> integerrenderable_state=<ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>stop_all_clips_button=<ableton.v3.control_surface.controls.button.ButtonControl object at 0x163b81d30>stop_track_clip_buttons=<ableton.v2.base.util.Mixin_ControlList_ButtonControl object at 0x163b81da0>
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.
class listenable_property(listenable_property_base, property)¶
Property attribute.
fget function to be used for getting an attribute value fset function to be used for setting an attribute value fdel function to be used for del'ing an attribute doc docstring
Typical use is to define a managed attribute x:
class C(object): def getx(self): return self._x def setx(self, value): self._x = value def delx(self): del self._x x = property(getx, setx, delx, "I'm the 'x' property.")
Decorators make defining new properties or modifying existing ones easy:
class C(object): @property def x(self): "I am the 'x' property." return self._x @x.setter def x(self, value): self._x = value @x.deleter def x(self): del self._x
Methods¶
__init__(self, /, *args, **kwargs)¶
Initialize self. See help(type(self)) for accurate signature.
deleter(...)¶
Descriptor to change the deleter on a property.
getter(...)¶
Descriptor to change the getter on a property.
managed(default_value)¶
set_property_name(self, name)¶
setter(...)¶
Descriptor to change the setter on a property.
Attributes¶
fdel=<member 'fdel' of 'property' objects>fget=<member 'fget' of 'property' objects>fset=<member 'fset' of 'property' objects>
class zip_longest¶
zip_longest(iter1 [,iter2 [...]], [fillvalue=None]) --> zip_longest object
Return a zip_longest object whose .next() method returns a tuple where the i-th element comes from the i-th iterable argument. The .next() method continues until the longest iterable in the argument sequence is exhausted and then it raises StopIteration. When the shorter iterables are exhausted, the fillvalue is substituted in their place. The fillvalue defaults to None or can be specified by a keyword argument.
Methods¶
__init__(self, /, *args, **kwargs)¶
Initialize self. See help(type(self)) for accurate signature.