`ableton.v3.control_surface.display` (runtime)¶

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

Functions¶

`auto_break_lines(text: str, max_width: int, max_lines: int, pad_lines: bool = True) -> List[str]`¶

`updating_display(update_value=None)`¶

Classes¶

class `DefaultNotifications(Notifications)`¶

Methods¶

`Automation()`¶

`Clip()`¶

`Clipboard()`¶

`DefaultText()`¶

`Device()`¶

`DrumGroup()`¶

`Element()`¶

`Modes()`¶

`Notes()`¶

`Recording()`¶

`Scene()`¶

`Sequence()`¶

`Simpler()`¶

`Track()`¶

`TransformDefaultText(transform_fn: 'Callable[[str], str]' = <function _TransformDefaultText.<lambda> at 0x13c62c7c0>) -> None`¶

_TransformDefaultText(transform_fn: 'Callable[[str], str]' = at 0x13c62c7c0>)

`Transport()`¶

`UndoRedo()`¶

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

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

Attributes¶

controlled_range = None
full_velocity = None
generic = None
identify = None
note_repeat = None

class `Display(Disconnectable)`¶

Properties¶

rendered_content
state

Methods¶

`init(self, specification: ableton.v3.control_surface.display.display_specification.DisplaySpecification, renderable_components, elements, display_state=None)`¶

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

`clear_content_cache(self)`¶

`deferring_render_and_update_display(self)`¶

`disconnect(self)`¶

`display(self, content)`¶

`react(self, event)`¶

`render(self)`¶

`render_and_update_display(self)`¶

class `DisplaySpecification`¶

Methods¶

`init(self, create_root_view: Optional[Callable[[], ableton.v3.control_surface.display.view.view.View]] = None, protocol=None, notifications: Optional[Type[ableton.v3.control_surface.display.notifications.all.Notifications]] = None)`¶

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

class `Event(tuple)`¶

Event(name, origin, value)

Methods¶

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

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

`_asdict(self)`¶

`_make(iterable)`¶

Make a new Event object from a sequence or iterable

`_replace(self, /, **kwds)`¶

Return a new Event object replacing specified fields with new values

`count(self, value, /)`¶

Return number of occurrences of value.

`index(self, value, start=0, stop=9223372036854775807, /)`¶

Return first index of value.

Raises ValueError if the value is not present.

Attributes¶

_field_defaults = {} - dict() -> new empty dictionary
_fields = ('name', 'origin', 'value') - Built-in immutable sequence.
name = _tuplegetter(0, 'Alias for field number 0') - Alias for field number 0
origin = _tuplegetter(1, 'Alias for field number 1') - Alias for field number 1
value = _tuplegetter(2, 'Alias for field number 2') - Alias for field number 2

class `Notifications`¶

Methods¶

`Automation()`¶

`Clip()`¶

`Clipboard()`¶

`DefaultText()`¶

`Device()`¶

`DrumGroup()`¶

`Element()`¶

`Modes()`¶

`Notes()`¶

`Recording()`¶

`Scene()`¶

`Sequence()`¶

`Simpler()`¶

`Track()`¶

`TransformDefaultText(transform_fn: 'Callable[[str], str]' = <function _TransformDefaultText.<lambda> at 0x13c62c7c0>) -> None`¶

_TransformDefaultText(transform_fn: 'Callable[[str], str]' = at 0x13c62c7c0>)

`Transport()`¶

`UndoRedo()`¶

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

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

`controlled_range(...)`¶

S.format(args, *kwargs) -> str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

`full_velocity(is_on: 'bool')`¶

`generic(...)`¶

S.format(args, *kwargs) -> str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

`identify()`¶

`note_repeat(is_on: 'bool')`¶

class `Renderable(CompoundDisconnectable)`¶

Methods¶

`init(self, react=None, notifications: 'Optional[Type[Notifications]]' = None, suppress_notifications: 'Optional[Callable]' = None, *a, **k)`¶

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

`_create_event_handler(self, property_name)`¶

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`control_base_type(extra_args=None, extra_kws=None, *a, **k)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`dispatch_event(self, name: 'str', value)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`notify(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`renderable_state(self)`¶

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

Attributes¶

include_in_top_level_state = True - bool(x) -> bool

class `State(EventObject)`¶

Methods¶

`init(self)`¶

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

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

`as_dict(instance, state_filters=StateFilters(key_filter=<function StateFilters.<lambda> at 0x13c62c680>, value_filter=<function State.<lambda> at 0x13c671300>))`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`find_disconnectable(self, predicate)`¶

`get_repr_data(self)`¶

`has_disconnectable(self, slot)`¶

`notification_visible_has_listener(self, slot)`¶

`notification_visible_listener_count(self)`¶

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

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`remove_notification_visible_listener(self, slot)`¶

`set_delayed(self, attr_name: str, value, delay_time: Optional[float])`¶

`trigger_timers(self, from_test=False)`¶

`unregister_disconnectable(self, slot)`¶

Attributes¶

notification_visible = False - bool(x) -> bool
repr_filters = StateFilters(key_filter=<function StateFilters.<lambda> at 0x13c62c680>, value_filter=<function StateFilters.<lambda> at 0x13c670cc0>) - StateFilters(key_filter: Callable = at 0x13c62c680>, value_filter: Callable = at 0x13c670cc0>)

class `StateFilters`¶

StateFilters(key_filter: Callable = at 0x13c62c680>, value_filter: Callable = at 0x13c670cc0>)

Methods¶

`init(self, key_filter: Callable = <function StateFilters.<lambda> at 0x13c62c680>, value_filter: Callable = <function StateFilters.<lambda> at 0x13c670cc0>) -> None`¶

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

`key_filter(k)`¶

`value_filter(v)`¶

class `Text(UserString)`¶

All the operations on a read-only sequence.

Concrete subclasses must override new or init, getitem, and len.

Methods¶

`ContentWidth()`¶

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

`init(self, string: str = '', justification: Optional[ableton.v3.control_surface.display.text.Text.Justification] = 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 0x13c16a020>) -> Tuple[int, ...]`¶

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

`capitalize(self)`¶

`casefold(self)`¶

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

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

S.count(value) -> integer -- return number of occurrences of value

`encode(self, encoding='utf-8', errors='strict')`¶

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

S.index(value, [start, [stop]]) -> integer -- return first index of value. Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

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

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

`removeprefix(self, prefix, /)`¶

`removesuffix(self, suffix, /)`¶

`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._abc_data object at 0x11af308c0> - Internal state held by ABC machinery.

ableton.v3.control_surface.display (runtime)¶

Functions¶

auto_break_lines(text: str, max_width: int, max_lines: int, pad_lines: bool = True) -> List[str]¶

updating_display(update_value=None)¶

Classes¶

class DefaultNotifications(Notifications)¶

Methods¶

Automation()¶

Clip()¶

Clipboard()¶

DefaultText()¶

Device()¶

DrumGroup()¶

Element()¶

Modes()¶

Notes()¶

Recording()¶

Scene()¶

Sequence()¶

Simpler()¶

Track()¶

TransformDefaultText(transform_fn: 'Callable[[str], str]' = <function _TransformDefaultText.<lambda> at 0x13c62c7c0>) -> None¶

Transport()¶

UndoRedo()¶

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

Attributes¶

class Display(Disconnectable)¶

Properties¶

Methods¶

__init__(self, specification: ableton.v3.control_surface.display.display_specification.DisplaySpecification, renderable_components, elements, display_state=None)¶

clear_content_cache(self)¶

deferring_render_and_update_display(self)¶

disconnect(self)¶

display(self, content)¶

react(self, event)¶

render(self)¶

render_and_update_display(self)¶

class DisplaySpecification¶

Methods¶

__init__(self, create_root_view: Optional[Callable[[], ableton.v3.control_surface.display.view.view.View]] = None, protocol=None, notifications: Optional[Type[ableton.v3.control_surface.display.notifications.all.Notifications]] = None)¶

class Event(tuple)¶

Methods¶

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

_asdict(self)¶

_make(iterable)¶

_replace(self, /, **kwds)¶

count(self, value, /)¶

index(self, value, start=0, stop=9223372036854775807, /)¶

Attributes¶

class Notifications¶

Methods¶

Automation()¶

Clip()¶

Clipboard()¶

DefaultText()¶

Device()¶

DrumGroup()¶

Element()¶

Modes()¶

Notes()¶

Recording()¶

Scene()¶

Sequence()¶

Simpler()¶

Track()¶

TransformDefaultText(transform_fn: 'Callable[[str], str]' = <function _TransformDefaultText.<lambda> at 0x13c62c7c0>) -> None¶

Transport()¶

UndoRedo()¶

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

controlled_range(...)¶

full_velocity(is_on: 'bool')¶

generic(...)¶

identify()¶

note_repeat(is_on: 'bool')¶

class Renderable(CompoundDisconnectable)¶

Methods¶

__init__(self, react=None, notifications: 'Optional[Type[Notifications]]' = None, suppress_notifications: 'Optional[Callable]' = None, *a, **k)¶

_create_event_handler(self, property_name)¶

_init_state_from_controls(self, renderable_state)¶

_init_state_from_listenable_properties(self, renderable_state)¶

`ableton.v3.control_surface.display` (runtime)¶

`auto_break_lines(text: str, max_width: int, max_lines: int, pad_lines: bool = True) -> List[str]`¶

`updating_display(update_value=None)`¶

class `DefaultNotifications(Notifications)`¶

`Automation()`¶

`Clip()`¶

`Clipboard()`¶

`DefaultText()`¶

`Device()`¶

`DrumGroup()`¶

`Element()`¶

`Modes()`¶

`Notes()`¶

`Recording()`¶

`Scene()`¶

`Sequence()`¶

`Simpler()`¶

`Track()`¶

`TransformDefaultText(transform_fn: 'Callable[[str], str]' = <function _TransformDefaultText.<lambda> at 0x13c62c7c0>) -> None`¶

`Transport()`¶

`UndoRedo()`¶

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

class `Display(Disconnectable)`¶

`init(self, specification: ableton.v3.control_surface.display.display_specification.DisplaySpecification, renderable_components, elements, display_state=None)`¶

`clear_content_cache(self)`¶

`deferring_render_and_update_display(self)`¶

`disconnect(self)`¶

`display(self, content)`¶

`react(self, event)`¶

`render(self)`¶

`render_and_update_display(self)`¶

class `DisplaySpecification`¶

`init(self, create_root_view: Optional[Callable[[], ableton.v3.control_surface.display.view.view.View]] = None, protocol=None, notifications: Optional[Type[ableton.v3.control_surface.display.notifications.all.Notifications]] = None)`¶

class `Event(tuple)`¶

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

`_asdict(self)`¶

`_make(iterable)`¶

`_replace(self, /, **kwds)`¶

`count(self, value, /)`¶

`index(self, value, start=0, stop=9223372036854775807, /)`¶

class `Notifications`¶

`Automation()`¶

`Clip()`¶

`Clipboard()`¶

`DefaultText()`¶

`Device()`¶

`DrumGroup()`¶

`Element()`¶

`Modes()`¶

`Notes()`¶

`Recording()`¶

`Scene()`¶

`Sequence()`¶

`Simpler()`¶

`Track()`¶

`TransformDefaultText(transform_fn: 'Callable[[str], str]' = <function _TransformDefaultText.<lambda> at 0x13c62c7c0>) -> None`¶

`Transport()`¶

`UndoRedo()`¶

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

`controlled_range(...)`¶

`full_velocity(is_on: 'bool')`¶

`generic(...)`¶

`identify()`¶

`note_repeat(is_on: 'bool')`¶

class `Renderable(CompoundDisconnectable)`¶

`init(self, react=None, notifications: 'Optional[Type[Notifications]]' = None, suppress_notifications: 'Optional[Callable]' = None, *a, **k)`¶

`_create_event_handler(self, property_name)`¶

`_init_state_from_controls(self, renderable_state)`¶

`_init_state_from_listenable_properties(self, renderable_state)`¶

`control_base_type(extra_args=None, extra_kws=None, *a, **k)`¶

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`dispatch_event(self, name: 'str', value)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`notify(self, notification: 'Notification[Callable[[Unpack[NotificationParams]], Optional[str]]]', *a: 'Unpack[NotificationParams]')`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`renderable_state(self)`¶

`suppress_notifications(self)`¶