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

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

Functions¶

`clamp(val, minv, maxv)`¶

`get_bar_length(clip=None)`¶

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

`move_current_song_time(song, delta, truncate_to_beat=True)`¶

`sign(value)`¶

Classes¶

class `ButtonControl(ButtonControlBase)`¶

Properties¶

double_clicked
pressed
pressed_delayed
released
released_delayed
released_immediately
value

Methods¶

`State(color='DefaultButton.On', on_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 `Component(ControlManager)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

`init(self, name='', parent=None, register_component=None, song=None, layer=None, is_enabled=True, is_private=True, *a, **k)`¶

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

`_add_child(self, component)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_update_is_enabled(self)`¶

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

`add_children(self, *children)`¶

`add_control(self, name, control)`¶

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

`any_clipboard_has_content_has_listener(self, slot)`¶

`any_clipboard_has_content_listener_count(self)`¶

`control_notifications_enabled(self)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`enabled_has_listener(self, slot)`¶

`enabled_listener_count(self)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`is_enabled(self, explicit=False)`¶

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

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

`on_enabled_changed(self)`¶

`register_clipboard(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`remove_any_clipboard_has_content_listener(self, slot)`¶

`remove_enabled_listener(self, slot)`¶

`set_enabled(self, enable)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_clipboard_component_instances = [] - Built-in mutable sequence.
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x163a2a898>
any_clipboard_has_content = False - bool(x) -> bool
canonical_parent = None
num_layers = 0 - int([x]) -> integer

class `OptionalSkinEntry(tuple)`¶

OptionalSkinEntry(name, fallback_name)

Properties¶

fallback_name - Alias for field number 1
name - Alias for field number 0

Methods¶

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

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

`_asdict(self)`¶

`_make(iterable)`¶

Make a new OptionalSkinEntry object from a sequence or iterable

`_replace(_self, **kwds)`¶

Return a new OptionalSkinEntry object replacing specified fields with new values

`count(self, value, /)`¶

Return number of occurrences of value.

`index(self, value, start=0, stop=9223372036854775807, /)`¶

Return first index of value.

Raises ValueError if the value is not present.

Attributes¶

_field_defaults = {'fallback_name': None} - dict() -> new empty dictionary
_field_types = OrderedDict([('name', <class 'str'>), ('fallback_name', typing.Union[str, NoneType])]) - Dictionary that remembers insertion order
_fields = ('name', 'fallback_name') - Built-in immutable sequence.
_fields_defaults = {} - dict() -> new empty dictionary

class `RecordingQuantization(enum)`¶

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
name = <member 'name' of 'Boost.Python.enum' objects>
names = {'rec_q_no_q': Song.RecordingQuantization.rec_q_no_q, 'rec_q_quarter': Song.RecordingQuantization.rec_q_quarter, 'rec_q_eight': Song.RecordingQuantization.rec_q... - dict() -> new empty dictionary
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
rec_q_eight = Song.RecordingQuantization.rec_q_eight
rec_q_eight_eight_triplet = Song.RecordingQuantization.rec_q_eight_eight_triplet
rec_q_eight_triplet = Song.RecordingQuantization.rec_q_eight_triplet
rec_q_no_q = Song.RecordingQuantization.rec_q_no_q
rec_q_quarter = Song.RecordingQuantization.rec_q_quarter
rec_q_sixtenth = Song.RecordingQuantization.rec_q_sixtenth
rec_q_sixtenth_sixtenth_triplet = Song.RecordingQuantization.rec_q_sixtenth_sixtenth_triplet
rec_q_sixtenth_triplet = Song.RecordingQuantization.rec_q_sixtenth_triplet
rec_q_thirtysecond = Song.RecordingQuantization.rec_q_thirtysecond
values = {0: Song.RecordingQuantization.rec_q_no_q, 1: Song.RecordingQuantization.rec_q_quarter, 2: Song.RecordingQuantization.rec_q_eight, 3: Song.RecordingQuantization... - dict() -> new empty dictionary

class `Renderable(CompoundDisconnectable)`¶

Methods¶

`init(self, react=None, notifications: 'Optional[Type[Notifications]]' = None, suppress_notifications: 'Optional[Callable]' = None, *a, **k)`¶

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

`_create_event_handler(self, property_name)`¶

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`control_base_type(extra_args=None, extra_kws=None, *a, **k)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`dispatch_event(self, name: 'str', value)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`notify(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

Attributes¶

include_in_top_level_state = True - bool(x) -> bool
renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

class `StepEncoderControl(StepEncoderControl)`¶

Properties¶

released
touched
value

Methods¶

`State(num_steps=10, *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¶

TOUCH_TIME = 0.5 - 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 `ToggleButtonControl(ButtonControl)`¶

Properties¶

double_clicked
pressed
pressed_delayed
released
released_delayed
released_immediately
toggled
value

Methods¶

`State(color='DefaultButton.On', on_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 `TransportComponent(Component, Renderable)`¶

Properties¶

application
is_root
layer
parent
song

Methods¶

`init(self, name='Transport', *a, **k)`¶

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

`_add_child(self, component)`¶

`_create_event_handler(self, property_name)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`_internal_on_enabled_changed(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_toggle_record_quantize(self)`¶

`_trigger_tap_tempo(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_base_type(extra_args=None, extra_kws=None, *a, **k)`¶

`control_notifications_enabled(self)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`dispatch_event(self, name: 'str', value)`¶

`enabled_has_listener(self, slot)`¶

`enabled_listener_count(self)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`is_enabled(self, explicit=False)`¶

`notify(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')`¶

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

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

`on_enabled_changed(self)`¶

`register_clipboard(self)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`remove_any_clipboard_has_content_listener(self, slot)`¶

`remove_enabled_listener(self, slot)`¶

`set_enabled(self, enable)`¶

`set_position_encoders_use_bar_increments(self, use_bar)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`update(self)`¶

Attributes¶

_TransportComponent__on_can_capture_midi_changed = None
_TransportComponent__on_can_jump_to_next_cue_changed = None
_TransportComponent__on_can_jump_to_prev_cue_changed = None
_TransportComponent__on_is_playing_changed = None
_TransportComponent__on_re_enable_automation_enabled_changed = None
_TransportComponent__on_record_quantization_changed = None
_clipboard_component_instances = [] - Built-in mutable sequence.
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x163a2a898>
any_clipboard_has_content = False - bool(x) -> bool
arrangement_position_encoder = <ableton.v3.control_surface.controls.encoder.StepEncoderControl object at 0x163bc9588>
automation_arm_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x163bc97f0>
canonical_parent = None
capture_midi_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163bc9860>
cue_encoder = <ableton.v3.control_surface.controls.encoder.StepEncoderControl object at 0x163bc96a0>
fastforward_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163bc9a58>
include_in_top_level_state = True - bool(x) -> bool
loop_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x163bc9898>
loop_length_encoder = <ableton.v3.control_surface.controls.encoder.StepEncoderControl object at 0x163bc95f8>
loop_start_encoder = <ableton.v3.control_surface.controls.encoder.StepEncoderControl object at 0x163bc95c0>
metronome_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x163bc98d0>
next_cue_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163bc9ac8>
nudge_down_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163bc99b0>
nudge_up_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163bc99e8>
num_layers = 0 - int([x]) -> integer
play_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163bc96d8>
play_pause_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163bc9748>
play_toggle_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x163bc9710>
prev_cue_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163bc9a90>
punch_in_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x163bc9908>
punch_out_button = <ableton.v3.control_surface.controls.toggle_button.ToggleButtonControl object at 0x163bc9940>
re_enable_automation_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163bc9828>
record_quantize_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163bc9b38>
renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>
rewind_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163bc9a20>
seek_dict = {'color': 'Transport.Seek', 'pressed_color': 'Transport.SeekPressed', 'repeat': True, 'delay_time': 0} - dict() -> new empty dictionary
set_cue_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163bc9b00>
stop_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163bc97b8>
tap_tempo_button = <ableton.v3.control_surface.controls.button.ButtonControl object at 0x163bc9978>
tempo_coarse_encoder = <ableton.v3.control_surface.controls.encoder.StepEncoderControl object at 0x163bc9630>
tempo_fine_encoder = <ableton.v3.control_surface.controls.encoder.StepEncoderControl object at 0x163bc9668>

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

Functions¶

clamp(val, minv, maxv)¶

get_bar_length(clip=None)¶

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

move_current_song_time(song, delta, truncate_to_beat=True)¶

sign(value)¶

Classes¶

class ButtonControl(ButtonControlBase)¶

Properties¶

Methods¶

State(color='DefaultButton.On', on_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 Component(ControlManager)¶

Properties¶

Methods¶

__init__(self, name='', parent=None, register_component=None, song=None, layer=None, is_enabled=True, is_private=True, *a, **k)¶

_add_child(self, component)¶

_get_layer_iterable(self)¶

_grab_all_layers(self)¶

_internal_on_enabled_changed(self)¶

_release_all_layers(self)¶

_set_enabled_recursive(self, enable)¶

_update_is_enabled(self)¶

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

add_children(self, *children)¶

add_control(self, name, control)¶

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

any_clipboard_has_content_has_listener(self, slot)¶

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¶

class OptionalSkinEntry(tuple)¶

Properties¶

Methods¶

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

_asdict(self)¶

_make(iterable)¶

_replace(_self, **kwds)¶

count(self, value, /)¶

index(self, value, start=0, stop=9223372036854775807, /)¶

Attributes¶

class RecordingQuantization(enum)¶

Methods¶

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

bit_length(self, /)¶

conjugate(...)¶

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

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

Attributes¶

class Renderable(CompoundDisconnectable)¶

Methods¶

__init__(self, react=None, notifications: 'Optional[Type[Notifications]]' = None, suppress_notifications: 'Optional[Callable]' = None, *a, **k)¶

_create_event_handler(self, property_name)¶

_init_state_from_controls(self, renderable_state)¶

_init_state_from_listenable_properties(self, renderable_state)¶

control_base_type(extra_args=None, extra_kws=None, *a, **k)¶

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

`clamp(val, minv, maxv)`¶

`get_bar_length(clip=None)`¶

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

`move_current_song_time(song, delta, truncate_to_beat=True)`¶

`sign(value)`¶

class `ButtonControl(ButtonControlBase)`¶

`State(color='DefaultButton.On', on_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 `Component(ControlManager)`¶

`init(self, name='', parent=None, register_component=None, song=None, layer=None, is_enabled=True, is_private=True, *a, **k)`¶

`_add_child(self, component)`¶

`_get_layer_iterable(self)`¶

`_grab_all_layers(self)`¶

`_internal_on_enabled_changed(self)`¶

`_release_all_layers(self)`¶

`_set_enabled_recursive(self, enable)`¶

`_update_is_enabled(self)`¶

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

`add_children(self, *children)`¶

`add_control(self, name, control)`¶

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

`any_clipboard_has_content_has_listener(self, slot)`¶

`any_clipboard_has_content_listener_count(self)`¶

`control_notifications_enabled(self)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`enabled_has_listener(self, slot)`¶

`enabled_listener_count(self)`¶

`find_disconnectable(self, predicate)`¶

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

class `OptionalSkinEntry(tuple)`¶

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

`_asdict(self)`¶

`_make(iterable)`¶

`_replace(_self, **kwds)`¶

`count(self, value, /)`¶

`index(self, value, start=0, stop=9223372036854775807, /)`¶

class `RecordingQuantization(enum)`¶

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

`bit_length(self, /)`¶

`conjugate(...)`¶

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

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

class `Renderable(CompoundDisconnectable)`¶

`init(self, react=None, notifications: 'Optional[Type[Notifications]]' = None, suppress_notifications: 'Optional[Callable]' = None, *a, **k)`¶

`_create_event_handler(self, property_name)`¶

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`control_base_type(extra_args=None, extra_kws=None, *a, **k)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`dispatch_event(self, name: 'str', value)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`notify(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

class `StepEncoderControl(StepEncoderControl)`¶

`State(num_steps=10, *a, **k)`¶

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

`_clear_state(self, manager)`¶