Skip to content

ableton.v2.control_surface (runtime)

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

Module constants

  • BANK_FORMAT = 'Bank %d'
  • BANK_MAIN_KEY = 'Main'
  • BANK_PARAMETERS_KEY = 'Parameters'
  • DEFAULT_PRIORITY = 0
  • MIDI_CC_TYPE = 1
  • MIDI_INVALID_TYPE = 4
  • MIDI_NOTE_TYPE = 0
  • MIDI_PB_TYPE = 2
  • MIDI_SYSEX_TYPE = 3
  • MX_MAIN_BANK_INDEX = -1

Functions

BoolWrappingParameter(property_host=None, source_property=None, *, from_property_value=<function <lambda> at 0x1631d9ea0>, to_property_value=<function <lambda> at 0x1631d9c80>, display_value_conversion=<function <lambda> at 0x1631d9f28>, value_items=['Off', 'On'], **k)

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

all_parameters(device)

create_device_bank(device, banking_info)

device_bank_definition(device, definitions)

device_to_appoint(device)

find_instrument_devices(track_or_chain)

find_instrument_meeting_requirement(requirement, track_or_chain)

get_element(obj, element_container=None)

get_parameter_by_name(decorator, name)

is_parameter_quantized(parameter, parent_device)

merge_skins(*skins)

select_and_appoint_device(song, device_to_select, ignore_unmapped_macros=True)

to_percentage_display(value)

use(parameter_name)

Classes

class BackgroundLayer(LayerBase)

Properties

  • owner
  • priority

Methods

__init__(self, *elements, **k)

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

get_owner(self)
grab(self, client, *a, **k)
on_lost(self, client)
on_received(self, client, *a, **k)
release(self, client)
set_control_element(self, control_element, grabbed)

class BankingInfo

Methods

__init__(self, bank_definitions)

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

device_bank_count(self, device, **k)
device_bank_definition(self, device)
device_bank_names(self, device, **k)
has_bank_count(self, device)
has_bank_names(self, device)
has_main_bank(self, device)

class ClipCreator

Methods

__init__(self, /, *args, **kwargs)

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

create(self, slot, length=None, launch_quantization=None, legato_launch=None)

Attributes

  • fixed_length = 8 - int([x]) -> integer
  • grid_quantization = None
  • is_grid_triplet = False - bool(x) -> bool
  • legato_launch = True - bool(x) -> bool

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 CompoundElement(NotifyingControlElement, ControlElementClient)

Properties

  • resource

Methods

ProxiedInterface(outer=None, *a, **k)
__init__(self, control_elements=None, *a, **k)

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

_connect_nested_control_elements(self)
_disconnect_nested_control_elements(self)
_get_nested_client(self, client)
_grab_nested_control_elements(self, client, priority=None, **k)
_on_nested_control_element_lost(self, control)
_on_nested_control_element_received(self, control)
_on_resource_lost(self, client)
_on_resource_received(self, client, *a, **k)
_release_nested_control_elements(self, client)
_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)
add_value_listener(self, *a, **k)

Called when the control element receives a MIDI value from the hardware

clear_send_cache(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
get_control_element_priority(self, element, priority)
has_control_element(self, control)
has_disconnectable(self, slot)
nested_control_elements(self)
notify_ownership_change(self, client, grabbed, element_ownership_handler=None)
notify_value(self, *a, **k)

Called when the control element receives a MIDI value from the hardware

on_nested_control_element_lost(self, control)
on_nested_control_element_received(self, control)
on_nested_control_element_value(self, value, control)
owned_control_elements(self)
owns_control_element(self, control)
register_control_element(self, element)
register_control_elements(self, *elements)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_value_listener(self, *a, **k)

Called when the control element receives a MIDI value from the hardware

request_listen_nested_control_elements(self)
reset(self)
reset_state(self)
send_midi(self, message)
set_control_element(self, control, grabbed)
unregister_control_element(self, element)
unregister_control_elements(self, *elements)
unregister_disconnectable(self, slot)
unrequest_listen_nested_control_elements(self)
value_has_listener(self, slot)

Called when the control element receives a MIDI value from the hardware

value_listener_count(self)

Called when the control element receives a MIDI value from the hardware

Attributes

  • _CompoundElement__on_nested_control_element_value = None
  • _has_resource = False - bool(x) -> bool
  • _has_task_group = False - bool(x) -> bool
  • _is_resource_based = False - bool(x) -> bool
  • _resource = <ableton.v2.base.util.lazy_attribute object at 0x11b312780>
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x1630c8898>
  • canonical_parent = None
  • name = '' - str(object='') -> str
  • optimized_send_midi = True - bool(x) -> bool
  • proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>

class CompoundLayer(CompoundResource)

Properties

  • first
  • owner
  • priority
  • second

Methods

__init__(self, first_resource=None, second_resource=None, *a, **k)

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

get_owner(self)
grab(self, client, *a, **k)
release(self, client)

class CompoundResource(Resource)

Properties

  • first
  • owner
  • second

Methods

__init__(self, first_resource=None, second_resource=None, *a, **k)

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

get_owner(self)
grab(self, client, *a, **k)
release(self, client)

class ControlElement(Disconnectable)

Properties

  • resource

Methods

ProxiedInterface(outer=None, *a, **k)
__init__(self, name='', is_private=False, resource_type=None, optimized_send_midi=None, send_midi=None, register_control=None, *a, **k)

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

_on_resource_lost(self, client)
_on_resource_received(self, client, *a, **k)
_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)
clear_send_cache(self)
disconnect(self)
notify_ownership_change(self, client, grabbed, element_ownership_handler=None)
reset(self)
reset_state(self)
send_midi(self, message)

Attributes

  • _has_resource = False - bool(x) -> bool
  • _has_task_group = False - bool(x) -> bool
  • _resource = <ableton.v2.base.util.lazy_attribute object at 0x11b312780>
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x1630c8898>
  • canonical_parent = None
  • name = '' - str(object='') -> str
  • optimized_send_midi = True - bool(x) -> bool
  • proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>

class ControlElementClient

Methods

__init__(self, /, *args, **kwargs)

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

set_control_element(self, control_element, grabbed)

class ControlSurface(SimpleControlSurface)

Properties

  • _tasks
  • application
  • components
  • controls
  • device_provider
  • root_components
  • song

Methods

__init__(self, *a, **k)

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

_component_guard(self)
_disconnect_and_unregister_all_components(self)
_do_receive_midi(self, midi_bytes)
_do_receive_midi_chunk(self, midi_chunk)
_do_send_midi(self, midi_event_bytes)
_flush_midi_messages(self)
_get_tasks(self)
_init_device_provider(self)
_install_forwarding(self, midi_map_handle, control, forwarding_type=1)
_install_mapping(self, midi_map_handle, control, parameter, feedback_delay, feedback_map)
_merge_midi_data(recipient, data, midi_data)
_pre_serialize(self)
_receive_midi_data(recipient, data)
_register_component(self, component)
_register_control(self, control)
_send_midi(self, midi_event_bytes, optimized=True)
_set_suppress_rebuild_requests(self, suppress_requests)
_translate_message(self, type, from_identifier, from_channel, to_identifier, to_channel)
accumulating_midi_messages(self)
add_disconnect_listener(self, slot, identify_sender=False, *a, **k)
add_received_midi_listener(self, slot, identify_sender=False, *a, **k)
build_midi_map(self, midi_map_handle)
call_listeners(self, listeners)
can_lock_to_devices(self)
component_guard(self)
connect_script_instances(self, instanciated_scripts)
device_provider_class(song=None, *a, **k)
disconnect(self)
disconnect_disconnectable(self, slot)
disconnect_has_listener(self, slot)
disconnect_listener_count(self)
find_disconnectable(self, predicate)
get_component_by_name(self, component_name)
get_control_by_name(self, control_name)
get_recipient_for_nonsysex_midi_message(self, midi_bytes)
get_registry_entry_for_sysex_midi_message(self, midi_bytes)
has_disconnectable(self, slot)
lock_to_device(self, device)
notify_disconnect(self, *a, **k)
notify_received_midi(self, *a, **k)
port_settings_changed(self)
process_midi_bytes(self, midi_bytes, midi_processor)
receive_midi(self, midi_bytes)
receive_midi_chunk(self, midi_chunk)
received_midi_has_listener(self, slot)
received_midi_listener_count(self)
refresh_state(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
release_controlled_track(self)
remove_disconnect_listener(self, slot)
remove_received_midi_listener(self, slot)
request_rebuild_midi_map(self)
restore_bank(self, bank_index)
schedule_message(self, delay_in_ticks, callback, parameter=None)
set_controlled_track(self, track)
set_enabled(self, enable)
set_feedback_channels(self, channels)
set_pad_translations(self, pad_translations)
show_message(self, message)
suggest_map_mode(self, cc_no, channel)
supports_pad_translation(self)
suppressing_rebuild_requests(self)
toggle_lock(self)
unlock_from_device(self, device)
unregister_disconnectable(self, slot)
update(self)
update_display(self)
update_display_hook(self)

Attributes

  • handle_undo_steps = False - bool(x) -> bool
  • preferences = <ableton.v2.base.util.lazy_attribute object at 0x11df16048>
  • preferences_key = None

class DecoratorFactory(CompoundDisconnectable)

Methods

__init__(self, *a, **k)

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

_decorator(live_object=None, additional_properties={})
_get_decorated_object(self, live_object, additional_properties, **k)
_should_be_decorated(device)
decorate(self, live_object, additional_properties={}, **k)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
sync_decorated_objects(self, keys)
unregister_disconnectable(self, slot)

class DelayDeviceDecorator(LiveObjectDecorator, EventObject)

Properties

  • options
  • parameters
  • proxied_interface

Methods

__init__(self, *a, **k)

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

_add_enum_parameter(self, name, values, default_value)
_add_non_automatable_enum_parameter(self, name, list, index)
_add_non_automatable_int_parameter(self, name, property_name, min, max, units)
_add_on_off_option(self, name, pname)
_add_switch_option(self, name, pname, labels)
_create_parameters(self)
_linked_state_needs_updating(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
proxy_old_hasattr(self, attr)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
unregister_disconnectable(self, slot)

Attributes

  • _DelayDeviceDecorator__on_channel_switch_changed = None
  • _DelayDeviceDecorator__on_linked_changed = None
  • _proxied_interface = None
  • _skip_wrapper_lookup = None
  • link_modes = ('Linked', 'Unlinked') - Built-in immutable sequence.
  • proxied_object = None
  • sync_modes = ('Time', 'Sync') - Built-in immutable sequence.

class DescribedDeviceParameterBank(DeviceParameterBank)

Properties

  • device
  • index
  • name
  • parameters

Methods

__init__(self, device=None, banking_info=None, *a, **k)

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

_adjust_index(self, index)
_calc_name(self)
_collect_parameters(self)
_content_slots(self)
_current_parameter_slots(self)
_get_index(self)
_is_index_valid(self, index)
_set_index(self, index)
_setup_dynamic_slots(self)
_update_parameters(self)
add_parameters_listener(self, slot, identify_sender=False, *a, **k)
bank_count(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
notify_parameters(self, *a, **k)
parameters_has_listener(self, slot)
parameters_listener_count(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_parameters_listener(self, slot)
unregister_disconnectable(self, slot)

Attributes

  • _on_parameters_changed = None
  • _on_slot_content_changed = None

class DeviceBankRegistry(EventObject)

Methods

__init__(self, *a, **k)

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

_find_device_bank_key(self, device)
add_device_bank_listener(self, slot, identify_sender=False, *a, **k)
compact_registry(self)
device_bank_has_listener(self, slot)
device_bank_listener_count(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
get_device_bank(self, device)
has_disconnectable(self, slot)
notify_device_bank(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_device_bank_listener(self, slot)
set_device_bank(self, device, bank)
unregister_disconnectable(self, slot)

class DeviceDecoratorFactory(DecoratorFactory)

Methods

__init__(self, *a, **k)

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

_decorator(live_object=None, additional_properties={})
_get_decorated_object(self, device, additional_properties, song=None, *a, **k)
_should_be_decorated(device)
decorate(self, live_object, additional_properties={}, **k)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
generate_decorated_device(device, additional_properties={}, song=None, *a, **k)
has_disconnectable(self, slot)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
sync_decorated_objects(self, keys)
unregister_disconnectable(self, slot)

Attributes

  • DECORATOR_CLASSES = {'Delay': <class 'ableton.v2.control_surface.delay_decoration.DelayDeviceDecorator'>, 'Drift': <class 'ableton.v2.control_surface.drift_decoration.DriftDeviceDe... - dict() -> new empty dictionary

class DeviceProvider(EventObject)

Properties

  • device
  • is_locked_to_device

Methods

__init__(self, song=None, *a, **k)

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

_appoint_device_from_song(self)
_update_appointed_device(self)
add_device_listener(self, slot, identify_sender=False, *a, **k)
add_is_locked_to_device_listener(self, slot, identify_sender=False, *a, **k)
device_has_listener(self, slot)
device_listener_count(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
is_locked_to_device_has_listener(self, slot)
is_locked_to_device_listener_count(self)
lock_to_device(self, device)
notify_device(self, *a, **k)
notify_is_locked_to_device(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_device_listener(self, slot)
remove_is_locked_to_device_listener(self, slot)
unlock_from_device(self)
unregister_disconnectable(self, slot)
update_device_selection(self)

Attributes

  • _DeviceProvider__on_appointed_device_changed = None
  • _DeviceProvider__on_chains_changed = None
  • _DeviceProvider__on_has_macro_mappings_changed = None
  • _DeviceProvider__on_selected_device_changed = None
  • _DeviceProvider__on_selected_track_changed = None
  • device_selection_follows_track_selection = True - bool(x) -> bool

class ElementOwnershipHandler

Methods

__init__(self, /, *args, **kwargs)

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

handle_ownership_change(self, control, client, status)

class EnumWrappingParameter(InternalParameterBase, PropertyHostMixin)

Properties

  • _live_ptr
  • automation_state
  • canonical_parent
  • default_value
  • display_value
  • max
  • min
  • name
  • original_name
  • short_value_items
  • state
  • value
  • value_items

Methods

__init__(self, parent=None, index_property_host=None, values_host=None, values_property=None, index_property=None, value_type=<class 'int'>, to_index_conversion=None, from_index_conversion=None, *a, **k)

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

_get_index(self)
_get_values(self)
_has_valid_parent(self)
_set_index(self, index)
add_automation_state_listener(self, slot, identify_sender=False, *a, **k)
add_name_listener(self, slot, identify_sender=False, *a, **k)
add_state_listener(self, slot, identify_sender=False, *a, **k)
add_value_items_listener(self, slot, identify_sender=False, *a, **k)
add_value_listener(self, slot, identify_sender=False, *a, **k)
automation_state_has_listener(self, slot)
automation_state_listener_count(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
name_has_listener(self, slot)
name_listener_count(self)
notify_automation_state(self, *a, **k)
notify_name(self, *a, **k)
notify_state(self, *a, **k)
notify_value(self, *a, **k)
notify_value_items(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_automation_state_listener(self, slot)
remove_name_listener(self, slot)
remove_state_listener(self, slot)
remove_value_items_listener(self, slot)
remove_value_listener(self, slot)
set_property_host(self, new_host)
state_has_listener(self, slot)
state_listener_count(self)
unregister_disconnectable(self, slot)
value_has_listener(self, slot)
value_items_has_listener(self, slot)
value_items_listener_count(self)
value_listener_count(self)

Attributes

  • is_enabled = True - bool(x) -> bool
  • is_quantized = True - bool(x) -> bool

class ExclusiveResource(Resource)

Properties

  • owner

Methods

__init__(self, on_received_callback=None, on_lost_callback=None, *a, **k)

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

get_owner(self)
grab(self, client, *a, **k)
on_lost(self, client)
on_received(self, client, *a, **k)
release(self, client)

class IdentifiableControlSurface(ControlSurface)

Properties

  • _tasks
  • application
  • components
  • controls
  • device_provider
  • root_components
  • song

Methods

__init__(self, product_id_bytes=None, *a, **k)

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

_component_guard(self)
_disconnect_and_unregister_all_components(self)
_do_receive_midi(self, midi_bytes)
_do_receive_midi_chunk(self, midi_chunk)
_do_send_midi(self, midi_event_bytes)
_extract_product_id_bytes(self, midi_bytes)
_flush_midi_messages(self)
_get_tasks(self)
_init_device_provider(self)
_install_forwarding(self, midi_map_handle, control, forwarding_type=1)
_install_mapping(self, midi_map_handle, control, parameter, feedback_delay, feedback_map)
_is_identity_response(self, midi_bytes)
_merge_midi_data(recipient, data, midi_data)
_pre_serialize(self)
_receive_midi_data(recipient, data)
_register_component(self, component)
_register_control(self, control)
_send_identity_request(self)
_send_midi(self, midi_event_bytes, optimized=True)
_set_suppress_rebuild_requests(self, suppress_requests)
_translate_message(self, type, from_identifier, from_channel, to_identifier, to_channel)
accumulating_midi_messages(self)
add_disconnect_listener(self, slot, identify_sender=False, *a, **k)
add_received_midi_listener(self, slot, identify_sender=False, *a, **k)
build_midi_map(self, midi_map_handle)
call_listeners(self, listeners)
can_lock_to_devices(self)
component_guard(self)
connect_script_instances(self, instanciated_scripts)
device_provider_class(song=None, *a, **k)
disconnect(self)
disconnect_disconnectable(self, slot)
disconnect_has_listener(self, slot)
disconnect_listener_count(self)
find_disconnectable(self, predicate)
get_component_by_name(self, component_name)
get_control_by_name(self, control_name)
get_recipient_for_nonsysex_midi_message(self, midi_bytes)
get_registry_entry_for_sysex_midi_message(self, midi_bytes)
has_disconnectable(self, slot)
lock_to_device(self, device)
notify_disconnect(self, *a, **k)
notify_received_midi(self, *a, **k)
on_identified(self, response_bytes)
port_settings_changed(self)
process_midi_bytes(self, midi_bytes, midi_processor)
receive_midi(self, midi_bytes)
receive_midi_chunk(self, midi_chunk)
received_midi_has_listener(self, slot)
received_midi_listener_count(self)
refresh_state(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
release_controlled_track(self)
remove_disconnect_listener(self, slot)
remove_received_midi_listener(self, slot)
request_rebuild_midi_map(self)
restore_bank(self, bank_index)
schedule_message(self, delay_in_ticks, callback, parameter=None)
set_controlled_track(self, track)
set_enabled(self, enable)
set_feedback_channels(self, channels)
set_pad_translations(self, pad_translations)
show_message(self, message)
suggest_map_mode(self, cc_no, channel)
supports_pad_translation(self)
suppressing_rebuild_requests(self)
toggle_lock(self)
unlock_from_device(self, device)
unregister_disconnectable(self, slot)
update(self)
update_display(self)
update_display_hook(self)

Attributes

  • handle_undo_steps = False - bool(x) -> bool
  • identity_request = (240, 126, 127, 6, 1, 247) - Built-in immutable sequence.
  • identity_request_delay = 0.0 - Convert a string or number to a floating point number, if possible.
  • preferences = <ableton.v2.base.util.lazy_attribute object at 0x11df16048>
  • preferences_key = None

class InputControlElement(NotifyingControlElement)

Properties

  • _last_sent_value
  • is_feedback_enabled
  • mapping_sensitivity
  • resource
  • script_forwarding
  • send_depends_on_forwarding
  • suppress_script_forwarding

Methods

ProxiedInterface(outer=None, *a, **k)
__init__(self, msg_type=None, channel=None, identifier=None, sysex_identifier=None, request_rebuild_midi_map=None, send_should_depend_on_forwarding=True, is_feedback_enabled=True, *a, **k)

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

_do_send_value(self, value, channel=None)
_mapping_feedback_values(self)
_on_resource_lost(self, client)
_on_resource_received(self, client, *a, **k)
_report_value(self, value, is_input)
_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)
_send_delayed_messages(self)
_status_byte(self, channel)
_verify_value(self, value)
add_value_listener(self, slot, identify_sender=False, *a, **k)
begin_gesture(self)
clear_send_cache(self)
connect_to(self, parameter)
disconnect(self)
disconnect_disconnectable(self, slot)
end_gesture(self)
find_disconnectable(self, predicate)
force_next_send(self)
has_disconnectable(self, slot)
identifier_bytes(self)
install_connections(self, install_translation, install_mapping, install_forwarding)
mapped_parameter(self)
max_value(self)
message_channel(self)
message_identifier(self)
message_map_mode(self)
message_sysex_identifier(self)
message_type(self)
needs_takeover(self)
notify_ownership_change(self, client, grabbed, element_ownership_handler=None)
notify_value(self, *a, **k)
original_channel(self)
original_identifier(self)
receive_chunk(self, chunk)
receive_value(self, value)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
release_parameter(self)
remove_value_listener(self, slot)
reset(self)
reset_state(self)
script_wants_forwarding(self)
send_midi(self, message)
send_value(self, value, force=False, channel=None)
set_channel(self, channel)
set_feedback_delay(self, delay)
set_identifier(self, identifier)
set_needs_takeover(self, needs_takeover)
set_report_values(self, report_input, report_output)
unregister_disconnectable(self, slot)
use_default_message(self)
value_has_listener(self, slot)
value_listener_count(self)

Attributes

  • _has_resource = False - bool(x) -> bool
  • _has_task_group = False - bool(x) -> bool
  • _input_signal_listener_count = 0 - int([x]) -> integer
  • _resource = <ableton.v2.base.util.lazy_attribute object at 0x11b312780>
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x1630c8898>
  • allow_receiving_chunks = False - bool(x) -> bool
  • canonical_parent = None
  • name = '' - str(object='') -> str
  • num_delayed_messages = 1 - int([x]) -> integer
  • optimized_send_midi = True - bool(x) -> bool
  • proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>

class InputSignal(Signal)

Properties

  • count

Methods

__call__(self, *a, **k)

Call self as a function.

__init__(self, sender=None, *a, **k)

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

_listeners_update(self)
connect(self, *a, **k)
disconnect(self, *a, **k)
disconnect_all(self, *a, **k)
is_connected(self, slot)

class IntegerParameter(InternalParameter)

Properties

  • _live_ptr
  • _max_index
  • _min_index
  • automation_state
  • canonical_parent
  • default_value
  • display_value
  • is_quantized - bool(x) -> bool
  • linear_value
  • max
  • min
  • name
  • original_name
  • short_value_items
  • state
  • value
  • value_items

Methods

__init__(self, integer_value_host=None, integer_value_property_name=None, min_value=None, max_value=None, show_as_quantized=False, *a, **k)

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

_get_integer_value(self)
_get_linear_value(self)
_get_value(self)
_has_valid_parent(self)
_index_from_value(self, value)
_index_to_value(self, index)
_set_integer_value(self, new_value)
_set_linear_value(self, new_value)
_set_value(self, new_value)
add_automation_state_listener(self, slot, identify_sender=False, *a, **k)
add_name_listener(self, slot, identify_sender=False, *a, **k)
add_state_listener(self, slot, identify_sender=False, *a, **k)
add_value_listener(self, slot, identify_sender=False, *a, **k)
automation_state_has_listener(self, slot)
automation_state_listener_count(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
name_has_listener(self, slot)
name_listener_count(self)
notify_automation_state(self, *a, **k)
notify_name(self, *a, **k)
notify_state(self, *a, **k)
notify_value(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_automation_state_listener(self, slot)
remove_name_listener(self, slot)
remove_state_listener(self, slot)
remove_value_listener(self, slot)
set_display_value_conversion(self, display_value_conversion)
set_scaling_functions(self, to_internal, from_internal)
state_has_listener(self, slot)
state_listener_count(self)
unregister_disconnectable(self, slot)
value_has_listener(self, slot)
value_listener_count(self)

Attributes

  • is_enabled = True - bool(x) -> bool

class InternalParameter(InternalParameterBase)

Properties

  • _live_ptr
  • automation_state
  • canonical_parent
  • default_value
  • display_value
  • linear_value
  • max
  • min
  • name
  • original_name
  • state
  • value

Methods

__init__(self, parent=None, display_value_conversion=None, *a, **k)

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

_get_linear_value(self)
_get_value(self)
_has_valid_parent(self)
_set_linear_value(self, new_value)
_set_value(self, new_value)
add_automation_state_listener(self, slot, identify_sender=False, *a, **k)
add_name_listener(self, slot, identify_sender=False, *a, **k)
add_state_listener(self, slot, identify_sender=False, *a, **k)
add_value_listener(self, slot, identify_sender=False, *a, **k)
automation_state_has_listener(self, slot)
automation_state_listener_count(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
name_has_listener(self, slot)
name_listener_count(self)
notify_automation_state(self, *a, **k)
notify_name(self, *a, **k)
notify_state(self, *a, **k)
notify_value(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_automation_state_listener(self, slot)
remove_name_listener(self, slot)
remove_state_listener(self, slot)
remove_value_listener(self, slot)
set_display_value_conversion(self, display_value_conversion)
set_scaling_functions(self, to_internal, from_internal)
state_has_listener(self, slot)
state_listener_count(self)
unregister_disconnectable(self, slot)
value_has_listener(self, slot)
value_listener_count(self)

Attributes

  • is_enabled = True - bool(x) -> bool
  • is_quantized = False - bool(x) -> bool

class InternalParameterBase(EventObject)

Properties

  • _live_ptr
  • automation_state
  • canonical_parent
  • default_value
  • display_value
  • max
  • min
  • name
  • original_name
  • state
  • value

Methods

__init__(self, name=None, *a, **k)

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

_has_valid_parent(self)
add_automation_state_listener(self, slot, identify_sender=False, *a, **k)
add_name_listener(self, slot, identify_sender=False, *a, **k)
add_state_listener(self, slot, identify_sender=False, *a, **k)
automation_state_has_listener(self, slot)
automation_state_listener_count(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
name_has_listener(self, slot)
name_listener_count(self)
notify_automation_state(self, *a, **k)
notify_name(self, *a, **k)
notify_state(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_automation_state_listener(self, slot)
remove_name_listener(self, slot)
remove_state_listener(self, slot)
state_has_listener(self, slot)
state_listener_count(self)
unregister_disconnectable(self, slot)

Attributes

  • is_enabled = True - bool(x) -> bool
  • is_quantized = False - bool(x) -> bool

class Layer(LayerBase)

Properties

  • owner
  • priority

Methods

__init__(self, priority=None, **elements)

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

_get_control_client(self, client)
get_owner(self)
grab(self, client, *a, **k)
on_lost(self, client)
on_received(self, client, *a, **k)
release(self, client)

class LayerClient(ControlElementClient)

Methods

__init__(self, layer=None, layer_client=None, *a, **k)

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

set_control_element(self, control_element, grabbed)

class LayerError(Exception)

Common base class for all non-exit exceptions.

Methods

__init__(self, /, *args, **kwargs)

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

with_traceback(...)

Exception.with_traceback(tb) -- set self.traceback to tb and return self.

Attributes

  • args = <attribute 'args' of 'BaseException' objects>

class LiveObjectDecorator(CompoundDisconnectable, Proxy)

Properties

  • options
  • parameters
  • proxied_interface

Methods

__init__(self, live_object=None, additional_properties={})

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

_add_enum_parameter(self, name, values, default_value)
_add_non_automatable_enum_parameter(self, name, list, index)
_add_non_automatable_int_parameter(self, name, property_name, min, max, units)
_add_on_off_option(self, name, pname)
_add_switch_option(self, name, pname, labels)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
proxy_old_hasattr(self, attr)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
unregister_disconnectable(self, slot)

Attributes

  • _proxied_interface = None
  • _skip_wrapper_lookup = None
  • proxied_object = None

class MessageScheduler

Properties

  • is_idling

Methods

__init__(self, send_message_callback, timer, on_state_changed_callback=<function const.<locals>.<lambda> at 0x1631b1b70>)

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

_process_queue(self)
_process_request(self, request)
_process_single_request(self)
_queue(self, request)
_set_state(self, new_state)
disconnect(self, owner)
grab(self, owner)
handle_message(self, message)
handle_timeout(self)
release(self, owner)
send(self, owner, message)
send_receive(self, owner, message, timeout)

class MidiMap(dict)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Methods

__init__(self, /, *args, **kwargs)

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

add_button(self, name, channel, number, midi_message_type)
add_matrix(self, name, element_factory, channel, numbers, midi_message_type)
clear(...)

D.clear() -> None. Remove all items from D.

copy(...)

D.copy() -> a shallow copy of D

fromkeys(iterable, value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(self, key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items(...)

D.items() -> a set-like object providing a view on D's items

keys(...)

D.keys() -> a set-like object providing a view on D's keys

pop(...)

D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

popitem(...)

D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

setdefault(self, key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update(...)

D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values(...)

D.values() -> an object providing a view on D's values

class NestedElementClient(ControlElementClient)

Methods

__init__(self, compound=None, client=None, **k)

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

set_control_element(self, element, grabbed)

class NotifyingControlElement(EventObject, ControlElement)

Properties

  • resource

Methods

ProxiedInterface(outer=None, *a, **k)
__init__(self, *a, **k)

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

_on_resource_lost(self, client)
_on_resource_received(self, client, *a, **k)
_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)
add_value_listener(self, slot, identify_sender=False, *a, **k)

Called when the control element receives a MIDI value from the hardware

clear_send_cache(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
notify_ownership_change(self, client, grabbed, element_ownership_handler=None)
notify_value(self, *a, **k)

Called when the control element receives a MIDI value from the hardware

register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_value_listener(self, slot)

Called when the control element receives a MIDI value from the hardware

reset(self)
reset_state(self)
send_midi(self, message)
unregister_disconnectable(self, slot)
value_has_listener(self, slot)

Called when the control element receives a MIDI value from the hardware

value_listener_count(self)

Called when the control element receives a MIDI value from the hardware

Attributes

  • _has_resource = False - bool(x) -> bool
  • _has_task_group = False - bool(x) -> bool
  • _resource = <ableton.v2.base.util.lazy_attribute object at 0x11b312780>
  • _tasks = <ableton.v2.base.util.lazy_attribute object at 0x1630c8898>
  • canonical_parent = None
  • name = '' - str(object='') -> str
  • optimized_send_midi = True - bool(x) -> bool
  • proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>

class NotifyingList(EventObject)

Properties

  • available_values
  • index

Methods

__init__(self, available_values, default_value=None, *a, **k)

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

_get_index(self)
_set_index(self, value)
add_index_listener(self, slot, identify_sender=False, *a, **k)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
index_has_listener(self, slot)
index_listener_count(self)
notify_index(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_index_listener(self, slot)
unregister_disconnectable(self, slot)

class OptimizedOwnershipHandler(ElementOwnershipHandler)

Methods

__init__(self, *a, **k)

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

commit_ownership_changes(self, traceback=None)
handle_ownership_change(self, control, client, status)

class ParameterInfo(NamedTuple)

Properties

  • name

Methods

__init__(self, name=None, *a, **k)

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

Attributes

  • _eq_dict = <ableton.v2.base.util.lazy_attribute object at 0x14df25080>
  • default_encoder_sensitivity = None
  • fine_grain_encoder_sensitivity = None
  • parameter = None

class ParameterProvider(EventObject)

Properties

  • parameters

Methods

__init__(self, *a, **k)

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

add_parameters_listener(self, slot, identify_sender=False, *a, **k)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
notify_parameters(self, *a, **k)
parameters_has_listener(self, slot)
parameters_listener_count(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_parameters_listener(self, slot)
unregister_disconnectable(self, slot)

class ParameterSlot(Disconnectable)

Properties

  • control
  • parameter

Methods

__init__(self, parameter=None, control=None, *a, **k)

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

connect(self)
disconnect(self)
soft_disconnect(self)

Attributes

  • _control = None
  • _parameter = None

class PercussionInstrumentFinder(Mode, EventObject)

Properties

  • device_parent
  • drum_group
  • is_enabled
  • sliced_simpler

Methods

__init__(self, device_parent=None, is_enabled=True, *a, **k)

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

_update_instruments(self)
_update_listeners(self)
add_instrument_listener(self, slot, identify_sender=False, *a, **k)
disconnect(self)
disconnect_disconnectable(self, slot)
enter_mode(self)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
instrument_has_listener(self, slot)
instrument_listener_count(self)
leave_mode(self)
notify_instrument(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_instrument_listener(self, slot)
unregister_disconnectable(self, slot)
update(self)

Attributes

  • _PercussionInstrumentFinder__on_chains_changed = None
  • _PercussionInstrumentFinder__on_devices_changed = None
  • _PercussionInstrumentFinder__on_slicing_changed = None
  • _drum_group = None
  • _simpler = None

class PitchParameter(InternalParameter)

Properties

  • _combined_value
  • _live_ptr
  • automation_state
  • canonical_parent
  • decimal_value_host
  • default_value
  • display_value
  • integer_value_host
  • linear_value
  • max
  • min
  • name
  • original_name
  • state
  • value

Methods

__init__(self, integer_value_host=None, decimal_value_host=None, *a, **k)

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

_get_linear_value(self)
_get_value(self)
_has_valid_parent(self)
_set_coarse(self, new_value)
_set_finegrain(self, new_value)
_set_linear_value(self, new_value)
_set_value(self, new_value)
add_automation_state_listener(self, slot, identify_sender=False, *a, **k)
add_linear_value_listener(self, slot, identify_sender=False, *a, **k)
add_name_listener(self, slot, identify_sender=False, *a, **k)
add_state_listener(self, slot, identify_sender=False, *a, **k)
add_value_listener(self, slot, identify_sender=False, *a, **k)
automation_state_has_listener(self, slot)
automation_state_listener_count(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
linear_value_has_listener(self, slot)
linear_value_listener_count(self)
name_has_listener(self, slot)
name_listener_count(self)
notify_automation_state(self, *a, **k)
notify_linear_value(self, *a, **k)
notify_name(self, *a, **k)
notify_state(self, *a, **k)
notify_value(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_automation_state_listener(self, slot)
remove_linear_value_listener(self, slot)
remove_name_listener(self, slot)
remove_state_listener(self, slot)
remove_value_listener(self, slot)
set_display_value_conversion(self, display_value_conversion)
set_scaling_functions(self, to_internal, from_internal)
state_has_listener(self, slot)
state_listener_count(self)
unregister_disconnectable(self, slot)
value_has_listener(self, slot)
value_listener_count(self)

Attributes

  • _on_decimal_value_automation_state_changed = None
  • _on_decimal_value_changed = None
  • _on_integer_value_automation_state_changed = None
  • _on_integer_value_changed = None
  • is_enabled = True - bool(x) -> bool
  • is_quantized = False - bool(x) -> bool

class PrioritizedResource(StackingResource)

Properties

  • clients
  • max_priority
  • owner
  • owners
  • stack_size

Methods

__init__(self, on_received_callback=None, on_lost_callback=None, *a, **k)

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

_actual_owners(self)
_add_client(self, client, priority)
_on_lost_set(self, clients)
_on_received_set(self, clients)
_remove_client(self, client)
get_owner(self)
grab(self, client, priority=None)
on_lost(self, client)
on_received(self, client)
release(self, client)
release_all(self)
release_stacked(self)

class ProxyResource(Proxy)

Properties

  • owner
  • owners
  • proxied_interface

Methods

__init__(self, proxied_resource=None, client_wrapper=<ableton.v2.control_surface.resource.ClientWrapper object at 0x1630c8748>, *a, **k)

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

grab(self, client, *a, **k)
proxy_old_hasattr(self, attr)
release(self, client, *a, **k)

Attributes

  • _proxied_interface = None
  • _skip_wrapper_lookup = None
  • proxied_object = None

class RelativeInternalParameter(InternalParameter)

Properties

  • _live_ptr
  • automation_state
  • canonical_parent
  • default_value
  • display_value
  • linear_value
  • max
  • min
  • name
  • original_name
  • state
  • value

Methods

__init__(self, parent=None, display_value_conversion=None, *a, **k)

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

_get_linear_value(self)
_get_value(self)
_has_valid_parent(self)
_set_linear_value(self, new_value)
_set_value(self, new_value)
add_automation_state_listener(self, slot, identify_sender=False, *a, **k)
add_delta_listener(self, slot, identify_sender=False, *a, **k)
add_name_listener(self, slot, identify_sender=False, *a, **k)
add_state_listener(self, slot, identify_sender=False, *a, **k)
add_value_listener(self, slot, identify_sender=False, *a, **k)
automation_state_has_listener(self, slot)
automation_state_listener_count(self)
delta_has_listener(self, slot)
delta_listener_count(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
name_has_listener(self, slot)
name_listener_count(self)
notify_automation_state(self, *a, **k)
notify_delta(self, *a, **k)
notify_name(self, *a, **k)
notify_state(self, *a, **k)
notify_value(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_automation_state_listener(self, slot)
remove_delta_listener(self, slot)
remove_name_listener(self, slot)
remove_state_listener(self, slot)
remove_value_listener(self, slot)
set_display_value_conversion(self, display_value_conversion)
set_scaling_functions(self, to_internal, from_internal)
state_has_listener(self, slot)
state_listener_count(self)
unregister_disconnectable(self, slot)
value_has_listener(self, slot)
value_listener_count(self)

Attributes

  • is_enabled = True - bool(x) -> bool
  • is_quantized = False - bool(x) -> bool

class Resource

Properties

  • owner

Methods

__init__(self, /, *args, **kwargs)

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

get_owner(self)
grab(self, client, *a, **k)
release(self, client)

class SessionRingSelectionLinking(EventObject)

Methods

__init__(self, session_ring=None, selection_changed_notifier=None, song=None, *a, **k)

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

_current_track(self)
_current_track_index(self)
_link_session_ring_with_minimal_travel(self)
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)

Attributes

  • _on_selection_scrolled = None

class SharedResource(Resource)

Properties

  • owner

Methods

__init__(self, on_received_callback=None, on_lost_callback=None, *a, **k)

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

get_owner(self)
grab(self, client, *a, **k)
on_lost(self, client)
on_received(self, client, *a, **k)
release(self, client)

class SimpleControlSurface(EventObject)

Properties

  • _tasks
  • application
  • components
  • controls
  • root_components
  • song

Methods

__init__(self, c_instance=None, *a, **k)

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

_component_guard(self)
_disconnect_and_unregister_all_components(self)
_do_receive_midi(self, midi_bytes)
_do_receive_midi_chunk(self, midi_chunk)
_do_send_midi(self, midi_event_bytes)
_flush_midi_messages(self)
_get_tasks(self)
_install_forwarding(self, midi_map_handle, control, forwarding_type=1)
_install_mapping(self, midi_map_handle, control, parameter, feedback_delay, feedback_map)
_merge_midi_data(recipient, data, midi_data)
_pre_serialize(self)
_receive_midi_data(recipient, data)
_register_component(self, component)
_register_control(self, control)
_send_midi(self, midi_event_bytes, optimized=True)
_set_suppress_rebuild_requests(self, suppress_requests)
_translate_message(self, type, from_identifier, from_channel, to_identifier, to_channel)
accumulating_midi_messages(self)
add_disconnect_listener(self, slot, identify_sender=False, *a, **k)
add_received_midi_listener(self, slot, identify_sender=False, *a, **k)
build_midi_map(self, midi_map_handle)
call_listeners(self, listeners)
can_lock_to_devices(self)
component_guard(self)
connect_script_instances(self, instanciated_scripts)
disconnect(self)
disconnect_disconnectable(self, slot)
disconnect_has_listener(self, slot)
disconnect_listener_count(self)
find_disconnectable(self, predicate)
get_component_by_name(self, component_name)
get_control_by_name(self, control_name)
get_recipient_for_nonsysex_midi_message(self, midi_bytes)
get_registry_entry_for_sysex_midi_message(self, midi_bytes)
has_disconnectable(self, slot)
notify_disconnect(self, *a, **k)
notify_received_midi(self, *a, **k)
port_settings_changed(self)
process_midi_bytes(self, midi_bytes, midi_processor)
receive_midi(self, midi_bytes)
receive_midi_chunk(self, midi_chunk)
received_midi_has_listener(self, slot)
received_midi_listener_count(self)
refresh_state(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
release_controlled_track(self)
remove_disconnect_listener(self, slot)
remove_received_midi_listener(self, slot)
request_rebuild_midi_map(self)
schedule_message(self, delay_in_ticks, callback, parameter=None)
set_controlled_track(self, track)
set_enabled(self, enable)
set_feedback_channels(self, channels)
set_pad_translations(self, pad_translations)
show_message(self, message)
suggest_map_mode(self, cc_no, channel)
supports_pad_translation(self)
suppressing_rebuild_requests(self)
unregister_disconnectable(self, slot)
update(self)
update_display(self)
update_display_hook(self)

Attributes

  • handle_undo_steps = False - bool(x) -> bool
  • preferences = <ableton.v2.base.util.lazy_attribute object at 0x11df16048>
  • preferences_key = None

class SimpleLayerOwner(Disconnectable)

Methods

__init__(self, layer=None)

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

disconnect(self)

class SimplerDeviceDecorator(EventObject, LiveObjectDecorator)

Properties

  • available_playback_modes
  • available_resolutions
  • available_slice_styles
  • available_slicing_beat_divisions
  • available_slicing_playback_modes
  • available_transient_loop_modes
  • available_voice_numbers
  • available_warp_modes
  • current_playback_mode
  • options
  • parameters
  • proxied_interface
  • slices

Methods

__init__(self, *a, **k)

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

_add_enum_parameter(self, name, values, default_value)
_add_non_automatable_enum_parameter(self, name, list, index)
_add_non_automatable_int_parameter(self, name, property_name, min, max, units)
_add_on_off_option(self, name, pname)
_add_switch_option(self, name, pname, labels)
_decorated_parameters(self)
_on_sample_changed(self)
_on_slices_changed(self)
_reconnect_sample_listeners(self)
_reconnect_to_slices(self)
add_current_playback_mode_listener(self, slot, identify_sender=False, *a, **k)
add_slices_listener(self, slot, identify_sender=False, *a, **k)
current_playback_mode_has_listener(self, slot)
current_playback_mode_listener_count(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
notify_current_playback_mode(self, *a, **k)
notify_slices(self, *a, **k)
proxy_old_hasattr(self, attr)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_current_playback_mode_listener(self, slot)
remove_slices_listener(self, slot)
setup_parameters(self)
slices_has_listener(self, slot)
slices_listener_count(self)
unregister_disconnectable(self, slot)

Attributes

  • _SimplerDeviceDecorator__on_playback_mode_changed = None
  • _SimplerDeviceDecorator__on_sample_changed = None
  • _SimplerDeviceDecorator__on_slices_changed = None
  • _proxied_interface = None
  • _skip_wrapper_lookup = None
  • proxied_object = None

class Skin(EventObject)

Methods

__init__(self, colors=None, song=None, *a, **k)

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

_create_dynamic_color(self, color_factory, song)
_fill_colors(self, colors, pathname='', song=None)
_get_dynamic_color(self, color_factory, song)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
items(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
unregister_disconnectable(self, slot)

class SkinColorMissingError(Exception)

Common base class for all non-exit exceptions.

Methods

__init__(self, /, *args, **kwargs)

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

with_traceback(...)

Exception.with_traceback(tb) -- set self.traceback to tb and return self.

Attributes

  • args = <attribute 'args' of 'BaseException' objects>

class StackingResource(Resource)

Properties

  • clients
  • max_priority
  • owner
  • owners
  • stack_size

Methods

__init__(self, on_received_callback=None, on_lost_callback=None, *a, **k)

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

_actual_owners(self)
_add_client(self, client, priority)
_on_lost_set(self, clients)
_on_received_set(self, clients)
_remove_client(self, client)
get_owner(self)
grab(self, client, priority=None)
on_lost(self, client)
on_received(self, client)
release(self, client)
release_all(self)
release_stacked(self)

class UnhandledElementError(LayerError)

Common base class for all non-exit exceptions.

Methods

__init__(self, /, *args, **kwargs)

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

with_traceback(...)

Exception.with_traceback(tb) -- set self.traceback to tb and return self.

Attributes

  • args = <attribute 'args' of 'BaseException' objects>

class WavetableDeviceDecorator(LiveObjectDecorator, EventObject)

Properties

  • options
  • parameters
  • proxied_interface

Methods

__init__(self, *a, **k)

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

_add_enum_parameter(self, name, values, default_value)
_add_non_automatable_enum_parameter(self, name, list, index)
_add_non_automatable_int_parameter(self, name, property_name, min, max, units)
_add_on_off_option(self, name, pname)
_add_switch_option(self, name, pname, labels)
_create_parameters(self)
_get_parameter_enabled_state(self, parameter)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
proxy_old_hasattr(self, attr)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
unregister_disconnectable(self, slot)

Attributes

  • MAX_UNISON_VOICE_COUNT = 8 - int([x]) -> integer
  • MIN_UNISON_VOICE_COUNT = 2 - int([x]) -> integer
  • _WavetableDeviceDecorator__on_osc_1_on_value_changed = None
  • _WavetableDeviceDecorator__on_osc_2_on_value_changed = None
  • _proxied_interface = None
  • _skip_wrapper_lookup = None
  • available_effect_modes = ('None', 'Fm', 'Classic', 'Modern') - Built-in immutable sequence.
  • available_filter_routings = ('Serial', 'Parallel', 'Split') - Built-in immutable sequence.
  • available_unison_modes = ('None', 'Classic', 'Shimmer', 'Noise', 'Phase Sync', 'Position Spread', 'Random Note') - Built-in immutable sequence.
  • mono_off_on_values = ('Off', 'On') - Built-in immutable sequence.
  • poly_voices_values = ('2', '3', '4', '5', '6', '7', '8') - Built-in immutable sequence.
  • proxied_object = None

class WavetableEnvelopeType(int)

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

Methods

__init__(self, /, *args, **kwargs)

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

bit_length(self, /)

Number of bits necessary to represent self in binary.

bin(37) '0b100101' (37).bit_length() 6

conjugate(...)

Returns self, the complex conjugate of any int.

from_bytes(bytes, byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol. byteorder The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. signed Indicates whether two's complement is used to represent the integer.

to_bytes(self, /, length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. byteorder The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. signed Determines whether two's complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

Attributes

  • amp = 0
  • denominator = <attribute 'denominator' of 'int' objects> - the denominator of a rational number in lowest terms
  • env2 = 1
  • env3 = 2
  • imag = <attribute 'imag' of 'int' objects> - the imaginary part of a complex number
  • numerator = <attribute 'numerator' of 'int' objects> - the numerator of a rational number in lowest terms
  • real = <attribute 'real' of 'int' objects> - the real part of a complex number

class WavetableFilterType(int)

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

Methods

__init__(self, /, *args, **kwargs)

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

bit_length(self, /)

Number of bits necessary to represent self in binary.

bin(37) '0b100101' (37).bit_length() 6

conjugate(...)

Returns self, the complex conjugate of any int.

from_bytes(bytes, byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol. byteorder The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. signed Indicates whether two's complement is used to represent the integer.

to_bytes(self, /, length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. byteorder The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. signed Determines whether two's complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

Attributes

  • denominator = <attribute 'denominator' of 'int' objects> - the denominator of a rational number in lowest terms
  • imag = <attribute 'imag' of 'int' objects> - the imaginary part of a complex number
  • numerator = <attribute 'numerator' of 'int' objects> - the numerator of a rational number in lowest terms
  • one = 0
  • real = <attribute 'real' of 'int' objects> - the real part of a complex number
  • two = 1

class WavetableLfoType(int)

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

Methods

__init__(self, /, *args, **kwargs)

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

bit_length(self, /)

Number of bits necessary to represent self in binary.

bin(37) '0b100101' (37).bit_length() 6

conjugate(...)

Returns self, the complex conjugate of any int.

from_bytes(bytes, byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol. byteorder The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. signed Indicates whether two's complement is used to represent the integer.

to_bytes(self, /, length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. byteorder The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. signed Determines whether two's complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

Attributes

  • denominator = <attribute 'denominator' of 'int' objects> - the denominator of a rational number in lowest terms
  • imag = <attribute 'imag' of 'int' objects> - the imaginary part of a complex number
  • numerator = <attribute 'numerator' of 'int' objects> - the numerator of a rational number in lowest terms
  • one = 0
  • real = <attribute 'real' of 'int' objects> - the real part of a complex number
  • two = 1

class WavetableOscillatorType(int)

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

Methods

__init__(self, /, *args, **kwargs)

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

bit_length(self, /)

Number of bits necessary to represent self in binary.

bin(37) '0b100101' (37).bit_length() 6

conjugate(...)

Returns self, the complex conjugate of any int.

from_bytes(bytes, byteorder, *, signed=False)

Return the integer represented by the given array of bytes.

bytes Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol. byteorder The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. signed Indicates whether two's complement is used to represent the integer.

to_bytes(self, /, length, byteorder, *, signed=False)

Return an array of bytes representing an integer.

length Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. byteorder The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. signed Determines whether two's complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

Attributes

  • denominator = <attribute 'denominator' of 'int' objects> - the denominator of a rational number in lowest terms
  • imag = <attribute 'imag' of 'int' objects> - the imaginary part of a complex number
  • mix = 3
  • numerator = <attribute 'numerator' of 'int' objects> - the numerator of a rational number in lowest terms
  • one = 0
  • real = <attribute 'real' of 'int' objects> - the real part of a complex number
  • s = 2
  • two = 1

class WrappingParameter(InternalParameter, PropertyHostMixin)

Properties

  • _live_ptr
  • automation_state
  • canonical_parent
  • default_value
  • display_value
  • is_quantized - bool(x) -> bool
  • linear_value
  • max
  • min
  • name
  • original_name
  • short_value_items
  • state
  • value
  • value_items

Methods

__init__(self, property_host=None, source_property=None, from_property_value=None, to_property_value=None, display_value_conversion=<function nop at 0x14def8bf8>, value_items=[], *a, **k)

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

_get_linear_value(self)
_get_property_value(self)
_get_value(self)
_has_valid_parent(self)
_set_linear_value(self, new_value)
_set_value(self, new_value)
add_automation_state_listener(self, slot, identify_sender=False, *a, **k)
add_name_listener(self, slot, identify_sender=False, *a, **k)
add_state_listener(self, slot, identify_sender=False, *a, **k)
add_value_listener(self, slot, identify_sender=False, *a, **k)
automation_state_has_listener(self, slot)
automation_state_listener_count(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
name_has_listener(self, slot)
name_listener_count(self)
notify_automation_state(self, *a, **k)
notify_name(self, *a, **k)
notify_state(self, *a, **k)
notify_value(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_automation_state_listener(self, slot)
remove_name_listener(self, slot)
remove_state_listener(self, slot)
remove_value_listener(self, slot)
set_display_value_conversion(self, display_value_conversion)
set_property_host(self, new_host)
set_scaling_functions(self, to_internal, from_internal)
state_has_listener(self, slot)
state_listener_count(self)
unregister_disconnectable(self, slot)
value_has_listener(self, slot)
value_listener_count(self)

Attributes

  • is_enabled = True - bool(x) -> bool