Skip to content

ableton.v2.control_surface.compound_element (runtime)

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

Functions

first(seq)

listens_group(event_name, *a, **k)

second(seq)

Classes

class BooleanContext

Properties

  • value

Methods

Manager(managed=None, update_value=None, *a, **k)
__call__(self, update_value=None)

Call self as a function.

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

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

Attributes

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

class CompoundElement(NotifyingControlElement, ControlElementClient)

Properties

  • resource

Methods

ProxiedInterface(outer=None, *a, **k)
__init__(self, control_elements=None, *a, **k)

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

_connect_nested_control_elements(self)
_disconnect_nested_control_elements(self)
_get_nested_client(self, client)
_grab_nested_control_elements(self, client, priority=None, **k)
_on_nested_control_element_lost(self, control)
_on_nested_control_element_received(self, control)
_on_resource_lost(self, client)
_on_resource_received(self, client, *a, **k)
_release_nested_control_elements(self, client)
_resource(self)
_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)
_tasks(self, parent_task_group=None)
add_value_listener(self, *a, **k)

Called when the control element receives a MIDI value from the hardware

clear_send_cache(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
get_control_element_priority(self, element, priority)
has_control_element(self, control)
has_disconnectable(self, slot)
nested_control_elements(self)
notify_ownership_change(self, client, grabbed, element_ownership_handler=None)
notify_value(self, *a, **k)

Called when the control element receives a MIDI value from the hardware

on_nested_control_element_lost(self, control)
on_nested_control_element_received(self, control)
on_nested_control_element_value(self, value, control)
owned_control_elements(self)
owns_control_element(self, control)
proxied_interface(self)
register_control_element(self, element)
register_control_elements(self, *elements)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_value_listener(self, *a, **k)

Called when the control element receives a MIDI value from the hardware

request_listen_nested_control_elements(self)
reset(self)
reset_state(self)
send_midi(self, message)
set_control_element(self, control, grabbed)
unregister_control_element(self, element)
unregister_control_elements(self, *elements)
unregister_disconnectable(self, slot)
unrequest_listen_nested_control_elements(self)
value_has_listener(self, slot)

Called when the control element receives a MIDI value from the hardware

value_listener_count(self)

Called when the control element receives a MIDI value from the hardware

Attributes

  • _CompoundElement__on_nested_control_element_value = None
  • _has_resource = False - bool(x) -> bool
  • _has_task_group = False - bool(x) -> bool
  • _is_resource_based = False - bool(x) -> bool
  • canonical_parent = None
  • name = '' - str(object='') -> str
  • optimized_send_midi = True - bool(x) -> bool

class ControlElementClient

Methods

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

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

set_control_element(self, control_element, grabbed)

class NestedElementClient(ControlElementClient)

Methods

__init__(self, compound=None, client=None, **k)

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

set_control_element(self, element, grabbed)

class NotifyingControlElement(EventObject, ControlElement)

Properties

  • resource

Methods

ProxiedInterface(outer=None, *a, **k)
__init__(self, *a, **k)

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

_on_resource_lost(self, client)
_on_resource_received(self, client, *a, **k)
_resource(self)
_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)
_tasks(self, parent_task_group=None)
add_value_listener(self, slot, identify_sender=False, *a, **k)

Called when the control element receives a MIDI value from the hardware

clear_send_cache(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
notify_ownership_change(self, client, grabbed, element_ownership_handler=None)
notify_value(self, *a, **k)

Called when the control element receives a MIDI value from the hardware

proxied_interface(self)
register_disconnectable(self, slot)
register_disconnectables(self, disconnectables)
register_slot(self, *a, **k)
remove_value_listener(self, slot)

Called when the control element receives a MIDI value from the hardware

reset(self)
reset_state(self)
send_midi(self, message)
unregister_disconnectable(self, slot)
value_has_listener(self, slot)

Called when the control element receives a MIDI value from the hardware

value_listener_count(self)

Called when the control element receives a MIDI value from the hardware

Attributes

  • _has_resource = False - bool(x) -> bool
  • _has_task_group = False - bool(x) -> bool
  • canonical_parent = None
  • name = '' - str(object='') -> str
  • optimized_send_midi = True - bool(x) -> bool

class OrderedDict(dict)

Dictionary that remembers insertion order

Methods

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

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

clear(...)

od.clear() -> None. Remove all items from od.

copy(...)

od.copy() -> a shallow copy of od

fromkeys(iterable, value=None)

Create a new ordered dictionary with keys from iterable and values set to value.

get(self, key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items(...)

D.items() -> a set-like object providing a view on D's items

keys(...)

D.keys() -> a set-like object providing a view on D's keys

move_to_end(self, /, key, last=True)

Move an existing element to the end (or beginning if last is false).

Raise KeyError if the element does not exist.

pop(...)

od.pop(key[,default]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem(self, /, last=True)

Remove and return a (key, value) pair from the dictionary.

Pairs are returned in LIFO order if last is true or FIFO order if false.

setdefault(self, /, key, default=None)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update(...)

D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values(...)

D.values() -> an object providing a view on D's values