Skip to content

ableton.v2.control_surface.components.scene (runtime)

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

Functions

find_nearest_color(rgb_table, src_hex_color)

is_button_pressed(button)

listens(event_path, *a, **k)

liveobj_changed(obj, other)

liveobj_valid(obj)

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 ClipSlotComponent(Component)

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)
_color_value(self, slot_or_clip)
_do_delete_clip(self)
_do_duplicate_clip(self)
_do_launch_clip(self, fire_state)
_do_select_clip(self, clip_slot)
_feedback_value(self, track, slot_or_clip)
_get_layer_iterable(self)
_grab_all_layers(self)
_internal_on_enabled_changed(self)
_on_clip_deleted(self)
_on_clip_duplicated(self)
_on_launch_button_pressed(self)
_on_launch_button_released(self)
_on_slot_selected(self)
_release_all_layers(self)
_set_enabled_recursive(self, enable)
_show_launched_clip_as_highlighted_clip(self)
_track_is_armed(self, track)
_update_clip_property_slots(self)
_update_is_enabled(self)
_update_launch_button_color(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_clip(self)
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_clip_palette(self, palette)
set_clip_rgb_table(self, rgb_table)
set_clip_slot(self, clip_slot)
set_delete_button(self, button)
set_duplicate_button(self, button)
set_enabled(self, enable)
set_launch_button(self, button)
set_select_button(self, button)
unregister_disconnectable(self, slot)
update(self)

Attributes

  • _ClipSlotComponent__on_arm_value_changed = None
  • _ClipSlotComponent__on_clip_color_changed = None
  • _ClipSlotComponent__on_clip_playing_state_changed = None
  • _ClipSlotComponent__on_clip_slot_color_changed = None
  • _ClipSlotComponent__on_clip_state_changed = None
  • _ClipSlotComponent__on_controls_other_clips_changed = None
  • _ClipSlotComponent__on_has_stop_button_changed = None
  • _ClipSlotComponent__on_implicit_arm_value_changed = None
  • _ClipSlotComponent__on_input_routing_type_changed = None
  • _ClipSlotComponent__on_recording_state_changed = None
  • _ClipSlotComponent__on_slot_playing_state_changed = None
  • _ClipSlotComponent__on_slot_triggered_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 0x1634b4cc0>
  • name = '' - str(object='') -> str

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