Skip to content

_Framework.Control (runtime)

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

Module constants

  • MOMENTARY_DELAY = 0.3

Functions

clamp(val, minv, maxv)

control_event(event_name)

control_list(control_type, *a, **k)

control_matrix(control_type, *a, **k)

first(seq)

flatten(list)

is_matrix(iterable)

mixin(*args)

nop(*a, **k)

old_div(a, b)

old_hasattr(obj, attr)

product(iter_a, iter_b)

second(seq)

Classes

class ButtonControl(Control)

Properties

  • pressed
  • pressed_delayed
  • released
  • released_delayed
  • released_immediately
  • value

Methods

State(control=None, manager=None, color=None, pressed_color=None, disabled_color=None, repeat=False, enabled=True, *a, **k)
__init__(self, *a, **k)

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

_clear_state(self, manager)
_get_state(self, manager)

Attributes

  • DELAY_TIME = 0.3 - Convert a string or number to a floating point number, if possible.
  • REPEAT_RATE = 0.1 - Convert a string or number to a floating point number, if possible.
  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class Control

Properties

  • value

Methods

State(control=None, manager=None, channel=None, identifier=None, *a, **k)
__init__(self, extra_args=None, extra_kws=None, *a, **k)

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

_clear_state(self, manager)
_get_state(self, manager)

Attributes

  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class ControlList(Control)

Properties

  • value

Methods

State(control=None, manager=None, extra_args=None, extra_kws=None, unavailable_color=None, *a, **k)
__init__(self, control_type=None, control_count=None, *a, **k)

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

_clear_state(self, manager)
_get_state(self, manager)

Attributes

  • DYNAMIC_CONTROL_COUNT = None
  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class ControlManager(SlotManager)

Methods

__init__(self, *a, **k)

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

control_notifications_enabled(self)
disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
register_disconnectable(self, slot)
register_slot(self, *a, **k)
register_slot_manager(self, *a, **k)
unregister_disconnectable(self, slot)
update(self)

Attributes

  • _tasks = <_Framework.Util.lazy_attribute object at 0x12d551150>

class EncoderControl(Control)

Properties

  • released
  • touched
  • value

Methods

State(control=None, manager=None, *a, **k)
__init__(self, extra_args=None, extra_kws=None, *a, **k)

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

_clear_state(self, manager)
_get_state(self, manager)

Attributes

  • TOUCH_TIME = 0.5 - Convert a string or number to a floating point number, if possible.
  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class MappedControl(Control)

Properties

  • value

Methods

State(control=None, manager=None, *a, **k)
__init__(self, *a, **k)

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

_clear_state(self, manager)
_get_state(self, manager)

Attributes

  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class MatrixControl(ControlList)

Properties

  • value

Methods

State(control=None, manager=None, *a, **k)
__init__(self, *a, **k)

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

_clear_state(self, manager)
_get_state(self, manager)

Attributes

  • DYNAMIC_CONTROL_COUNT = None
  • DYNAMIC_DIMENSIONS = (None, None) - Built-in immutable sequence.
  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class PlayableControl(ButtonControl)

Properties

  • pressed
  • pressed_delayed
  • released
  • released_delayed
  • released_immediately
  • value

Methods

State(*a, **k)
__init__(self, *a, **k)

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

_clear_state(self, manager)
_get_state(self, manager)

Attributes

  • DELAY_TIME = 0.3 - Convert a string or number to a floating point number, if possible.
  • REPEAT_RATE = 0.1 - Convert a string or number to a floating point number, if possible.
  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class RadioButtonControl(Control)

Properties

  • checked
  • value

Methods

State(control, manager=None, unchecked_color=None, checked_color=None, *a, **k)
__init__(self, *a, **k)

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

_clear_state(self, manager)
_get_state(self, manager)

Attributes

  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class RadioButtonGroup(ControlList, RadioButtonControl)

Properties

  • checked
  • value

Methods

State(*a, **k)
__init__(self, *a, **k)

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

_clear_state(self, manager)
_get_state(self, manager)

Attributes

  • DYNAMIC_CONTROL_COUNT = None
  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class SlotManager(CompoundDisconnectable)

Methods

__init__(self, *a, **k)

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

disconnect(self)
disconnect_disconnectable(self, slot)
find_disconnectable(self, predicate)
has_disconnectable(self, slot)
register_disconnectable(self, slot)
register_slot(self, *a, **k)
register_slot_manager(self, *a, **k)
unregister_disconnectable(self, slot)

class ToggleButtonControl(Control)

Properties

  • toggled
  • value

Methods

State(control=None, manager=None, untoggled_color=None, toggled_color=None, *a, **k)
__init__(self, *a, **k)

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

_clear_state(self, manager)
_get_state(self, manager)

Attributes

  • _extra_args = [] - Built-in mutable sequence.
  • _extra_kws = {} - dict() -> new empty dictionary

class lazy_attribute

Methods

__init__(self, func, name=None)

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

class partial

partial(func, args, *keywords) - new function with partial application of the given arguments and keywords.

Methods

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

Call self as a function.

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

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

Attributes

  • args = <member 'args' of 'functools.partial' objects> - tuple of arguments to future partial calls
  • func = <member 'func' of 'functools.partial' objects> - function object to use in future partial calls
  • keywords = <member 'keywords' of 'functools.partial' objects> - dictionary of keyword arguments to future partial calls

class zip_longest

zip_longest(iter1 [,iter2 [...]], [fillvalue=None]) --> zip_longest object

Return a zip_longest object whose .next() method returns a tuple where the i-th element comes from the i-th iterable argument. The .next() method continues until the longest iterable in the argument sequence is exhausted and then it raises StopIteration. When the shorter iterables are exhausted, the fillvalue is substituted in their place. The fillvalue defaults to None or can be specified by a keyword argument.

Methods

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

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