Skip to content

_Framework.InputControlElement (runtime)

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

Module constants

  • MIDI_CC_STATUS = 176
  • MIDI_CC_TYPE = 1
  • MIDI_INVALID_TYPE = 4
  • MIDI_MSG_TYPES = (0, 1, 2, 3, 4)
  • MIDI_NOTE_OFF_STATUS = 128
  • MIDI_NOTE_ON_STATUS = 144
  • MIDI_NOTE_TYPE = 0
  • MIDI_PB_STATUS = 224
  • MIDI_PB_TYPE = 2
  • MIDI_SYSEX_TYPE = 3
  • logger = <Logger _Framework.InputControlElement (INFO)>

Functions

const(value)

depends(**dependencies)

in_range(value, lower_bound, upper_open_bound)

nop(*a, **k)

Classes

class Disconnectable

Methods

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

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

disconnect(self)

class InputControlElement(NotifyingControlElement)

Properties

  • _last_sent_value
  • mapping_sensitivity
  • resource
  • 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, *a, **k)

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

_do_send_value(self, value, channel=None)
_get_mapping_sensitivity(self)
_get_suppress_script_forwarding(self)
_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)
_set_mapping_sensitivity(self, sensitivity)
_set_suppress_script_forwarding(self, value)
_status_byte(self, channel)
_verify_value(self, value)
add_value_listener(self, slot, identify_sender=False, *a, **k)
begin_gesture(self)
clear_send_cache(self)
clear_value_listeners(self)
connect_to(self, parameter)
disconnect(self)
end_gesture(self)
force_next_send(self)
identifier_bytes(self)
install_connections(self, install_translation, install_mapping, install_forwarding)
mapped_parameter(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)
receive_value(self, value)
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)
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 = <_Framework.Util.lazy_attribute object at 0x129db44d0>
  • _tasks = <_Framework.Util.lazy_attribute object at 0x129db4710>
  • canonical_parent = None
  • name = '' - str(object='') -> str
  • num_delayed_messages = 1 - int([x]) -> integer
  • optimized_send_midi = True - bool(x) -> bool
  • proxied_interface = <_Framework.Util.lazy_attribute object at 0x129db4290>
  • send_depends_on_forwarding = 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 NotifyingControlElement(Subject, ControlElement)

Properties

  • resource

Methods

ProxiedInterface(outer=None, *a, **k)
__init__(self, name='', resource_type=None, optimized_send_midi=None, send_midi=None, register_control=None, *a, **k)

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

_on_resource_lost(self, client)
_on_resource_received(self, client, *a, **k)
_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)
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)
clear_value_listeners(self)

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

disconnect(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

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)
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
  • _resource = <_Framework.Util.lazy_attribute object at 0x129db44d0>
  • _tasks = <_Framework.Util.lazy_attribute object at 0x129db4710>
  • canonical_parent = None
  • name = '' - str(object='') -> str
  • optimized_send_midi = True - bool(x) -> bool
  • proxied_interface = <_Framework.Util.lazy_attribute object at 0x129db4290>

class ParameterSlot(Disconnectable)

Properties

  • control
  • parameter

Methods

__init__(self, parameter=None, control=None, *a, **k)

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

_get_control(self)
_get_parameter(self)
_set_control(self, control)
_set_parameter(self, parameter)
connect(self)
disconnect(self)
soft_disconnect(self)

Attributes

  • _control = None
  • _parameter = None

class Signal

Properties

  • count

Methods

__call__(self, *a, **k)

Call self as a function.

__init__(self, combiner=<function default_combiner at 0x129dd59e0>, sender=None, *a, **k)

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

connect(self, slot, in_front=False, sender=None)
disconnect(self, slot)
disconnect_all(self)
is_connected(self, slot)

class SubjectEvent(NamedTuple)

Methods

__init__(self, *others, **k)

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

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

Attributes

  • _eq_dict = <_Framework.Util.lazy_attribute object at 0x129d83b50>
  • doc = '' - str(object='') -> str
  • name = None
  • override = False - bool(x) -> bool