ableton.v3.control_surface.elements.button_matrix (runtime)¶
Live 11 — Live Object Model & framework reference (descriptions and signatures).
Functions¶
recursive_map(fn, element, sequence_type=None)¶
slicer(dimensions)¶
to_slice(obj)¶
Classes¶
class ButtonMatrixElement(ButtonMatrixElement, Renderable)¶
Properties¶
resourcesubmatrix
Methods¶
ProxiedInterface(outer=None, *a, **k)¶
__init__(self, rows=[], *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
_connect_nested_control_elements(self)¶
_create_event_handler(self, property_name)¶
_disconnect_nested_control_elements(self)¶
_do_get_item(self, index)¶
_get_nested_client(self, client)¶
_grab_nested_control_elements(self, client, priority=None, **k)¶
_init_state_from_controls(self, renderable_state)¶
_init_state_from_listenable_properties(self, renderable_state)¶
_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_type(on_received_callback=None, on_lost_callback=None, *a, **k)¶
add_row(self, buttons)¶
add_value_listener(self, *a, **k)¶
Called when the control element receives a MIDI value from the hardware
clear_send_cache(self)¶
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)¶
get_button(self, row, column)¶
get_control_element_priority(self, element, priority)¶
has_control_element(self, control)¶
has_disconnectable(self, slot)¶
height(self)¶
iterbuttons(self)¶
nested_control_elements(self)¶
notify(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')¶
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, sender)¶
owned_control_elements(self)¶
owns_control_element(self, control)¶
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)¶
send_value(self, column, row, value, force=False)¶
set_channel(self, channel)¶
set_control_element(self, control, grabbed)¶
set_light(self, column, row, value)¶
suppress_notifications(self)¶
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
width(self)¶
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_resource=<ableton.v2.base.util.lazy_attribute object at 0x11b312780>_tasks=<ableton.v2.base.util.lazy_attribute object at 0x1630c8898>canonical_parent=Noneinclude_in_top_level_state=True- bool(x) -> boolname=''- str(object='') -> stroptimized_send_midi=True- bool(x) -> boolproxied_interface=<ableton.v2.base.util.lazy_attribute object at 0x11df40710>renderable_state=<ableton.v2.base.util.lazy_attribute object at 0x1639e9710>
class ButtonMatrixElementBase(CompoundElement)¶
Properties¶
resourcesubmatrix
Methods¶
ProxiedInterface(outer=None, *a, **k)¶
__init__(self, rows=[], *a, **k)¶
Initialize self. See help(type(self)) for accurate signature.
_connect_nested_control_elements(self)¶
_disconnect_nested_control_elements(self)¶
_do_get_item(self, index)¶
_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_type(on_received_callback=None, on_lost_callback=None, *a, **k)¶
add_row(self, buttons)¶
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_button(self, row, column)¶
get_control_element_priority(self, element, priority)¶
has_control_element(self, control)¶
has_disconnectable(self, slot)¶
height(self)¶
iterbuttons(self)¶
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, sender)¶
owned_control_elements(self)¶
owns_control_element(self, control)¶
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)¶
send_value(self, column, row, value, force=False)¶
set_channel(self, channel)¶
set_control_element(self, control, grabbed)¶
set_light(self, column, row, value)¶
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
width(self)¶
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_resource=<ableton.v2.base.util.lazy_attribute object at 0x11b312780>_tasks=<ableton.v2.base.util.lazy_attribute object at 0x1630c8898>canonical_parent=Nonename=''- str(object='') -> stroptimized_send_midi=True- bool(x) -> boolproxied_interface=<ableton.v2.base.util.lazy_attribute object at 0x11df40710>
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)¶
suppress_notifications(self)¶
unregister_disconnectable(self, slot)¶
Attributes¶
include_in_top_level_state=True- bool(x) -> boolrenderable_state=<ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>
class lazy_attribute¶
Methods¶
__init__(self, func, name=None)¶
Initialize self. See help(type(self)) for accurate signature.