ableton.v3.control_surface.control_surface_specification (runtime)¶
Live 11 — Live Object Model & framework reference (descriptions and signatures).
Module constants¶
BANK_DEFINITIONS = {'AudioEffectGroupDevice': IndexedDict([('Macros', {'Parameters': ('Macro 1', 'Macro 2', 'Macro 3', 'Macro 4', 'Macro 5', 'Macro 6', 'Macro 7', 'Macro 8')}), ('...DEFAULT_BANK_SIZE = 8DEFAULT_CONTINUOUS_PARAMETER_SENSITIVITY = 1.0DEFAULT_QUANTIZED_PARAMETER_SENSITIVITY = 0.1LOW_PRIORITY = -1default_skin = <ableton.v3.control_surface.skin.Skin object at 0x163c0cf60>
Classes¶
class AutoArmComponent(Component)¶
Properties¶
applicationis_rootlayerneeds_restore_auto_armparentsong
Methods¶
__init__(self, name='Auto_Arm', target_track=None, *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
_add_child(self, component)¶
_auto_arm_target_changed(self, target_track)¶
_can_auto_arm(self)¶
_get_layer_iterable(self)¶
_grab_all_layers(self)¶
_internal_on_enabled_changed(self)¶
_release_all_layers(self)¶
_set_auto_arm_state(self, state)¶
_set_enabled_recursive(self, enable)¶
_setup_new_auto_arm_target(self, target_track)¶
_update_auto_arm(self)¶
_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¶
_AutoArmComponent__on_arm_changed=None_AutoArmComponent__on_frozen_state_changed=None_AutoArmComponent__on_implicit_arm_changed=None_AutoArmComponent__on_input_routing_type_changed=None_AutoArmComponent__on_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) -> boolcanonical_parent=Nonenum_layers=0- int([x]) -> integer
class BasicColors¶
Methods¶
__init__(self, /, *args, **kwargs)¶
Initialize self. See help(type(self)) for accurate signature.
Attributes¶
OFF=<ableton.v3.control_surface.elements.color.SimpleColor object at 0x163977438>ON=<ableton.v3.control_surface.elements.color.SimpleColor object at 0x163977470>
class BasicRecordingMethod(RecordingMethod)¶
Methods¶
__init__(self, song=None, target_track=None, *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
can_record_into_clip_slot(clip_slot)¶
start_recording(self, *_)¶
stop_recording(self)¶
trigger_recording(self)¶
Attributes¶
_abc_impl=<_abc_data object at 0x163b744e0>
class ControlSurfaceSpecification(SimpleNamespace)¶
A simple attribute-based namespace.
SimpleNamespace(**kwargs)
Methods¶
__init__(self, /, *args, **kwargs)¶
Initialize self. See help(type(self)) for accurate signature.
auto_arm_component_type(name='Auto_Arm', target_track=None, *a, **k)¶
create_mappings_function(*x)¶
device_provider_type(song=None, *a, **k)¶
recording_method_type(song=None, target_track=None, *a, **k)¶
session_ring_component_type(name='Session_Ring', num_tracks=0, num_scenes=0, include_returns=False, include_master=False, right_align_non_player_tracks=False, tracks_to_use=None, snap_track_offset=False, set_session_highlight=<function nop at 0x14def8bf8>, is_private=False, *a, **k)¶
session_ring_selection_linking_type(song=None, session_ring=None, selection_changed_notifier=None, link_to_track_selection=True, link_to_scene_selection=False, *a, **k)¶
target_track_component_type(name='Target_Track', is_private=False, *a, **k)¶
Attributes¶
background_priority=-1- int([x]) -> integercomponent_map={}- dict() -> new empty dictionarycontinuous_parameter_sensitivity=1.0- Convert a string or number to a floating point number, if possible.control_surface_skin=<ableton.v3.control_surface.skin.Skin object at 0x163c0cf60>custom_identity_response=Nonedisplay_specification=<ableton.v3.control_surface.display.display_specification.DisplaySpecification object at 0x11df6ed68>elements_type=Nonefeedback_channels=Nonegoodbye_messages=Nonehello_messages=Noneidentity_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.identity_response_id_bytes=Noneinclude_auto_arming=False- bool(x) -> boolinclude_master=False- bool(x) -> boolinclude_returns=False- bool(x) -> boollink_session_ring_to_scene_selection=False- bool(x) -> boollink_session_ring_to_track_selection=False- bool(x) -> boolnum_scenes=1- int([x]) -> integernum_tracks=8- int([x]) -> integerparameter_bank_definitions={'AudioEffectGroupDevice': IndexedDict([('Macros', {'Parameters': ('Macro 1', 'Macro 2', 'Macro 3', 'Macro 4', 'Macro 5', 'Macro 6', 'Macro 7', 'Macro 8')}), ('...- dict() -> new empty dictionaryparameter_bank_size=8- int([x]) -> integerplaying_feedback_velocity=127- int([x]) -> integerquantized_parameter_sensitivity=0.1- Convert a string or number to a floating point number, if possible.recording_feedback_velocity=127- int([x]) -> integerright_align_non_player_tracks=False- bool(x) -> boolsend_goodbye_messages_last=True- bool(x) -> boolsnap_track_offset=False- bool(x) -> bool
class DeviceProvider(EventObject)¶
Properties¶
deviceis_locked_to_device
Methods¶
__init__(self, song=None, *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
_appoint_device_from_song(self)¶
_device_to_appoint(self, device)¶
_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)¶
can_skip_over_device_rack(device)¶
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)¶
select_and_appoint_device(self, device, ignore_unmapped_macros=True)¶
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=Nonedevice_selection_follows_track_selection=True- bool(x) -> bool
class DisplaySpecification¶
Methods¶
__init__(self, create_root_view: Union[Callable[[], ableton.v3.control_surface.display.view.view.View], NoneType] = None, protocol=None, notifications: Union[Type[ableton.v3.control_surface.display.notifications.all.Notifications], NoneType] = None)¶
Initialize self. See help(type(self)) for accurate signature.
class SessionRingComponent(Component, Renderable)¶
Properties¶
applicationis_rootlayernum_scenesnum_tracksoffsetparentscene_offsetscenessongtrack_offsettracks
Methods¶
__init__(self, name='Session_Ring', num_tracks=0, num_scenes=0, include_returns=False, include_master=False, right_align_non_player_tracks=False, tracks_to_use=None, snap_track_offset=False, set_session_highlight=<function nop at 0x14def8bf8>, is_private=False, *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)¶
_get_tracks_to_use(self, include_returns, include_master)¶
_grab_all_layers(self)¶
_init_state_from_controls(self, renderable_state)¶
_init_state_from_listenable_properties(self, renderable_state)¶
_internal_on_enabled_changed(self)¶
_pad_tracks(self, tracks)¶
_release_all_layers(self)¶
_right_align_non_player_tracks(self, tracks)¶
_set_enabled_recursive(self, enable)¶
_update_highlight(self)¶
_update_is_enabled(self)¶
_update_track_list(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_offset_listener(self, slot, identify_sender=False, *a, **k)¶
add_scenes_listener(self, slot, identify_sender=False, *a, **k)¶
add_tracks_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)¶
move(self, tracks, scenes)¶
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_offset(self, *a, **k)¶
notify_scenes(self, *a, **k)¶
notify_tracks(self, *a, **k)¶
offset_has_listener(self, slot)¶
offset_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_offset_listener(self, slot)¶
remove_scenes_listener(self, slot)¶
remove_tracks_listener(self, slot)¶
scenes_has_listener(self, slot)¶
scenes_listener_count(self)¶
scenes_to_use(self)¶
set_enabled(self, enable)¶
set_offsets(self, track_offset, scene_offset)¶
suppress_notifications(self)¶
tracks_has_listener(self, slot)¶
tracks_listener_count(self)¶
tracks_to_use(self)¶
unregister_disconnectable(self, slot)¶
update(self)¶
Attributes¶
_SessionRingComponent__on_scene_list_changed=None_clipboard_component_instances=[]- Built-in mutable sequence._tasks=<ableton.v2.base.util.lazy_attribute object at 0x163a2a898>any_clipboard_has_content=False- bool(x) -> boolcanonical_parent=Noneinclude_in_top_level_state=True- bool(x) -> boolnum_layers=0- int([x]) -> integerrenderable_state=<ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>
class SessionRingSelectionLinking(EventObject)¶
Methods¶
__init__(self, song=None, session_ring=None, selection_changed_notifier=None, link_to_track_selection=True, link_to_scene_selection=False, *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
_link_session_ring_with_minimal_travel(self, axis_name, current_index)¶
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¶
_SessionRingSelectionLinking__on_scene_selection_scrolled=None_SessionRingSelectionLinking__on_track_selection_scrolled=None
class SimpleNamespace¶
A simple attribute-based namespace.
SimpleNamespace(**kwargs)
Methods¶
__init__(self, /, *args, **kwargs)¶
Initialize self. See help(type(self)) for accurate signature.
class TargetTrackComponent(Component, Renderable)¶
Properties¶
applicationis_locked_to_trackis_rootlayerparentsongtarget_cliptarget_track
Methods¶
__init__(self, name='Target_Track', is_private=False, *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)¶
_get_new_target_track(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)¶
_selected_track_changed(self)¶
_set_enabled_recursive(self, enable)¶
_set_target_track(self)¶
_target_clip_from_arrangement(self)¶
_target_clip_from_session(self)¶
_update_is_enabled(self)¶
_update_target_clip(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_is_locked_to_track_listener(self, slot, identify_sender=False, *a, **k)¶
add_target_clip_listener(self, slot, identify_sender=False, *a, **k)¶
add_target_track_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)¶
is_locked_to_track_has_listener(self, slot)¶
is_locked_to_track_listener_count(self)¶
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_is_locked_to_track(self, *a, **k)¶
notify_target_clip(self, *a, **k)¶
notify_target_track(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)¶
remove_is_locked_to_track_listener(self, slot)¶
remove_target_clip_listener(self, slot)¶
remove_target_track_listener(self, slot)¶
set_enabled(self, enable)¶
suppress_notifications(self)¶
target_clip_has_listener(self, slot)¶
target_clip_listener_count(self)¶
target_track_has_listener(self, slot)¶
target_track_listener_count(self)¶
unregister_disconnectable(self, slot)¶
update(self)¶
Attributes¶
_TargetTrackComponent__on_target_clip_slot_has_clip_changed=None_clipboard_component_instances=[]- Built-in mutable sequence._tasks=<ableton.v2.base.util.lazy_attribute object at 0x163a2a898>any_clipboard_has_content=False- bool(x) -> boolcanonical_parent=Noneinclude_in_top_level_state=True- bool(x) -> boollock_button=<ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x163bbbf28>num_layers=0- int([x]) -> integerrenderable_state=<ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>