Skip to content

ableton.v2.control_surface.delay_decoration (runtime)

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

Functions

get_parameter_by_name(decorator, name)

listens(event_path, *a, **k)

liveobj_valid(obj)

Classes

class ChannelType(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.

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
  • left = 1
  • left_right = 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
  • right = 2

class DelayDeviceDecorator(LiveObjectDecorator, EventObject)

Properties

  • options
  • parameters
  • proxied_interface

Methods

__init__(self, *a, **k)

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

_add_enum_parameter(self, name, values, default_value)
_add_non_automatable_enum_parameter(self, name, list, index)
_add_non_automatable_int_parameter(self, name, property_name, min, max, units)
_add_on_off_option(self, name, pname)
_add_switch_option(self, name, pname, labels)
_create_parameters(self)
_linked_state_needs_updating(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
proxy_old_hasattr(self, attr)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
unregister_disconnectable(self, slot)

Attributes

  • _DelayDeviceDecorator__on_channel_switch_changed = None
  • _DelayDeviceDecorator__on_linked_changed = None
  • _proxied_interface = None
  • _skip_wrapper_lookup = None
  • link_modes = ('Linked', 'Unlinked') - Built-in immutable sequence.
  • proxied_object = None
  • sync_modes = ('Time', 'Sync') - Built-in immutable sequence.

class EnumWrappingParameter(InternalParameterBase, PropertyHostMixin)

Properties

  • _live_ptr
  • automation_state
  • canonical_parent
  • default_value
  • display_value
  • max
  • min
  • name
  • original_name
  • short_value_items
  • state
  • value
  • value_items

Methods

__init__(self, parent=None, index_property_host=None, values_host=None, values_property=None, index_property=None, value_type=<class 'int'>, to_index_conversion=None, from_index_conversion=None, *a, **k)

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

_get_index(self)
_get_values(self)
_has_valid_parent(self)
_set_index(self, index)
add_automation_state_listener(self, slot, identify_sender=False, *a, **k)
add_name_listener(self, slot, identify_sender=False, *a, **k)
add_state_listener(self, slot, identify_sender=False, *a, **k)
add_value_items_listener(self, slot, identify_sender=False, *a, **k)
add_value_listener(self, slot, identify_sender=False, *a, **k)
automation_state_has_listener(self, slot)
automation_state_listener_count(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
name_has_listener(self, slot)
name_listener_count(self)
notify_automation_state(self, *a, **k)
notify_name(self, *a, **k)
notify_state(self, *a, **k)
notify_value(self, *a, **k)
notify_value_items(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_automation_state_listener(self, slot)
remove_name_listener(self, slot)
remove_state_listener(self, slot)
remove_value_items_listener(self, slot)
remove_value_listener(self, slot)
set_property_host(self, new_host)
state_has_listener(self, slot)
state_listener_count(self)
unregister_disconnectable(self, slot)
value_has_listener(self, slot)
value_items_has_listener(self, slot)
value_items_listener_count(self)
value_listener_count(self)

Attributes

  • is_enabled = True - bool(x) -> bool
  • is_quantized = True - bool(x) -> bool

class EventObject(CompoundDisconnectable)

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)

class LinkedState(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.

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
  • linked = 1
  • 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
  • unlinked = 0

class LiveObjectDecorator(CompoundDisconnectable, Proxy)

Properties

  • options
  • parameters
  • proxied_interface

Methods

__init__(self, live_object=None, additional_properties={})

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

_add_enum_parameter(self, name, values, default_value)
_add_non_automatable_enum_parameter(self, name, list, index)
_add_non_automatable_int_parameter(self, name, property_name, min, max, units)
_add_on_off_option(self, name, pname)
_add_switch_option(self, name, pname, labels)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
proxy_old_hasattr(self, attr)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
unregister_disconnectable(self, slot)

Attributes

  • _proxied_interface = None
  • _skip_wrapper_lookup = None
  • proxied_object = None

class NotifyingList(EventObject)

Properties

  • available_values
  • index

Methods

__init__(self, available_values, default_value=None, *a, **k)

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

_get_index(self)
_set_index(self, value)
add_index_listener(self, slot, identify_sender=False, *a, **k)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
index_has_listener(self, slot)
index_listener_count(self)
notify_index(self, *a, **k)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_index_listener(self, slot)
unregister_disconnectable(self, slot)