Skip to content

ableton.v3.control_surface.controls (runtime)

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

Functions

control_event(event_name)

control_list(control_type, *a, **k)

control_matrix(control_type, *a, **k)

is_internal_parameter(parameter)

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 Connectable(EventObject)

Properties

  • connected_property_value

Methods

__init__(self, *a, **k)

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

_handle_connected_property_changed(self, value=None)
_make_empty_connection(self)
_register_property_slot(self, subject, property_name)
connect_property(self, subject, property_name, transform=<function nop at 0x11afcb240>)
disconnect(self)
disconnect_disconnectable(self, slot)
disconnect_property(self)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
on_connected_property_changed(self, value)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
unregister_disconnectable(self, slot)

Attributes

  • requires_listenable_connected_property = False - bool(x) -> bool

class Control

Methods

State(control=None, manager=None, *a, **k)
__init__(self, extra_args=None, extra_kws=None, *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

  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class ControlManager(EventObject)

Methods

__init__(self, *a, **k)

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

_tasks(self)
add_control(self, name, control)
control_notifications_enabled(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)
update(self)

class EncoderControl(InputControl)

Properties

  • released
  • touched
  • value

Methods

State(control=None, manager=None, touch_event_delay=0, *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 FixedRadioButtonGroup(RadioButtonGroup)

Properties

  • checked
  • double_clicked
  • pressed
  • pressed_delayed
  • released
  • released_delayed
  • released_immediately
  • value

Methods

State(*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.
  • DYNAMIC_CONTROL_COUNT = None
  • 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 InputControl(Control)

Properties

  • value

Methods

State(control=None, channel=None, identifier=None, *a, **k)
__init__(self, extra_args=None, extra_kws=None, *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

  • _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 MappableButton(EventObject)

Properties

  • mapped_parameter

Methods

__init__(self, *a, **k)

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

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

  • _MappableButton__on_parameter_value_changed = None

class MappedButtonControl(ButtonControl)

Properties

  • double_clicked
  • pressed
  • pressed_delayed
  • released
  • released_delayed
  • released_immediately
  • value

Methods

State(*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 MappedControl(InputControl)

Properties

  • value

Methods

State(control=None, manager=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

  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class MappedSensitivitySettingControl(MappedSensitivitySettingControl)

Properties

  • value

Methods

State(default_sensitivity=None, fine_sensitivity=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

  • DEFAULT_SENSITIVITY = 1.0 - Convert a string or number to a floating point number, if possible.
  • FINE_SENSITIVITY = 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 PlayableControl(ButtonControl)

Properties

  • double_clicked
  • pressed
  • pressed_delayed
  • released
  • released_delayed
  • released_immediately
  • value

Methods

Mode(...)

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

State(mode=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 RadioButtonGroup(ControlList, RadioButtonControl)

Properties

  • checked
  • double_clicked
  • pressed
  • pressed_delayed
  • released
  • released_delayed
  • released_immediately
  • value

Methods

State(*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.
  • DYNAMIC_CONTROL_COUNT = None
  • 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)
renderable_state(self)
suppress_notifications(self)
unregister_disconnectable(self, slot)

Attributes

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

class SendValueControl(Control)

Methods

State(*a, **k)
__init__(self, extra_args=None, extra_kws=None, *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

  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class SendValueEncoderControl(EncoderControl)

Properties

  • released
  • touched
  • value

Methods

State(*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 SendValueInputControl(InputControl)

Properties

  • value

Methods

State(*a, **k)
__init__(self, extra_args=None, extra_kws=None, *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

  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class SendValueMixin

Properties

  • value

Methods

__init__(self, *a, **k)

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

_send_current_value(self)
set_control_element(self, control_element)
update(self)

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 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 control_color

Methods

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

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