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

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

Module constants¶

NOTIFICATION_EVENT_ID = 'notification'
NotificationParams = ~NotificationParams
TYPE_CHECKING = False
annotations = _Feature((3, 7, 0, 'beta', 1), (4, 0, 0, 'alpha', 0), 1048576)

Functions¶

`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.

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

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

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

A special construct usable to annotate class objects.

For example, suppose we have the following classes::

class User: ... # Abstract base for User classes class BasicUser(User): ... class ProUser(User): ... class TeamUser(User): ...

And a function that takes a class argument that's a subclass of User and returns an instance of the corresponding class::

U = TypeVar('U', bound=User) def new_user(user_class: Type[U]) -> U: user = user_class() # (Here we could write the user object to a database) return user

joe = new_user(BasicUser)

At this point the type checker knows that joe has type BasicUser.

`collect_properties(cls)`¶

`const(value)`¶

`depends(**dependencies)`¶

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

Classes¶

class `CompoundDisconnectable(Disconnectable)`¶

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_disconnectables(self, disconnectables)`¶

`unregister_disconnectable(self, slot)`¶

class `Event(tuple)`¶

Event(name, origin, value)

Properties¶

name - Alias for field number 0
origin - Alias for field number 1
value - Alias for field number 2

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
_field_types = OrderedDict([('name', <class 'str'>), ('origin', typing.Any), ('value', typing.Any)]) - Dictionary that remembers insertion order
_fields = ('name', 'origin', 'value') - Built-in immutable sequence.
_fields_defaults = {} - dict() -> new empty dictionary

class `EventObject(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_disconnectables(self, disconnectables)`¶

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

`unregister_disconnectable(self, slot)`¶

class `EventObjectMeta(type)`¶

type(object_or_name, bases, dict) type(object) -> the object's type type(name, bases, dict) -> a new type

Methods¶

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

Call self as a function.

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

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

`collect_listenable_properties(dct)`¶

`mro(self, /)`¶

Return a type's method resolution order.

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 0x1639aaea0>) -> None`¶

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

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

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶

Attributes¶

include_in_top_level_state = True - bool(x) -> bool
renderable_state = <ableton.v2.base.util.lazy_attribute object at 0x1639d72e8>

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 0x1639d2d08>, value_filter=<function State.<lambda> at 0x1639d5378>))`¶

`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: Union[float, NoneType])`¶

`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 0x1639d2d08>, value_filter=<function StateFilters.<lambda> at 0x1639d2d90>) - StateFilters(key_filter: Callable = at 0x1639d2d08>, value_filter: Callable = at 0x1639d2d90>)

class `lazy_attribute`¶

Methods¶

`init(self, func, name=None)`¶

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

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

Module constants¶

Functions¶

Callable(*args, **kwargs)¶

Notification(*args, **kwargs)¶

Optional(*args, **kwds)¶

Type(*args, **kwargs)¶

collect_properties(cls)¶

const(value)¶

depends(**dependencies)¶

nop(*a, **k)¶

Classes¶

class CompoundDisconnectable(Disconnectable)¶

Methods¶

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

disconnect(self)¶

disconnect_disconnectable(self, slot)¶

find_disconnectable(self, predicate)¶

has_disconnectable(self, slot)¶

register_disconnectable(self, slot)¶

register_disconnectables(self, disconnectables)¶

unregister_disconnectable(self, slot)¶

class Event(tuple)¶

Properties¶

Methods¶

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

_asdict(self)¶

_make(iterable)¶

_replace(_self, **kwds)¶

count(self, value, /)¶

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

Attributes¶

class EventObject(CompoundDisconnectable)¶

Methods¶

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

disconnect(self)¶

disconnect_disconnectable(self, slot)¶

find_disconnectable(self, predicate)¶

has_disconnectable(self, slot)¶

register_disconnectable(self, slot)¶

register_disconnectables(self, disconnectables)¶

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

unregister_disconnectable(self, slot)¶

class EventObjectMeta(type)¶

Methods¶

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

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

collect_listenable_properties(dct)¶

mro(self, /)¶

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 0x1639aaea0>) -> 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.renderable` (runtime)¶

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

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

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

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

`collect_properties(cls)`¶

`const(value)`¶

`depends(**dependencies)`¶

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

class `CompoundDisconnectable(Disconnectable)`¶

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

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

`unregister_disconnectable(self, slot)`¶

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

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

`disconnect(self)`¶

`disconnect_disconnectable(self, slot)`¶

`find_disconnectable(self, predicate)`¶

`has_disconnectable(self, slot)`¶

`register_disconnectable(self, slot)`¶

`register_disconnectables(self, disconnectables)`¶

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

`unregister_disconnectable(self, slot)`¶

class `EventObjectMeta(type)`¶

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

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

`collect_listenable_properties(dct)`¶

`mro(self, /)`¶

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

`suppress_notifications(self)`¶

`unregister_disconnectable(self, slot)`¶