`ableton.v2.control_surface.components.transport` (runtime)¶

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

Module constants¶

SEEK_SPEED = 10.0
TEMPO_BOTTOM = 60.0
TEMPO_FINE_RANGE = 2.56
TEMPO_TOP = 200.0

Functions¶

`clamp(val, minv, maxv)`¶

`in_range(value, lower_bound, upper_open_bound)`¶

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

`old_div(a, b)`¶

Classes¶

class `ButtonControl(ButtonControlBase)`¶

Properties¶

double_clicked
pressed
pressed_delayed
released
released_delayed
released_immediately
value

Methods¶

`State(color='DefaultButton.On', *a, **k)`¶

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

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

`_clear_state(self, manager)`¶

`_get_state(self, manager, state_factory=None)`¶

`_make_control_state(self, manager)`¶

Attributes¶

DELAY_TIME = 0.3 - Convert a string or number to a floating point number, if possible.
DOUBLE_CLICK_TIME = 0.5 - Convert a string or number to a floating point number, if possible.
REPEAT_RATE = 0.1 - Convert a string or number to a floating point number, if possible.
_extra_args = [] - Built-in mutable sequence.
_extra_kws = {} - dict() -> new empty dictionary

class `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 `ToggleButtonControl(ButtonControlBase)`¶

Properties¶

double_clicked
pressed
pressed_delayed
released
released_delayed
released_immediately
toggled
value

Methods¶

`State(untoggled_color=None, toggled_color=None, *a, **k)`¶

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

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

`_clear_state(self, manager)`¶

`_get_state(self, manager, state_factory=None)`¶

`_make_control_state(self, manager)`¶

Attributes¶

DELAY_TIME = 0.3 - Convert a string or number to a floating point number, if possible.
DOUBLE_CLICK_TIME = 0.5 - Convert a string or number to a floating point number, if possible.
REPEAT_RATE = 0.1 - Convert a string or number to a floating point number, if possible.
_extra_args = [] - Built-in mutable sequence.
_extra_kws = {} - dict() -> new empty dictionary

class `ToggleComponent(Component)`¶

Properties¶

application
is_root
layer
parent
song
subject
value

Methods¶

`init(self, property_name=None, subject=None, is_momentary=False, model_transform=None, view_transform=None, read_only=False, *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)`¶

`_on_property_changed_in_model(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_update_button(self)`¶

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

`model_transform(self, value)`¶

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

`set_toggle_button(self, button)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

`view_transform(self, value)`¶

Attributes¶

_ToggleComponent__on_button_value = None
_has_task_group = False - bool(x) -> bool
_layer = None
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x163088ef0>
canonical_parent = None
is_momentary = False - bool(x) -> bool
is_private = True - bool(x) -> bool
name = '' - str(object='') -> str
read_only = False - bool(x) -> bool

class `TransportComponent(Component)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

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

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

`_add_child(self, component)`¶

`_ffwd_value(self, value)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_move_current_song_time(self, speed, delta)`¶

`_release_all_layers(self)`¶

`_rwd_value(self, value)`¶

`_set_enabled_recursive(self, enable)`¶

`_update_button_states(self)`¶

`_update_is_enabled(self)`¶

`_update_stop_button_color(self)`¶

`add_children(self, *a)`¶

`add_control(self, name, control)`¶

`add_enabled_listener(self, slot, identify_sender=False, *a, **k)`¶

`control_notifications_enabled(self)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`enabled_has_listener(self, slot)`¶

`enabled_listener_count(self)`¶

`find_disconnectable(self, predicate)`¶

`has_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_arrangement_overdub_button(self, button)`¶

`set_enabled(self, enable)`¶

`set_loop_button(self, button)`¶

`set_metronome_button(self, button)`¶

`set_nudge_buttons(self, up_button, down_button)`¶

`set_nudge_down_button(self, down_button)`¶

`set_nudge_up_button(self, up_button)`¶

`set_overdub_button(self, button)`¶

`set_punch_in_button(self, in_button)`¶

`set_punch_out_button(self, out_button)`¶

`set_record_button(self, button)`¶

`set_seek_backward_button(self, rwd_button)`¶

`set_seek_buttons(self, ffwd_button, rwd_button)`¶

`set_seek_forward_button(self, ffwd_button)`¶

`set_tempo_control(self, control, fine_control=None)`¶

`set_tempo_fine_control(self, fine_control)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_TransportComponent__ffwd_value_slot = None
_TransportComponent__on_is_playing_changed = None
_TransportComponent__rwd_value_slot = None
_TransportComponent__tempo_fine_value = None
_TransportComponent__tempo_value = None
_has_task_group = False - bool(x) -> bool
_layer = None
_on_play_button_toggled = <ableton.v2.control_surface.control.toggle_button.ToggleButtonControl object at 0x163573748>
_on_stop_button_released = <ableton.v2.control_surface.control.button.ButtonControl object at 0x163573780>
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x163088ef0>
canonical_parent = None
continue_playing_button = <ableton.v2.control_surface.control.button.ButtonControl object at 0x1635737b8>
is_private = False - bool(x) -> bool
name = '' - str(object='') -> str
play_button = <ableton.v2.control_surface.control.toggle_button.ToggleButtonControl object at 0x163573748>
stop_button = <ableton.v2.control_surface.control.button.ButtonControl object at 0x163573780>
tap_tempo_button = <ableton.v2.control_surface.control.button.ButtonControl object at 0x1635737f0>

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

ableton.v2.control_surface.components.transport (runtime)¶

Module constants¶

Functions¶

clamp(val, minv, maxv)¶

in_range(value, lower_bound, upper_open_bound)¶

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

old_div(a, b)¶

Classes¶

class ButtonControl(ButtonControlBase)¶

Properties¶

Methods¶

State(color='DefaultButton.On', *a, **k)¶

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

_clear_state(self, manager)¶

_get_state(self, manager, state_factory=None)¶

_make_control_state(self, manager)¶

Attributes¶

class Component(ControlManager)¶

Properties¶

Methods¶

__init__(self, name='', parent=None, register_component=None, song=None, layer=None, is_enabled=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_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¶

class ToggleButtonControl(ButtonControlBase)¶

Properties¶

Methods¶

State(untoggled_color=None, toggled_color=None, *a, **k)¶

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

_clear_state(self, manager)¶

_get_state(self, manager, state_factory=None)¶

_make_control_state(self, manager)¶

Attributes¶

class ToggleComponent(Component)¶

Properties¶

Methods¶

__init__(self, property_name=None, subject=None, is_momentary=False, model_transform=None, view_transform=None, read_only=False, *a, **k)¶

_add_child(self, component)¶

_get_layer_iterable(self)¶

_grab_all_layers(self)¶

_internal_on_enabled_changed(self)¶

_on_property_changed_in_model(self)¶

_release_all_layers(self)¶

_set_enabled_recursive(self, enable)¶

_update_button(self)¶

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

`ableton.v2.control_surface.components.transport` (runtime)¶

`clamp(val, minv, maxv)`¶

`in_range(value, lower_bound, upper_open_bound)`¶

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

`old_div(a, b)`¶

class `ButtonControl(ButtonControlBase)`¶

`State(color='DefaultButton.On', *a, **k)`¶

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

`_clear_state(self, manager)`¶

`_get_state(self, manager, state_factory=None)`¶

`_make_control_state(self, manager)`¶

class `Component(ControlManager)`¶

`init(self, name='', parent=None, register_component=None, song=None, layer=None, is_enabled=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_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)`¶

class `ToggleButtonControl(ButtonControlBase)`¶

`State(untoggled_color=None, toggled_color=None, *a, **k)`¶

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

`_clear_state(self, manager)`¶

`_get_state(self, manager, state_factory=None)`¶

`_make_control_state(self, manager)`¶

class `ToggleComponent(Component)`¶

`init(self, property_name=None, subject=None, is_momentary=False, model_transform=None, view_transform=None, read_only=False, *a, **k)`¶

`_add_child(self, component)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_on_property_changed_in_model(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_update_button(self)`¶

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

`model_transform(self, value)`¶

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

`set_toggle_button(self, button)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

`view_transform(self, value)`¶