Skip to content

ableton.v2.control_surface.control.encoder (runtime)

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

Module constants

  • logger = <Logger ableton.v2.control_surface.control.encoder (INFO)>

Functions

clamp(val, minv, maxv)

const(value)

control_event(event_name)

old_hasattr(obj, attr)

sign(value)

Classes

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 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 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 ListIndexEncoderControl(StepEncoderControl)

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 ListValueEncoderControl(StepEncoderControl)

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 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 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(EncoderControl)

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 ValueStepper

Properties

  • num_steps

Methods

__init__(self, num_steps=10, *a, **k)

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

advance(self, value)
reset(self)

class lazy_attribute

Methods

__call__(self)

Call self as a function.

__init__(self, func, name=None)

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