`ableton.v3.control_surface.elements.display_line` (runtime)¶

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

Module constants¶

DisplayDataType = ~DisplayDataType

Functions¶

`Any(*args, **kwds)`¶

`Callable(*args, **kwargs)`¶

Callable type; Callable[[int], str] is a function of (int) -> str.

The subscription syntax must always be used with exactly two values: the argument list and the return type. The argument list must be a list of types or ellipsis; the return type must be a single type.

There is no syntax to indicate optional or keyword arguments, such function types are rarely used as callback types.

`Union(*args, **kwds)`¶

`updating_display(update_value=None)`¶

Classes¶

class `DisplayLineElement(NotifyingControlElement, Generic)`¶

Properties¶

grabbed
resource

Methods¶

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

`init(self, display_fn: Callable[[~DisplayDataType], Any], formatting_fn: Callable[[ableton.v3.control_surface.display.text.Text], ~DisplayDataType] = <function DisplayLineElement.<lambda> at 0x1639f2f28>, default_formatting='', *a, **k)`¶

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

`_apply_default_formatting(self, text: ableton.v3.control_surface.display.text.Text)`¶

`_do_display(self, message: Union[ableton.v3.control_surface.display.text.Text, str])`¶

`_on_resource_lost(self, client)`¶

`_on_resource_received(self, client, *a, **k)`¶

`_redisplay_last_native_content(self)`¶

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

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`display_message(self, text)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`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

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`register_slot(self, *a, **k)`¶

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

`unregister_disconnectable(self, slot)`¶

`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 = <ableton.v2.base.util.lazy_attribute object at 0x11b312780>
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x1630c8898>
canonical_parent = None
name = '' - str(object='') -> str
optimized_send_midi = True - bool(x) -> bool
proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>

class `Generic`¶

Methods¶

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

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

class `NotifyingControlElement(EventObject, ControlElement)`¶

Properties¶

resource

Methods¶

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

`init(self, *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)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`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

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`register_slot(self, *a, **k)`¶

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

`unregister_disconnectable(self, slot)`¶

`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 = <ableton.v2.base.util.lazy_attribute object at 0x11b312780>
_tasks = <ableton.v2.base.util.lazy_attribute object at 0x1630c8898>
canonical_parent = None
name = '' - str(object='') -> str
optimized_send_midi = True - bool(x) -> bool
proxied_interface = <ableton.v2.base.util.lazy_attribute object at 0x11df40710>

class `Text(UserString)`¶

Methods¶

`ContentWidth()`¶

`Justification(value, names=None, *, module=None, qualname=None, type=None, start=1)`¶

An enumeration.

`init(self, string: str = '', justification: Union[ableton.v3.control_surface.display.text.Text.Justification, NoneType] = None, max_width: Union[int, ableton.v3.control_surface.display.text.Text.ContentWidth, NoneType] = None)`¶

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

`as_ascii(self, adjust_string_fn: Callable[[str, int], str] = <function adjust_string at 0x16315bf28>) -> Tuple[int, ...]`¶

`as_string(self, adjust_string_fn: Callable[[str, int], str] = <function adjust_string at 0x16315bf28>) -> str`¶

`capitalize(self)`¶

`casefold(self)`¶

`center(self, width, *args)`¶

`count(self, sub, start=0, end=9223372036854775807)`¶

`encode(self, encoding=None, errors=None)`¶

`endswith(self, suffix, start=0, end=9223372036854775807)`¶

`expandtabs(self, tabsize=8)`¶

`find(self, sub, start=0, end=9223372036854775807)`¶

`format(self, *args, **kwds)`¶

`format_map(self, mapping)`¶

`index(self, sub, start=0, end=9223372036854775807)`¶

`isalnum(self)`¶

`isalpha(self)`¶

`isascii(self)`¶

`isdecimal(self)`¶

`isdigit(self)`¶

`isidentifier(self)`¶

`islower(self)`¶

`isnumeric(self)`¶

`isprintable(self)`¶

`isspace(self)`¶

`istitle(self)`¶

`isupper(self)`¶

`join(self, seq)`¶

`ljust(self, width, *args)`¶

`lower(self)`¶

`lstrip(self, chars=None)`¶

`maketrans(x, y=None, z=None, /)`¶

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

`partition(self, sep)`¶

`replace(self, old, new, maxsplit=-1)`¶

`rfind(self, sub, start=0, end=9223372036854775807)`¶

`rindex(self, sub, start=0, end=9223372036854775807)`¶

`rjust(self, width, *args)`¶

`rpartition(self, sep)`¶

`rsplit(self, sep=None, maxsplit=-1)`¶

`rstrip(self, chars=None)`¶

`split(self, sep=None, maxsplit=-1)`¶

`splitlines(self, keepends=False)`¶

`startswith(self, prefix, start=0, end=9223372036854775807)`¶

`strip(self, chars=None)`¶

`swapcase(self)`¶

`title(self)`¶

`translate(self, *args)`¶

`upper(self)`¶

`zfill(self, width)`¶

Attributes¶

_abc_impl = <_abc_data object at 0x1639e23f0>

class `TypeVar(_Final, _Immutable)`¶

Methods¶

`init(self, name, *constraints, bound=None, covariant=False, contravariant=False)`¶

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

ableton.v3.control_surface.elements.display_line (runtime)¶

Module constants¶

Functions¶

Any(*args, **kwds)¶

Callable(*args, **kwargs)¶

Union(*args, **kwds)¶

updating_display(update_value=None)¶

Classes¶

class DisplayLineElement(NotifyingControlElement, Generic)¶

Properties¶

Methods¶

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

__init__(self, display_fn: Callable[[~DisplayDataType], Any], formatting_fn: Callable[[ableton.v3.control_surface.display.text.Text], ~DisplayDataType] = <function DisplayLineElement.<lambda> at 0x1639f2f28>, default_formatting='', *a, **k)¶

_apply_default_formatting(self, text: ableton.v3.control_surface.display.text.Text)¶

_do_display(self, message: Union[ableton.v3.control_surface.display.text.Text, str])¶

_on_resource_lost(self, client)¶

_on_resource_received(self, client, *a, **k)¶

_redisplay_last_native_content(self)¶

_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)¶

add_value_listener(self, slot, identify_sender=False, *a, **k)¶

clear_send_cache(self)¶

disconnect(self)¶

disconnect_disconnectable(self, slot)¶

display_message(self, text)¶

find_disconnectable(self, predicate)¶

has_disconnectable(self, slot)¶

notify_ownership_change(self, client, grabbed, element_ownership_handler=None)¶

notify_value(self, *a, **k)¶

register_disconnectable(self, slot)¶

register_disconnectables(self, disconnectables)¶

register_slot(self, *a, **k)¶

remove_value_listener(self, slot)¶

reset(self)¶

reset_state(self)¶

send_midi(self, message)¶

unregister_disconnectable(self, slot)¶

value_has_listener(self, slot)¶

value_listener_count(self)¶

Attributes¶

class Generic¶

Methods¶

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

class NotifyingControlElement(EventObject, ControlElement)¶

Properties¶

Methods¶

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

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

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

clear_send_cache(self)¶

disconnect(self)¶

disconnect_disconnectable(self, slot)¶

find_disconnectable(self, predicate)¶

has_disconnectable(self, slot)¶

notify_ownership_change(self, client, grabbed, element_ownership_handler=None)¶

notify_value(self, *a, **k)¶

register_disconnectable(self, slot)¶

register_disconnectables(self, disconnectables)¶

register_slot(self, *a, **k)¶

remove_value_listener(self, slot)¶

reset(self)¶

reset_state(self)¶

send_midi(self, message)¶

unregister_disconnectable(self, slot)¶

value_has_listener(self, slot)¶

value_listener_count(self)¶

Attributes¶

class Text(UserString)¶

Methods¶

ContentWidth()¶

Justification(value, names=None, *, module=None, qualname=None, type=None, start=1)¶

__init__(self, string: str = '', justification: Union[ableton.v3.control_surface.display.text.Text.Justification, NoneType] = None, max_width: Union[int, ableton.v3.control_surface.display.text.Text.ContentWidth, NoneType] = None)¶

as_ascii(self, adjust_string_fn: Callable[[str, int], str] = <function adjust_string at 0x16315bf28>) -> Tuple[int, ...]¶

as_string(self, adjust_string_fn: Callable[[str, int], str] = <function adjust_string at 0x16315bf28>) -> str¶

capitalize(self)¶

casefold(self)¶

center(self, width, *args)¶

count(self, sub, start=0, end=9223372036854775807)¶

`ableton.v3.control_surface.elements.display_line` (runtime)¶

`Any(*args, **kwds)`¶

`Callable(*args, **kwargs)`¶

`Union(*args, **kwds)`¶

`updating_display(update_value=None)`¶

class `DisplayLineElement(NotifyingControlElement, Generic)`¶

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

`init(self, display_fn: Callable[[~DisplayDataType], Any], formatting_fn: Callable[[ableton.v3.control_surface.display.text.Text], ~DisplayDataType] = <function DisplayLineElement.<lambda> at 0x1639f2f28>, default_formatting='', *a, **k)`¶

`_apply_default_formatting(self, text: ableton.v3.control_surface.display.text.Text)`¶

`_do_display(self, message: Union[ableton.v3.control_surface.display.text.Text, str])`¶

`_on_resource_lost(self, client)`¶

`_on_resource_received(self, client, *a, **k)`¶

`_redisplay_last_native_content(self)`¶

`_resource_type(on_received_callback=None, on_lost_callback=None, *a, **k)`¶

`add_value_listener(self, slot, identify_sender=False, *a, **k)`¶

`clear_send_cache(self)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`display_message(self, text)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`notify_ownership_change(self, client, grabbed, element_ownership_handler=None)`¶

`notify_value(self, *a, **k)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`register_slot(self, *a, **k)`¶

`remove_value_listener(self, slot)`¶

`reset(self)`¶

`reset_state(self)`¶

`send_midi(self, message)`¶

`unregister_disconnectable(self, slot)`¶

`value_has_listener(self, slot)`¶

`value_listener_count(self)`¶

class `Generic`¶

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

class `NotifyingControlElement(EventObject, ControlElement)`¶

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

`init(self, *a, **k)`¶

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

`clear_send_cache(self)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`notify_ownership_change(self, client, grabbed, element_ownership_handler=None)`¶

`notify_value(self, *a, **k)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`register_slot(self, *a, **k)`¶

`remove_value_listener(self, slot)`¶

`reset(self)`¶

`reset_state(self)`¶

`send_midi(self, message)`¶

`unregister_disconnectable(self, slot)`¶

`value_has_listener(self, slot)`¶

`value_listener_count(self)`¶

class `Text(UserString)`¶

`ContentWidth()`¶

`Justification(value, names=None, *, module=None, qualname=None, type=None, start=1)`¶

`init(self, string: str = '', justification: Union[ableton.v3.control_surface.display.text.Text.Justification, NoneType] = None, max_width: Union[int, ableton.v3.control_surface.display.text.Text.ContentWidth, NoneType] = None)`¶

`as_ascii(self, adjust_string_fn: Callable[[str, int], str] = <function adjust_string at 0x16315bf28>) -> Tuple[int, ...]`¶

`as_string(self, adjust_string_fn: Callable[[str, int], str] = <function adjust_string at 0x16315bf28>) -> str`¶

`capitalize(self)`¶

`casefold(self)`¶

`center(self, width, *args)`¶

`count(self, sub, start=0, end=9223372036854775807)`¶

`encode(self, encoding=None, errors=None)`¶

`endswith(self, suffix, start=0, end=9223372036854775807)`¶

`expandtabs(self, tabsize=8)`¶

`find(self, sub, start=0, end=9223372036854775807)`¶

`format(self, *args, **kwds)`¶

`format_map(self, mapping)`¶

`index(self, sub, start=0, end=9223372036854775807)`¶

`isalnum(self)`¶

`isalpha(self)`¶

`isascii(self)`¶

`isdecimal(self)`¶