Skip to content

_Framework.PhysicalDisplayElement (runtime)

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

Functions

adjust_string(original, length)

const(value)

first(seq)

group(lst, n)

in_range(value, lower_bound, upper_open_bound)

maybe(fn)

nop(*a, **k)

old_div(a, b)

second(seq)

slice_size(slice, width)

slicer(dimensions)

to_slice(obj)

Classes

class ClientWrapper(NamedTuple)

Methods

__init__(self, *others, **k)

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

unwrap(*a, **k)

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

wrap(*a, **k)

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

Attributes

  • _eq_dict = <_Framework.Util.lazy_attribute object at 0x129d83b50>

class ControlElement(Disconnectable)

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)
clear_send_cache(self)
disconnect(self)
notify_ownership_change(self, client, grabbed, element_ownership_handler=None)
reset(self)
reset_state(self)
send_midi(self, message)

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 DisplayElement(ControlElement)

Properties

  • display_string
  • num_segments
  • resource
  • segments
  • width

Methods

ProxiedInterface(outer=None, *a, **k)
__init__(self, width_in_chars=None, num_segments=1, *a, **k)

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

_disconnect_segments(self)
_on_resource_lost(self, client)
_on_resource_received(self, client, *a, **k)
_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)
clear_send_cache(self)
disconnect(self)
notify_ownership_change(self, client, grabbed, element_ownership_handler=None)
reset(self)
reset_state(self)
segment(self, index)
send_midi(self, message)
set_data_sources(self, sources)
set_num_segments(self, num_segments)
update(self)

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
  • display_indexes = <_Framework.Util.lazy_attribute object at 0x12d510ed0>
  • display_slice = <_Framework.Util.lazy_attribute object at 0x11ac07890>
  • name = '' - str(object='') -> str
  • optimized_send_midi = True - bool(x) -> bool
  • proxied_interface = <_Framework.Util.lazy_attribute object at 0x129db4290>

class DisplayError(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>

class DisplaySegmentationError(DisplayError)

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>

class LogicalDisplaySegment

Methods

__init__(self, width=None, update_callback=None, *a, **k)

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

_get_display_string(self)
data_source(self)
disconnect(self)
display_string(self)
position_identifier(self)
set_data_source(self, data_source)
set_position_identifier(self, position_identifier)
update(self)

Attributes

  • separator = '' - str(object='') -> str

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 PhysicalDisplayElement(DisplayElement, NotifyingControlElement)

Properties

  • display_string
  • message_header
  • message_tail
  • num_segments
  • resource
  • segments
  • subdisplay
  • width

Methods

ProxiedInterface(outer=None, *a, **k)
__init__(self, *a, **k)

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

_build_display_message(self, display)
_build_inner_message(self, displays)
_build_message(self, displays)
_disconnect_segments(self)
_on_central_resource_lost(self, display_client)
_on_central_resource_received(self, display_client)
_on_resource_lost(self, client)
_on_resource_received(self, client, *a, **k)
_request_send_message(self)
_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)
_send_message(self)
_translate_char(self, char_to_translate)
_translate_string(self, string)
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)
display_message(self, message)
nested_display_resource_factory(self, display)
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)
segment(self, index)
send_midi(self, midi_bytes)
set_block_messages(self, block)
set_clear_all_message(self, message)
set_data_sources(self, sources)
set_message_parts(self, header, tail)
set_num_segments(self, num_segments)
set_translation_table(self, translation_table)
update(self)
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

  • _ascii_translations = {'0': 48, '1': 49, '2': 50, '3': 51, '4': 52, '5': 53, '6': 54, '7': 55, '8': 56, '9': 57, 'A': 65, 'B': 66, 'C': 67, 'D': 68, 'E': 69, 'F': 70, 'G': 71, 'H': 7... - dict() -> new empty dictionary
  • _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
  • display_indexes = <_Framework.Util.lazy_attribute object at 0x12d510ed0>
  • display_slice = <_Framework.Util.lazy_attribute object at 0x11ac07890>
  • name = '' - str(object='') -> str
  • optimized_send_midi = True - bool(x) -> bool
  • proxied_interface = <_Framework.Util.lazy_attribute object at 0x129db4290>

class ProxyResource(Proxy)

Properties

  • owner
  • owners
  • proxied_interface

Methods

__init__(self, proxied_resource=None, client_wrapper=<_Framework.Resource.ClientWrapper object at 0x129d9bfd0>, *a, **k)

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

grab(self, client, *a, **k)
proxy_old_hasattr(self, attr)
release(self, client, *a, **k)

Attributes

  • _proxied_interface = None
  • _skip_wrapper_lookup = None
  • proxied_object = None

class StackingResource(Resource)

Properties

  • clients
  • max_priority
  • owner
  • owners
  • stack_size

Methods

__init__(self, on_received_callback=None, on_lost_callback=None, *a, **k)

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

_actual_owners(self)
_add_client(self, client, priority)
_on_lost_set(self, clients)
_on_received_set(self, clients)
_remove_client(self, client)
get_owner(self)
grab(self, client, priority=None)
on_lost(self, client)
on_received(self, client)
release(self, client)
release_all(self)
release_stacked(self)

class SubDisplayElement(DisplayElement)

Properties

  • display_string
  • num_segments
  • resource
  • segments
  • width

Methods

ProxiedInterface(outer=None, *a, **k)
__init__(self, sub_display_slice=slice(None, 1, None), parent_display=None, *a, **k)

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

_disconnect_segments(self)
_is_visible(self)
_on_resource_lost(self, client)
_on_resource_received(self, client, *a, **k)
_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)
clear_send_cache(self)
disconnect(self)
notify_ownership_change(self, client, grabbed, element_ownership_handler=None)
reset(self)
reset_state(self)
segment(self, index)
send_midi(self, message)
set_data_sources(self, sources)
set_num_segments(self, num_segments)
update(self)

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
  • display_indexes = <_Framework.Util.lazy_attribute object at 0x12d511310>
  • display_slice = <_Framework.Util.lazy_attribute object at 0x12d511190>
  • name = '' - str(object='') -> str
  • optimized_send_midi = True - bool(x) -> bool
  • proxied_interface = <_Framework.Util.lazy_attribute object at 0x129db4290>

class chain

chain(*iterables) --> chain object

Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

Methods

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

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

from_iterable(iterable, /)

Alternative chain() constructor taking a single iterable argument that evaluates lazily.

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 starmap

Return an iterator whose values are returned from the function evaluated with an argument tuple taken from the given sequence.

Methods

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

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