`ableton.v2.control_surface.control.button` (runtime)¶

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

Module constants¶

DOUBLE_CLICK_DELAY = 0.5
MOMENTARY_DELAY = 0.3

Functions¶

`control_event(event_name)`¶

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

Methods¶

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

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

`set_new_context(self, control_state)`¶

Attributes¶

click_count = 0 - int([x]) -> integer
control_state = None

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 `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 `ScriptForwarding(int)`¶

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.

`as_integer_ratio(self, /)`¶

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

(10).as_integer_ratio() (10, 1) (-10).as_integer_ratio() (-10, 1) (0).as_integer_ratio() (0, 1)

`bit_count(self, /)`¶

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

bin(13) '0b1101' (13).bit_count() 3

`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='big', *, 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. Default is to use 'big'. signed Indicates whether two's complement is used to represent the integer.

`to_bytes(self, /, length=1, byteorder='big', *, 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. Default is length 1. 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. Default is to use 'big'. 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
exclusive = 1
imag = <attribute 'imag' of 'int' objects> - the imaginary part of a complex number
non_consuming = 2
none = 0
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

class `control_color`¶

Methods¶

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

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

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.

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.control.button (runtime)¶

Module constants¶

Functions¶

control_event(event_name)¶

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

Methods¶

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

set_new_context(self, control_state)¶

Attributes¶

class InputControl(Control)¶

Properties¶

Methods¶

State(control=None, channel=None, identifier=None, *a, **k)¶

__init__(self, extra_args=None, extra_kws=None, *a, **k)¶

_clear_state(self, manager)¶

_get_state(self, manager, state_factory=None)¶

_make_control_state(self, manager)¶

Attributes¶

class PlayableControl(ButtonControl)¶

Properties¶

Methods¶

Mode(...)¶

State(mode=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 ScriptForwarding(int)¶

Methods¶

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

as_integer_ratio(self, /)¶

bit_count(self, /)¶

bit_length(self, /)¶

conjugate(...)¶

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

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

Attributes¶

class control_color¶

Methods¶

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

class lazy_attribute¶

Methods¶

__call__(self)¶

__init__(self, func, name=None)¶

class partial¶

Methods¶

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

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

Attributes¶

`ableton.v2.control_surface.control.button` (runtime)¶

`control_event(event_name)`¶

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

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

`set_new_context(self, control_state)`¶

class `InputControl(Control)`¶

`State(control=None, channel=None, identifier=None, *a, **k)`¶

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

`_clear_state(self, manager)`¶

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

`_make_control_state(self, manager)`¶

class `PlayableControl(ButtonControl)`¶

`Mode(...)`¶

`State(mode=None, *a, **k)`¶

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

`_clear_state(self, manager)`¶

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

`_make_control_state(self, manager)`¶

class `ScriptForwarding(int)`¶

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

`as_integer_ratio(self, /)`¶

`bit_count(self, /)`¶

`bit_length(self, /)`¶

`conjugate(...)`¶

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

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

class `control_color`¶

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

class `lazy_attribute`¶

`call(self)`¶

`init(self, func, name=None)`¶

class `partial`¶

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

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