`_Framework.ButtonElement` (runtime)¶

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

Module constants¶

MIDI_CC_TYPE = 1
OFF_VALUE = <_Framework.ButtonElement.ButtonValue object at 0x11afb3450>
ON_VALUE = <_Framework.ButtonElement.ButtonValue object at 0x129d5e7d0>

Functions¶

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

Classes¶

class `ButtonElement(InputControlElement, ButtonElementMixin)`¶

Properties¶

_last_sent_value
mapping_sensitivity
resource
suppress_script_forwarding

Methods¶

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

`init(self, is_momentary, msg_type, channel, identifier, skin=<_Framework.Skin.Skin object at 0x129de10d0>, undo_step_handler=<_Framework.ButtonElement.DummyUndoStepHandler object at 0x11afb2710>, *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_skin_light(self, value)`¶

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

`is_momentary(self)`¶

`is_pressed(self)`¶

`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_light(self, value)`¶

`set_needs_takeover(self, needs_takeover)`¶

`set_report_values(self, report_input, report_output)`¶

`turn_off(self)`¶

`turn_on(self)`¶

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

Methods¶

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

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

`set_light(self, is_turned_on)`¶

`turn_off(self)`¶

`turn_on(self)`¶

class `ButtonValue`¶

Methods¶

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

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

Attributes¶

midi_value = 0 - int([x]) -> integer

class `Color(ButtonValue)`¶

Methods¶

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

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

`draw(self, interface)`¶

Attributes¶

midi_value = 0 - int([x]) -> integer

class `DummyUndoStepHandler`¶

Methods¶

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

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

`begin_undo_step(self)`¶

`end_undo_step(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 `Skin`¶

Methods¶

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

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

`_fill_colors(self, colors, pathname='')`¶

`items(self)`¶

class `SkinColorMissingError(Exception)`¶

Common base class for all non-exit exceptions.

Methods¶

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

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

`add_note(...)`¶

Exception.add_note(note) -- add a note to the exception

`with_traceback(...)`¶

Exception.with_traceback(tb) -- set self.traceback to tb and return self.

Attributes¶

args = <attribute 'args' of 'BaseException' objects>

_Framework.ButtonElement (runtime)¶

Module constants¶

Functions¶

nop(*a, **k)¶

Classes¶

class ButtonElement(InputControlElement, ButtonElementMixin)¶

Properties¶

Methods¶

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

__init__(self, is_momentary, msg_type, channel, identifier, skin=<_Framework.Skin.Skin object at 0x129de10d0>, undo_step_handler=<_Framework.ButtonElement.DummyUndoStepHandler object at 0x11afb2710>, *a, **k)¶

_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_skin_light(self, value)¶

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

is_momentary(self)¶

is_pressed(self)¶

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_light(self, value)¶

set_needs_takeover(self, needs_takeover)¶

set_report_values(self, report_input, report_output)¶

turn_off(self)¶

turn_on(self)¶

use_default_message(self)¶

value_has_listener(self, slot)¶

value_listener_count(self)¶

Attributes¶

class ButtonElementMixin¶

Methods¶

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

set_light(self, is_turned_on)¶

turn_off(self)¶

turn_on(self)¶

class ButtonValue¶

Methods¶

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

Attributes¶

class Color(ButtonValue)¶

Methods¶

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

`_Framework.ButtonElement` (runtime)¶

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

class `ButtonElement(InputControlElement, ButtonElementMixin)`¶

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

`init(self, is_momentary, msg_type, channel, identifier, skin=<_Framework.Skin.Skin object at 0x129de10d0>, undo_step_handler=<_Framework.ButtonElement.DummyUndoStepHandler object at 0x11afb2710>, *a, **k)`¶

`_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_skin_light(self, value)`¶

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

`is_momentary(self)`¶

`is_pressed(self)`¶

`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_light(self, value)`¶

`set_needs_takeover(self, needs_takeover)`¶

`set_report_values(self, report_input, report_output)`¶

`turn_off(self)`¶

`turn_on(self)`¶

`use_default_message(self)`¶

`value_has_listener(self, slot)`¶

`value_listener_count(self)`¶

class `ButtonElementMixin`¶

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

`set_light(self, is_turned_on)`¶

`turn_off(self)`¶

`turn_on(self)`¶

class `ButtonValue`¶

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

class `Color(ButtonValue)`¶

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

`draw(self, interface)`¶

class `DummyUndoStepHandler`¶

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

`begin_undo_step(self)`¶

`end_undo_step(self)`¶

class `InputControlElement(NotifyingControlElement)`¶

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

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

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

`_get_mapping_sensitivity(self)`¶