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

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

Module constants¶

DEFAULT_CONTINUOUS_PARAMETER_SENSITIVITY = 1.0
FINE_GRAIN_SENSITIVITY_FACTOR = 0.1
MIDI_CC_TYPE = 1

Functions¶

`display_name(obj: Union[Scene.Scene, Clip.Clip, ClipSlot.ClipSlot, DeviceParameter.DeviceParameter], strip_space=True)`¶

`is_internal_parameter(parameter)`¶

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

`liveobj_valid(obj)`¶

`parameter_value_to_midi_value(parameter, max_value=128)`¶

Classes¶

class `EncoderElement(EncoderElement, Renderable)`¶

Properties¶

_last_sent_value
is_feedback_enabled
mapping_sensitivity
parameter
parameter_name
parameter_value
resource
script_forwarding
send_depends_on_forwarding
suppress_script_forwarding

Methods¶

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

`init(self, identifier, channel=0, msg_type=1, map_mode=MidiMap.MapMode.absolute, mapping_sensitivity=1.0, sensitivity_modifier=None, needs_takeover=True, is_feedback_enabled=False, feedback_delay=0, *a, **k)`¶

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

`_clear_parameter_listeners(self)`¶

`_create_event_handler(self, property_name)`¶

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

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`_mapping_feedback_values(self)`¶

`_on_resource_lost(self, client)`¶

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

`_parameter_value_changed(self)`¶

`_report_value(self, value, is_input)`¶

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

`_send_delayed_messages(self)`¶

`_set_sensitivity(self, use_fine_grain)`¶

`_status_byte(self, channel)`¶

`_unblock_internal_parameter_feedback(self)`¶

`_update_parameter_listeners(self)`¶

`_verify_value(self, value)`¶

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

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

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

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

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

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

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`dispatch_event(self, name: 'str', value)`¶

`end_gesture(self)`¶

`find_disconnectable(self, predicate)`¶

`force_next_send(self)`¶

`has_disconnectable(self, slot)`¶

`identifier_bytes(self)`¶

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

`is_mapped_manually(self)`¶

`is_mapped_to_parameter(self)`¶

`mapped_object_has_listener(self, slot)`¶

`mapped_object_listener_count(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(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')`¶

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

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

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

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

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

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

`notify_value(self, value)`¶

`original_channel(self)`¶

`original_identifier(self)`¶

`parameter_has_listener(self, slot)`¶

`parameter_listener_count(self)`¶

`parameter_name_has_listener(self, slot)`¶

`parameter_name_listener_count(self)`¶

`parameter_value_has_listener(self, slot)`¶

`parameter_value_listener_count(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_mapped_object_listener(self, slot)`¶

`remove_normalized_value_listener(self, slot)`¶

`remove_parameter_listener(self, slot)`¶

`remove_parameter_name_listener(self, slot)`¶

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

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

`use_default_message(self)`¶

`value_has_listener(self, slot)`¶

`value_listener_count(self)`¶

Attributes¶

_EncoderElement__on_parameter_name_changed = None
_EncoderElement__on_parameter_value_changed = None
_EncoderElement__on_sensitivity_modifier_value = None
_has_resource = False - bool(x) -> bool
_has_task_group = False - bool(x) -> bool
_input_signal_listener_count = 0 - int([x]) -> integer
_resource = <ableton.v2.base.util.lazy_attribute object at 0x11b312780>
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x1630c8898>
_unblock_internal_parameter_feedback_task = <ableton.v2.base.util.lazy_attribute object at 0x163a17b38>
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.
include_in_top_level_state = True - bool(x) -> bool
mapped_object = None
name = '' - str(object='') -> str
num_delayed_messages = 1 - int([x]) -> integer
optimized_send_midi = True - bool(x) -> bool
proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>
renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

class `EncoderElementBase(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_type(on_received_callback=None, on_lost_callback=None, *a, **k)`¶

`_send_delayed_messages(self)`¶

`_status_byte(self, channel)`¶

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

`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
_resource = <ableton.v2.base.util.lazy_attribute object at 0x11b312780>
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x1630c8898>
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
proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>

class `MappingSensitivity`¶

Methods¶

`init(self, standard, parent)`¶

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

`_set_sensitivities(self, standard, fine_grain)`¶

`_update_sensitivity(self)`¶

`should_use_fine_grain(self, use_fine_grain)`¶

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) -> bool
renderable_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.

class `listenable_property(listenable_property_base, property)`¶

Property attribute.

fget function to be used for getting an attribute value fset function to be used for setting an attribute value fdel function to be used for del'ing an attribute doc docstring

Typical use is to define a managed attribute x:

class C(object): def getx(self): return self._x def setx(self, value): self._x = value def delx(self): del self._x x = property(getx, setx, delx, "I'm the 'x' property.")

Decorators make defining new properties or modifying existing ones easy:

class C(object): @property def x(self): "I am the 'x' property." return self._x @x.setter def x(self, value): self._x = value @x.deleter def x(self): del self._x

Methods¶

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

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

`deleter(...)`¶

Descriptor to change the deleter on a property.

`getter(...)`¶

Descriptor to change the getter on a property.

`managed(default_value)`¶

`set_property_name(self, name)`¶

`setter(...)`¶

Descriptor to change the setter on a property.

Attributes¶

fdel = <member 'fdel' of 'property' objects>
fget = <member 'fget' of 'property' objects>
fset = <member 'fset' of 'property' objects>

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

Module constants¶

Functions¶

display_name(obj: Union[Scene.Scene, Clip.Clip, ClipSlot.ClipSlot, DeviceParameter.DeviceParameter], strip_space=True)¶

is_internal_parameter(parameter)¶

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

liveobj_valid(obj)¶

parameter_value_to_midi_value(parameter, max_value=128)¶

Classes¶

class EncoderElement(EncoderElement, Renderable)¶

Properties¶

Methods¶

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

__init__(self, identifier, channel=0, msg_type=1, map_mode=MidiMap.MapMode.absolute, mapping_sensitivity=1.0, sensitivity_modifier=None, needs_takeover=True, is_feedback_enabled=False, feedback_delay=0, *a, **k)¶

_clear_parameter_listeners(self)¶

_create_event_handler(self, property_name)¶

_do_send_value(self, value, channel=None)¶

_init_state_from_controls(self, renderable_state)¶

_init_state_from_listenable_properties(self, renderable_state)¶

_mapping_feedback_values(self)¶

_on_resource_lost(self, client)¶

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

_parameter_value_changed(self)¶

_report_value(self, value, is_input)¶

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

_send_delayed_messages(self)¶

_set_sensitivity(self, use_fine_grain)¶

_status_byte(self, channel)¶

_unblock_internal_parameter_feedback(self)¶

_update_parameter_listeners(self)¶

_verify_value(self, value)¶

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

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

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

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

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

control_base_type(extra_args=None, extra_kws=None, *a, **k)¶

disconnect(self)¶

disconnect_disconnectable(self, slot)¶

dispatch_event(self, name: 'str', value)¶

end_gesture(self)¶

find_disconnectable(self, predicate)¶

force_next_send(self)¶

has_disconnectable(self, slot)¶

identifier_bytes(self)¶

install_connections(self, *a, **k)¶

is_mapped_manually(self)¶

is_mapped_to_parameter(self)¶

mapped_object_has_listener(self, slot)¶

mapped_object_listener_count(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(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')¶

notify_mapped_object(self, *a, **k)¶

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

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

notify_parameter(self, *a, **k)¶

notify_parameter_name(self, *a, **k)¶

notify_parameter_value(self, *a, **k)¶

notify_value(self, value)¶

original_channel(self)¶

original_identifier(self)¶

parameter_has_listener(self, slot)¶

parameter_listener_count(self)¶

parameter_name_has_listener(self, slot)¶

parameter_name_listener_count(self)¶

parameter_value_has_listener(self, slot)¶

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

`display_name(obj: Union[Scene.Scene, Clip.Clip, ClipSlot.ClipSlot, DeviceParameter.DeviceParameter], strip_space=True)`¶

`is_internal_parameter(parameter)`¶

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

`liveobj_valid(obj)`¶

`parameter_value_to_midi_value(parameter, max_value=128)`¶

class `EncoderElement(EncoderElement, Renderable)`¶

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

`init(self, identifier, channel=0, msg_type=1, map_mode=MidiMap.MapMode.absolute, mapping_sensitivity=1.0, sensitivity_modifier=None, needs_takeover=True, is_feedback_enabled=False, feedback_delay=0, *a, **k)`¶

`_clear_parameter_listeners(self)`¶

`_create_event_handler(self, property_name)`¶

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

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`_mapping_feedback_values(self)`¶

`_on_resource_lost(self, client)`¶

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

`_parameter_value_changed(self)`¶

`_report_value(self, value, is_input)`¶

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

`_send_delayed_messages(self)`¶

`_set_sensitivity(self, use_fine_grain)`¶

`_status_byte(self, channel)`¶

`_unblock_internal_parameter_feedback(self)`¶

`_update_parameter_listeners(self)`¶

`_verify_value(self, value)`¶

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

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

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

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

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

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

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`dispatch_event(self, name: 'str', value)`¶

`end_gesture(self)`¶

`find_disconnectable(self, predicate)`¶

`force_next_send(self)`¶

`has_disconnectable(self, slot)`¶

`identifier_bytes(self)`¶

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

`is_mapped_manually(self)`¶

`is_mapped_to_parameter(self)`¶

`mapped_object_has_listener(self, slot)`¶

`mapped_object_listener_count(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(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')`¶

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

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

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

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

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

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

`notify_value(self, value)`¶

`original_channel(self)`¶

`original_identifier(self)`¶

`parameter_has_listener(self, slot)`¶

`parameter_listener_count(self)`¶

`parameter_name_has_listener(self, slot)`¶

`parameter_name_listener_count(self)`¶

`parameter_value_has_listener(self, slot)`¶

`parameter_value_listener_count(self)`¶

`receive_chunk(self, chunk)`¶

`receive_value(self, value)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶