`ableton.v3.control_surface.controls.button` (runtime)¶

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

Functions¶

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

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

Properties¶

double_clicked
pressed
pressed_delayed
released
released_delayed
released_immediately
value

Methods¶

`State(pressed_color=None, disabled_color=None, repeat=False, enabled=True, double_click_context=None, delay_time=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 `LockableButtonControl(ButtonControl)`¶

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 `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 `TouchControl(ButtonControl)`¶

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 `TouchElement(ButtonElement)`¶

Properties¶

_last_sent_value
controlled_parameter
is_feedback_enabled
is_momentary
is_pressed
mapping_sensitivity
resource
script_forwarding
send_depends_on_forwarding
suppress_script_forwarding

Methods¶

`Colors()`¶

`ProxiedInterface(outer=None, *a, **k)`¶

`init(self, *a, encoder=None, **k)`¶

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

`_create_event_handler(self, property_name)`¶

`_disconnect_color_listener(self)`¶

`_do_draw(self, color)`¶

`_do_send_value(self, value, channel=None)`¶

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`_mapping_feedback_values(self)`¶

`_on_resource_lost(self, client)`¶

`_on_resource_received(self, client, *a, **k)`¶

`_report_value(self, value, is_input)`¶

`_request_rebuild_and_release(self)`¶

`_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)`¶

`_send_delayed_messages(self)`¶

`_set_skin_light(self, value)`¶

`_status_byte(self, channel)`¶

`_verify_value(self, value)`¶

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

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

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

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

`assignment_has_listener(self, slot)`¶

`assignment_listener_count(self)`¶

`begin_gesture(self)`¶

`clear_send_cache(self)`¶

`connect_to(self, parameter)`¶

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

`controlled_parameter_has_listener(self, slot)`¶

`controlled_parameter_listener_count(self)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

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

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

`is_pressed_has_listener(self, slot)`¶

`is_pressed_listener_count(self)`¶

`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(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')`¶

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

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

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

`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_assignment_listener(self, slot)`¶

`remove_controlled_parameter_listener(self, slot)`¶

`remove_is_pressed_listener(self, slot)`¶

`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_light(self, value)`¶

`set_needs_takeover(self, needs_takeover)`¶

`set_report_values(self, report_input, report_output)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`use_default_message(self)`¶

`value_has_listener(self, slot)`¶

`value_listener_count(self)`¶

Attributes¶

_ButtonElement__on_midi_value_changed = None
_TouchElement__on_parameter_changed = None
_TouchElement__on_parameter_name_changed = None
_TouchElement__on_parameter_value_changed = None
_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
include_in_top_level_state = True - bool(x) -> bool
name = '' - str(object='') -> str
num_delayed_messages = 2 - int([x]) -> integer
optimized_send_midi = True - bool(x) -> bool
proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>
renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

class `control_color`¶

Methods¶

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

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

class `listenable_property(listenable_property_base, property)`¶

Property attribute.

fget function to be used for getting an attribute value fset function to be used for setting an attribute value fdel function to be used for del'ing an attribute doc docstring

Typical use is to define a managed attribute x:

class C(object): def getx(self): return self._x def setx(self, value): self._x = value def delx(self): del self._x x = property(getx, setx, delx, "I'm the 'x' property.")

Decorators make defining new properties or modifying existing ones easy:

class C(object): @property def x(self): "I am the 'x' property." return self._x @x.setter def x(self, value): self._x = value @x.deleter def x(self): del self._x

Methods¶

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

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

`deleter(...)`¶

Descriptor to change the deleter on a property.

`getter(...)`¶

Descriptor to change the getter on a property.

`managed(default_value)`¶

`set_property_name(self, name)`¶

`setter(...)`¶

Descriptor to change the setter on a property.

Attributes¶

fdel = <member 'fdel' of 'property' objects>
fget = <member 'fget' of 'property' objects>
fset = <member 'fset' of 'property' objects>

ableton.v3.control_surface.controls.button (runtime)¶

Functions¶

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

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

Properties¶

Methods¶

State(pressed_color=None, disabled_color=None, repeat=False, enabled=True, double_click_context=None, delay_time=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 LockableButtonControl(ButtonControl)¶

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

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¶

class TouchControl(ButtonControl)¶

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 TouchElement(ButtonElement)¶

Properties¶

Methods¶

Colors()¶

ProxiedInterface(outer=None, *a, **k)¶

__init__(self, *a, encoder=None, **k)¶

_create_event_handler(self, property_name)¶

_disconnect_color_listener(self)¶

_do_draw(self, color)¶

_do_send_value(self, value, channel=None)¶

_init_state_from_controls(self, renderable_state)¶

_init_state_from_listenable_properties(self, renderable_state)¶

_mapping_feedback_values(self)¶

_on_resource_lost(self, client)¶

_on_resource_received(self, client, *a, **k)¶

_report_value(self, value, is_input)¶

_request_rebuild_and_release(self)¶

_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)¶

_send_delayed_messages(self)¶

_set_skin_light(self, value)¶

_status_byte(self, channel)¶

_verify_value(self, value)¶

`ableton.v3.control_surface.controls.button` (runtime)¶

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

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

`State(pressed_color=None, disabled_color=None, repeat=False, enabled=True, double_click_context=None, delay_time=None, *a, **k)`¶

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

`_clear_state(self, manager)`¶

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

`_make_control_state(self, manager)`¶

class `LockableButtonControl(ButtonControl)`¶

`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 `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 `TouchControl(ButtonControl)`¶

`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 `TouchElement(ButtonElement)`¶

`Colors()`¶

`ProxiedInterface(outer=None, *a, **k)`¶

`init(self, *a, encoder=None, **k)`¶

`_create_event_handler(self, property_name)`¶

`_disconnect_color_listener(self)`¶

`_do_draw(self, color)`¶

`_do_send_value(self, value, channel=None)`¶

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`_mapping_feedback_values(self)`¶

`_on_resource_lost(self, client)`¶

`_on_resource_received(self, client, *a, **k)`¶

`_report_value(self, value, is_input)`¶

`_request_rebuild_and_release(self)`¶

`_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)`¶

`_send_delayed_messages(self)`¶

`_set_skin_light(self, value)`¶

`_status_byte(self, channel)`¶

`_verify_value(self, value)`¶

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

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

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

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

`assignment_has_listener(self, slot)`¶

`assignment_listener_count(self)`¶

`begin_gesture(self)`¶

`clear_send_cache(self)`¶

`connect_to(self, parameter)`¶

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

`controlled_parameter_has_listener(self, slot)`¶

`controlled_parameter_listener_count(self)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

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

`end_gesture(self)`¶

`find_disconnectable(self, predicate)`¶

`force_next_send(self)`¶