Package _Framework :: Module InputControlElement :: Class InputControlElement

Class InputControlElement

                             object --+            
                                      |            
          Disconnectable.Disconnectable --+        
                                          |        
                        SubjectSlot.Subject --+    
                                              |    
                             object --+       |    
                                      |       |    
          Disconnectable.Disconnectable --+   |    
                                          |   |    
              ControlElement.ControlElement --+    
                                              |    
NotifyingControlElement.NotifyingControlElement --+
                                                  |
                                                 InputControlElement

Base class for all classes representing control elements on a controller

Nested Classes

[hide private]

Inherited from SubjectSlot.Subject: __metaclass__

Inherited from ControlElement.ControlElement (private): _resource_type

Instance Methods

[hide private]

__init__(self, msg_type=None, channel=None, identifier=None, sysex_identifier=None, request_rebuild_midi_map=None, *a, **k)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

message_type(self)

source code

message_channel(self)

source code

message_identifier(self)

source code

message_sysex_identifier(self)

source code

message_map_mode(self)

source code

_get_mapping_sensitivity(self)

source code

_set_mapping_sensitivity(self, sensitivity)

source code

force_next_send(self)
Enforces sending the next value regardless of wether the control is mapped to the script.

source code

set_channel(self, channel)

source code

set_identifier(self, identifier)

source code

set_needs_takeover(self, needs_takeover)

source code

set_feedback_delay(self, delay)

source code

needs_takeover(self)

source code

use_default_message(self)

source code

_mapping_feedback_values(self)

source code

install_connections(self, install_translation, install_mapping, install_forwarding)

source code

script_wants_forwarding(self)
Returns wether the script wants to receive receive the values, otherwise, the control will be mapped to the track.

source code

begin_gesture(self)
Begins a modification on the input control element, meaning that we should consider the next flow of input data as a consistent gesture from the user.

source code

end_gesture(self)
Ends a modification of the input control element.

source code

connect_to(self, parameter)
parameter is a Live.Device.DeviceParameter

source code

release_parameter(self)

source code

mapped_parameter(self)

source code

_status_byte(self, channel)

source code

identifier_bytes(self)
Returns a list with all the MIDI message prefixes that identify this control element.

source code

_send_delayed_messages(self)

source code

send_value(self, value, force_send=False, channel=None)

source code

_do_send_value(self, value, channel=None)

source code

clear_send_cache(self)

source code

reset(self)
Send 0 to reset motorized faders and turn off LEDs

source code

receive_value(self, value)

source code

set_report_values(self, report_input, report_output)
Set boolean values report_input and report_output enabling debug information.

source code

_verify_value(self, value)

source code

_report_value(self, value, is_input)

source code

_last_sent_value(self)

source code

Inherited from ControlElement.ControlElement: disconnect, send_midi

Inherited from ControlElement.ControlElement (private): _on_grab_resource, _on_release_resource, _resource, _tasks

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

__subject_events__ = SubjectEvent(name= 'value', signal= Input...

_input_signal_listener_count = 0

num_delayed_messages = 1

send_depends_on_forwarding = True

mapping_sensitivity = property(_get_mapping_sensitivity, _set_...

Inherited from ControlElement.ControlElement: canonical_parent, name, optimized_send_midi

Inherited from ControlElement.ControlElement (private): _has_resource, _has_task_group

Properties

[hide private]

Inherited from ControlElement.ControlElement: resource

Inherited from object: __class__

Method Details

[hide private]

init(self, msg_type=None, channel=None, identifier=None, sysex_identifier=None, request_rebuild_midi_map=None, *a, **k)
(Constructor)

source code

x.__init__(...) initializes x; see help(type(x)) for signature

Decorators:

@depends(request_rebuild_midi_map= const(nop))

Overrides: object.__init__

(inherited documentation)

script_wants_forwarding(self)

source code

Returns wether the script wants to receive receive the values, otherwise, the control will be mapped to the track.

Subclasses that overload this should _request_rebuild() whenever the property changes.

end_gesture(self)

source code

Ends a modification of the input control element. See begin_gesture.

clear_send_cache(self)

source code

Overrides: ControlElement.ControlElement.clear_send_cache

reset(self)

source code

Send 0 to reset motorized faders and turn off LEDs

Overrides: ControlElement.ControlElement.reset

_last_sent_value(self)

source code

Decorators:

@property

Class Variable Details

[hide private]

__subject_events__

Value:

SubjectEvent(name= 'value', signal= InputSignal, override= True),

mapping_sensitivity

Value:

property(_get_mapping_sensitivity, _set_mapping_sensitivity)

Class InputControlElement

__init__(self, msg_type=None, channel=None, identifier=None, sysex_identifier=None, request_rebuild_midi_map=None, *a, **k) (Constructor)

script_wants_forwarding(self)

end_gesture(self)

clear_send_cache(self)

reset(self)

_last_sent_value(self)

__subject_events__

mapping_sensitivity

init(self, msg_type=None, channel=None, identifier=None, sysex_identifier=None, request_rebuild_midi_map=None, *a, **k)
(Constructor)