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

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

Functions¶

`depends(**dependencies)`¶

`letter_to_index(letter)`¶

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

Classes¶

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

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

`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.
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x163a2a898>
any_clipboard_has_content = False - bool(x) -> bool
arm_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163a5c208>
canonical_parent = None
crossfade_cycle_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163a5c240>
include_in_top_level_state = False - bool(x) -> bool
indexed_send_controls = <ableton.v2.base.util.Mixin_ControlList_MappedControl object at 0x163a5c128>
mute_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163a5c198>
num_layers = 0 - int([x]) -> integer
pan_control = <ableton.v2.control_surface.control.mapped.MappedControl object at 0x163a5c0b8>
renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>
send_controls = <ableton.v2.base.util.Mixin_ControlList_MappedControl object at 0x163a5c0f0>
shift_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163a5c278>
solo_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163a5c1d0>
track_select_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163a5c160>
volume_control = <ableton.v2.control_surface.control.mapped.MappedControl object at 0x163a53908>

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

Properties¶

value

Methods¶

`State(control=None, manager=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¶

_extra_args = [] - Built-in mutable sequence.
_extra_kws = {} - dict() -> new empty dictionary

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

`_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.
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x163a2a898>
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
crossfader_control = <ableton.v2.control_surface.control.mapped.MappedControl object at 0x163b5dc50>
num_layers = 0 - int([x]) -> integer
prehear_volume_control = <ableton.v2.control_surface.control.mapped.MappedControl object at 0x163b5dc18>

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

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

`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.
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x163a2a898>
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
cycle_send_index_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163b65438>
include_in_top_level_state = True - bool(x) -> bool
next_send_index_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163b654a8>
num_layers = 0 - int([x]) -> integer
prev_send_index_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163b65470>
renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

class `partial`¶

partial(func, args, *keywords) - new function with partial application of the given arguments and keywords.

Methods¶

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

Call self as a function.

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

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

Attributes¶

args = <member 'args' of 'functools.partial' objects> - tuple of arguments to future partial calls
func = <member 'func' of 'functools.partial' objects> - function object to use in future partial calls
keywords = <member 'keywords' of 'functools.partial' objects> - dictionary of keyword arguments to future partial calls

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.

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

Functions¶

depends(**dependencies)¶

letter_to_index(letter)¶

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

Classes¶

class ChannelStripComponent(Component, Renderable)¶

Properties¶

Methods¶

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

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

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

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¶

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

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

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

`depends(**dependencies)`¶

`letter_to_index(letter)`¶

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

class `ChannelStripComponent(Component, Renderable)`¶

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

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

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

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

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

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