`ableton.v2.control_surface.elements.encoder` (runtime)¶

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

Module constants¶

ABSOLUTE_MAP_MODES = (MidiMap.MapMode.absolute, MidiMap.MapMode.absolute_14_bit)
ENCODER_VALUE_ACCUMULATOR = {MidiMap.MapMode.relative_smooth_two_compliment: <function accumulate_relative_two_compliment_chunk at 0x13c163560>}
ENCODER_VALUE_NORMALIZER = {MidiMap.MapMode.relative_two_compliment: <function normalize_two_compliment at 0x13c1614e0>, MidiMap.MapMode.relative_smooth_two_compliment: <function normaliz...
MAX_14_BIT_CC = 95
MIDI_CC_TYPE = 1
SIGNED_BIT_DEFAULT_DELTA = 20.0
SIGNED_BIT_VALUE_MAP = (1, 2, 3, 4, 5, 8, 10, 20, 50)

Functions¶

`accumulate_relative_two_compliment_chunk(chunk)`¶

`clamp(val, minv, maxv)`¶

`const(value)`¶

`in_range(value, lower_bound, upper_open_bound)`¶

`listens(event_path, *a, **k)`¶

`nop(*a, **k)`¶

`normalize_two_compliment(value)`¶

`old_div(a, b)`¶

`signed_bit_delta(value)`¶

Classes¶

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 `EncoderElement(InputControlElement)`¶

Properties¶

_last_sent_value
is_feedback_enabled
mapping_sensitivity
resource
script_forwarding
send_depends_on_forwarding
suppress_script_forwarding

Methods¶

`ProxiedInterface(outer=None, *a, **k)`¶

`init(self, msg_type, channel, identifier, map_mode, encoder_sensitivity=None, *a, **k)`¶

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

`_do_send_value(self, value, channel=None)`¶

`_mapping_feedback_values(self)`¶

`_on_resource_lost(self, client)`¶

`_on_resource_received(self, client, *a, **k)`¶

`_report_value(self, value, is_input)`¶

`_resource(self)`¶

`_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)`¶

`_send_delayed_messages(self)`¶

`_status_byte(self, channel)`¶

`_tasks(self, parent_task_group=None)`¶

`_verify_value(self, value)`¶

`add_normalized_value_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_value_listener(self, slot, identify_sender=False, *a, **k)`¶

`begin_gesture(self)`¶

`clear_send_cache(self)`¶

`connect_to(self, parameter)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`end_gesture(self)`¶

`find_disconnectable(self, predicate)`¶

`force_next_send(self)`¶

`has_disconnectable(self, slot)`¶

`identifier_bytes(self)`¶

`install_connections(self, install_translation, install_mapping, install_forwarding)`¶

`mapped_parameter(self)`¶

`max_value(self)`¶

`message_channel(self)`¶

`message_identifier(self)`¶

`message_map_mode(self)`¶

`message_sysex_identifier(self)`¶

`message_type(self)`¶

`needs_takeover(self)`¶

`normalize_value(self, value)`¶

`normalized_value_has_listener(self, slot)`¶

`normalized_value_listener_count(self)`¶

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

`notify_ownership_change(self, client, grabbed, element_ownership_handler=None)`¶

`notify_value(self, value)`¶

`original_channel(self)`¶

`original_identifier(self)`¶

`proxied_interface(self)`¶

`receive_chunk(self, chunk)`¶

`receive_value(self, value)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`relative_value_to_delta(self, value)`¶

`release_parameter(self)`¶

`remove_normalized_value_listener(self, slot)`¶

`remove_value_listener(self, slot)`¶

`reset(self)`¶

`reset_state(self)`¶

`script_wants_forwarding(self)`¶

`send_midi(self, message)`¶

`send_value(self, value, force=False, channel=None)`¶

`set_channel(self, channel)`¶

`set_feedback_delay(self, delay)`¶

`set_identifier(self, identifier)`¶

`set_needs_takeover(self, needs_takeover)`¶

`set_report_values(self, report_input, report_output)`¶

`unregister_disconnectable(self, slot)`¶

`use_default_message(self)`¶

`value_has_listener(self, slot)`¶

`value_listener_count(self)`¶

Attributes¶

_has_resource = False - bool(x) -> bool
_has_task_group = False - bool(x) -> bool
_input_signal_listener_count = 0 - int([x]) -> integer
allow_receiving_chunks = True - bool(x) -> bool
canonical_parent = None
encoder_sensitivity = 1.0 - Convert a string or number to a floating point number, if possible.
name = '' - str(object='') -> str
num_delayed_messages = 1 - int([x]) -> integer
optimized_send_midi = True - bool(x) -> bool

class `Event(NamedTuple)`¶

Methods¶

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

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

`_eq_dict(self)`¶

`signal(combiner=<function default_combiner at 0x11afcade0>, sender=None, *a, **k)`¶

Attributes¶

doc = '' - str(object='') -> str
name = None
override = False - bool(x) -> bool

class `FineGrainWithModifierEncoderElement(WrapperElement)`¶

Properties¶

proxied_object
resource
wrapped_control

Methods¶

`ProxiedInterface(outer=None, *a, **k)`¶

`init(self, encoder=None, modifier=None, modified_sensitivity=0.1, default_sensitivity=None, *a, **k)`¶

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

`_connect_nested_control_elements(self)`¶

`_disconnect_nested_control_elements(self)`¶

`_enforce_control_invariant(self)`¶

`_get_nested_client(self, client)`¶

`_grab_nested_control_elements(self, client, priority=None, **k)`¶

`_is_initialized(self)`¶

`_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_normalized_value_listener(self, listener)`¶

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

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

`clear_send_cache(self)`¶

`connect_to(self, parameter)`¶

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

`normalized_value_has_listener(self, listener)`¶

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

`proxy_old_hasattr(self, attr)`¶

`register_control_element(self, element)`¶

`register_control_elements(self, *elements)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`register_wrapped(self)`¶

`release_parameter(self)`¶

`remove_normalized_value_listener(self, listener)`¶

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

`set_sensitivities(self, default, modified)`¶

`unregister_control_element(self, element)`¶

`unregister_control_elements(self, *elements)`¶

`unregister_disconnectable(self, slot)`¶

`unregister_wrapped(self)`¶

`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
_FineGrainWithModifierEncoderElement__on_modifier_value = None
_FineGrainWithModifierEncoderElement__on_normalized_value = None
_has_resource = False - bool(x) -> bool
_has_task_group = False - bool(x) -> bool
_is_resource_based = False - bool(x) -> bool
_skip_wrapper_lookup = None
canonical_parent = None
name = '' - str(object='') -> str
optimized_send_midi = True - bool(x) -> bool

class `InputControlElement(NotifyingControlElement)`¶

Properties¶

_last_sent_value
is_feedback_enabled
mapping_sensitivity
resource
script_forwarding
send_depends_on_forwarding
suppress_script_forwarding

Methods¶

`ProxiedInterface(outer=None, *a, **k)`¶

`init(self, msg_type=None, channel=None, identifier=None, sysex_identifier=None, request_rebuild_midi_map=None, send_should_depend_on_forwarding=True, is_feedback_enabled=True, *a, **k)`¶

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

`_do_send_value(self, value, channel=None)`¶

`_mapping_feedback_values(self)`¶

`_on_resource_lost(self, client)`¶

`_on_resource_received(self, client, *a, **k)`¶

`_report_value(self, value, is_input)`¶

`_resource(self)`¶

`_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)`¶

`_send_delayed_messages(self)`¶

`_status_byte(self, channel)`¶

`_tasks(self, parent_task_group=None)`¶

`_verify_value(self, value)`¶

`add_value_listener(self, slot, identify_sender=False, *a, **k)`¶

`begin_gesture(self)`¶

`clear_send_cache(self)`¶

`connect_to(self, parameter)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`end_gesture(self)`¶

`find_disconnectable(self, predicate)`¶

`force_next_send(self)`¶

`has_disconnectable(self, slot)`¶

`identifier_bytes(self)`¶

`install_connections(self, install_translation, install_mapping, install_forwarding)`¶

`mapped_parameter(self)`¶

`max_value(self)`¶

`message_channel(self)`¶

`message_identifier(self)`¶

`message_map_mode(self)`¶

`message_sysex_identifier(self)`¶

`message_type(self)`¶

`needs_takeover(self)`¶

`notify_ownership_change(self, client, grabbed, element_ownership_handler=None)`¶

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

`original_channel(self)`¶

`original_identifier(self)`¶

`proxied_interface(self)`¶

`receive_chunk(self, chunk)`¶

`receive_value(self, value)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`release_parameter(self)`¶

`remove_value_listener(self, slot)`¶

`reset(self)`¶

`reset_state(self)`¶

`script_wants_forwarding(self)`¶

`send_midi(self, message)`¶

`send_value(self, value, force=False, channel=None)`¶

`set_channel(self, channel)`¶

`set_feedback_delay(self, delay)`¶

`set_identifier(self, identifier)`¶

`set_needs_takeover(self, needs_takeover)`¶

`set_report_values(self, report_input, report_output)`¶

`unregister_disconnectable(self, slot)`¶

`use_default_message(self)`¶

`value_has_listener(self, slot)`¶

`value_listener_count(self)`¶

Attributes¶

_has_resource = False - bool(x) -> bool
_has_task_group = False - bool(x) -> bool
_input_signal_listener_count = 0 - int([x]) -> integer
allow_receiving_chunks = False - bool(x) -> bool
canonical_parent = None
name = '' - str(object='') -> str
num_delayed_messages = 1 - int([x]) -> integer
optimized_send_midi = True - bool(x) -> bool

class `InputSignal(Signal)`¶

Properties¶

count

Methods¶

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

Call self as a function.

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

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

`_listeners_update(self)`¶

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

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

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

`is_connected(self, slot)`¶

class `TouchEncoderElement(CompoundElement, TouchEncoderElementBase)`¶

Properties¶

_last_sent_value
is_feedback_enabled
mapping_sensitivity
resource
script_forwarding
send_depends_on_forwarding
suppress_script_forwarding
touch_element

Methods¶

`ProxiedInterface(outer=None, *a, **k)`¶

`init(self, msg_type=1, channel=0, identifier=0, map_mode=MidiMap.MapMode.absolute, touch_element=None, *a, **k)`¶

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

`_connect_nested_control_elements(self)`¶

`_disconnect_nested_control_elements(self)`¶

`_do_send_value(self, value, channel=None)`¶

`_get_nested_client(self, client)`¶

`_grab_nested_control_elements(self, client, priority=None, **k)`¶

`_mapping_feedback_values(self)`¶

`_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)`¶

`_report_value(self, value, is_input)`¶

`_resource(self)`¶

`_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)`¶

`_send_delayed_messages(self)`¶

`_status_byte(self, channel)`¶

`_tasks(self, parent_task_group=None)`¶

`_verify_value(self, value)`¶

`add_normalized_value_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_touch_value_listener(self, slot, identify_sender=False, *a, **k)`¶

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

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

`begin_gesture(self)`¶

`clear_send_cache(self)`¶

`connect_to(self, parameter)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`end_gesture(self)`¶

`find_disconnectable(self, predicate)`¶

`force_next_send(self)`¶

`get_control_element_priority(self, element, priority)`¶

`has_control_element(self, control)`¶

`has_disconnectable(self, slot)`¶

`identifier_bytes(self)`¶

`install_connections(self, install_translation, install_mapping, install_forwarding)`¶

`is_pressed(self)`¶

`mapped_parameter(self)`¶

`max_value(self)`¶

`message_channel(self)`¶

`message_identifier(self)`¶

`message_map_mode(self)`¶

`message_sysex_identifier(self)`¶

`message_type(self)`¶

`needs_takeover(self)`¶

`nested_control_elements(self)`¶

`normalize_value(self, value)`¶

`normalized_value_has_listener(self, slot)`¶

`normalized_value_listener_count(self)`¶

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

`notify_ownership_change(self, client, grabbed, element_ownership_handler=None)`¶

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

`notify_value(self, value)`¶

`on_nested_control_element_lost(self, control)`¶

`on_nested_control_element_received(self, control)`¶

`on_nested_control_element_value(self, value, control)`¶

`original_channel(self)`¶

`original_identifier(self)`¶

`owned_control_elements(self)`¶

`owns_control_element(self, control)`¶

`proxied_interface(self)`¶

`receive_chunk(self, chunk)`¶

`receive_value(self, value)`¶

`register_control_element(self, element)`¶

`register_control_elements(self, *elements)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`relative_value_to_delta(self, value)`¶

`release_parameter(self)`¶

`remove_normalized_value_listener(self, slot)`¶

`remove_touch_value_listener(self, slot)`¶

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

`script_wants_forwarding(self)`¶

`send_midi(self, message)`¶

`send_value(self, value, force=False, channel=None)`¶

`set_channel(self, channel)`¶

`set_control_element(self, control, grabbed)`¶

`set_feedback_delay(self, delay)`¶

`set_identifier(self, identifier)`¶

`set_needs_takeover(self, needs_takeover)`¶

`set_report_values(self, report_input, report_output)`¶

`touch_value_has_listener(self, slot)`¶

`touch_value_listener_count(self)`¶

`unregister_control_element(self, element)`¶

`unregister_control_elements(self, *elements)`¶

`unregister_disconnectable(self, slot)`¶

`unrequest_listen_nested_control_elements(self)`¶

`use_default_message(self)`¶

`value_has_listener(self, slot)`¶

`value_listener_count(self)`¶

Attributes¶

_CompoundElement__on_nested_control_element_value = None
_has_resource = False - bool(x) -> bool
_has_task_group = False - bool(x) -> bool
_input_signal_listener_count = 0 - int([x]) -> integer
_is_resource_based = False - bool(x) -> bool
allow_receiving_chunks = True - bool(x) -> bool
canonical_parent = None
encoder_sensitivity = 1.0 - Convert a string or number to a floating point number, if possible.
name = '' - str(object='') -> str
num_delayed_messages = 1 - int([x]) -> integer
optimized_send_midi = True - bool(x) -> bool

class `TouchEncoderElementBase(EncoderElement)`¶

Properties¶

_last_sent_value
is_feedback_enabled
mapping_sensitivity
resource
script_forwarding
send_depends_on_forwarding
suppress_script_forwarding
touch_element

Methods¶

`ProxiedInterface(outer=None, *a, **k)`¶

`init(self, msg_type, channel, identifier, map_mode, encoder_sensitivity=None, *a, **k)`¶

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

`_do_send_value(self, value, channel=None)`¶

`_mapping_feedback_values(self)`¶

`_on_resource_lost(self, client)`¶

`_on_resource_received(self, client, *a, **k)`¶

`_report_value(self, value, is_input)`¶

`_resource(self)`¶

`_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)`¶

`_send_delayed_messages(self)`¶

`_status_byte(self, channel)`¶

`_tasks(self, parent_task_group=None)`¶

`_verify_value(self, value)`¶

`add_normalized_value_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_touch_value_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_value_listener(self, slot, identify_sender=False, *a, **k)`¶

`begin_gesture(self)`¶

`clear_send_cache(self)`¶

`connect_to(self, parameter)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`end_gesture(self)`¶

`find_disconnectable(self, predicate)`¶

`force_next_send(self)`¶

`has_disconnectable(self, slot)`¶

`identifier_bytes(self)`¶

`install_connections(self, install_translation, install_mapping, install_forwarding)`¶

`is_pressed(self)`¶

`mapped_parameter(self)`¶

`max_value(self)`¶

`message_channel(self)`¶

`message_identifier(self)`¶

`message_map_mode(self)`¶

`message_sysex_identifier(self)`¶

`message_type(self)`¶

`needs_takeover(self)`¶

`normalize_value(self, value)`¶

`normalized_value_has_listener(self, slot)`¶

`normalized_value_listener_count(self)`¶

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

`notify_ownership_change(self, client, grabbed, element_ownership_handler=None)`¶

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

`notify_value(self, value)`¶

`original_channel(self)`¶

`original_identifier(self)`¶

`proxied_interface(self)`¶

`receive_chunk(self, chunk)`¶

`receive_value(self, value)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`relative_value_to_delta(self, value)`¶

`release_parameter(self)`¶

`remove_normalized_value_listener(self, slot)`¶

`remove_touch_value_listener(self, slot)`¶

`remove_value_listener(self, slot)`¶

`reset(self)`¶

`reset_state(self)`¶

`script_wants_forwarding(self)`¶

`send_midi(self, message)`¶

`send_value(self, value, force=False, channel=None)`¶

`set_channel(self, channel)`¶

`set_feedback_delay(self, delay)`¶

`set_identifier(self, identifier)`¶

`set_needs_takeover(self, needs_takeover)`¶

`set_report_values(self, report_input, report_output)`¶

`touch_value_has_listener(self, slot)`¶

`touch_value_listener_count(self)`¶

`unregister_disconnectable(self, slot)`¶

`use_default_message(self)`¶

`value_has_listener(self, slot)`¶

`value_listener_count(self)`¶

Attributes¶

_has_resource = False - bool(x) -> bool
_has_task_group = False - bool(x) -> bool
_input_signal_listener_count = 0 - int([x]) -> integer
allow_receiving_chunks = True - bool(x) -> bool
canonical_parent = None
encoder_sensitivity = 1.0 - Convert a string or number to a floating point number, if possible.
name = '' - str(object='') -> str
num_delayed_messages = 1 - int([x]) -> integer
optimized_send_midi = True - bool(x) -> bool

class `WrapperElement(CompoundElement, ProxyBase)`¶

Properties¶

proxied_object
resource
wrapped_control

Methods¶

`ProxiedInterface(outer=None, *a, **k)`¶

`init(self, wrapped_control=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)`¶

`_is_initialized(self)`¶

`_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)`¶

`connect_to(self, parameter)`¶

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

`proxy_old_hasattr(self, attr)`¶

`register_control_element(self, element)`¶

`register_control_elements(self, *elements)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`register_wrapped(self)`¶

`release_parameter(self)`¶

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

`unregister_wrapped(self)`¶

`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
_skip_wrapper_lookup = None
canonical_parent = None
name = '' - str(object='') -> str
optimized_send_midi = True - bool(x) -> bool

class `map_modes(enum)`¶

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¶

absolute = MidiMap.MapMode.absolute
absolute_14_bit = MidiMap.MapMode.absolute_14_bit
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
name = <member 'name' of 'Boost.Python.enum' objects>
names = {'absolute': MidiMap.MapMode.absolute, 'relative_signed_bit': MidiMap.MapMode.relative_signed_bit, 'relative_binary_offset': MidiMap.MapMode.relative_binary_off... - dict() -> new empty dictionary
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
relative_binary_offset = MidiMap.MapMode.relative_binary_offset
relative_signed_bit = MidiMap.MapMode.relative_signed_bit
relative_signed_bit2 = MidiMap.MapMode.relative_signed_bit2
relative_smooth_binary_offset = MidiMap.MapMode.relative_smooth_binary_offset
relative_smooth_signed_bit = MidiMap.MapMode.relative_smooth_signed_bit
relative_smooth_signed_bit2 = MidiMap.MapMode.relative_smooth_signed_bit2
relative_smooth_two_compliment = MidiMap.MapMode.relative_smooth_two_compliment
relative_two_compliment = MidiMap.MapMode.relative_two_compliment
values = {0: MidiMap.MapMode.absolute, 1: MidiMap.MapMode.relative_signed_bit, 2: MidiMap.MapMode.relative_binary_offset, 3: MidiMap.MapMode.relative_two_compliment, 4: ... - dict() -> new empty dictionary

ableton.v2.control_surface.elements.encoder (runtime)¶

Module constants¶

Functions¶

accumulate_relative_two_compliment_chunk(chunk)¶

clamp(val, minv, maxv)¶

const(value)¶

in_range(value, lower_bound, upper_open_bound)¶

listens(event_path, *a, **k)¶

nop(*a, **k)¶

normalize_two_compliment(value)¶

old_div(a, b)¶

signed_bit_delta(value)¶

Classes¶

class CompoundElement(NotifyingControlElement, ControlElementClient)¶

Properties¶

Methods¶

ProxiedInterface(outer=None, *a, **k)¶

__init__(self, control_elements=None, *a, **k)¶

_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)¶

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

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

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

value_listener_count(self)¶

Attributes¶

class EncoderElement(InputControlElement)¶

Properties¶

Methods¶

ProxiedInterface(outer=None, *a, **k)¶

__init__(self, msg_type, channel, identifier, map_mode, encoder_sensitivity=None, *a, **k)¶

_do_send_value(self, value, channel=None)¶

_mapping_feedback_values(self)¶

_on_resource_lost(self, client)¶

_on_resource_received(self, client, *a, **k)¶

_report_value(self, value, is_input)¶

_resource(self)¶

_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)¶

_send_delayed_messages(self)¶

_status_byte(self, channel)¶

_tasks(self, parent_task_group=None)¶

`ableton.v2.control_surface.elements.encoder` (runtime)¶

`accumulate_relative_two_compliment_chunk(chunk)`¶

`clamp(val, minv, maxv)`¶

`const(value)`¶

`in_range(value, lower_bound, upper_open_bound)`¶

`listens(event_path, *a, **k)`¶

`nop(*a, **k)`¶

`normalize_two_compliment(value)`¶

`old_div(a, b)`¶

`signed_bit_delta(value)`¶

class `CompoundElement(NotifyingControlElement, ControlElementClient)`¶

`ProxiedInterface(outer=None, *a, **k)`¶

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

`_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)`¶

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

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

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

`value_listener_count(self)`¶

class `EncoderElement(InputControlElement)`¶

`ProxiedInterface(outer=None, *a, **k)`¶

`init(self, msg_type, channel, identifier, map_mode, encoder_sensitivity=None, *a, **k)`¶

`_do_send_value(self, value, channel=None)`¶

`_mapping_feedback_values(self)`¶

`_on_resource_lost(self, client)`¶

`_on_resource_received(self, client, *a, **k)`¶

`_report_value(self, value, is_input)`¶

`_resource(self)`¶

`_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)`¶

`_send_delayed_messages(self)`¶

`_status_byte(self, channel)`¶

`_tasks(self, parent_task_group=None)`¶

`_verify_value(self, value)`¶

`add_normalized_value_listener(self, slot, identify_sender=False, *a, **k)`¶

`add_value_listener(self, slot, identify_sender=False, *a, **k)`¶

`begin_gesture(self)`¶

`clear_send_cache(self)`¶

`connect_to(self, parameter)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶