Skip to content

ableton.v3.control_surface.display.view.notification (runtime)

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

Module constants

  • ContentType = ~ContentType
  • DEFAULT_NOTIFICATION_DURATION = 2.0
  • INIT_EVENT = Event(name='init', origin=None, value=None)
  • NotificationDataType = ~NotificationDataType
  • inf = inf

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.

EventSignalFn(*args, **kwargs)

Optional(*args, **kwds)

RenderNotification(*args, **kwargs)

Tuple(*args, **kwargs)

Tuple type; Tuple[X, Y] is the cross-product type of X and Y.

Example: Tuple[T1, T2] is a tuple of two elements corresponding to type variables T1 and T2. Tuple[int, float, str] is a tuple of an int, a float and a string.

To specify a variable-length tuple of homogeneous type, use Tuple[T, ...].

on_notification() -> Callable[[ableton.v3.control_surface.display.state.State, ableton.v3.control_surface.display.type_decl.Event], Any]

suppress_notifications(state: ableton.v3.control_surface.display.state.State, exclude: Union[List[str], NoneType] = None)

uuid1(node=None, clock_seq=None)

Classes

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 Generic

Methods

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

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

class NotificationView(View, Generic)

Methods

__call__(self, state: ableton.v3.control_surface.display.state.State) -> ~ContentType

Call self as a function.

__init__(self, render_fn: Callable[[ableton.v3.control_surface.display.state.State, Any], ~ContentType], render_condition: Callable[[ableton.v3.control_surface.display.state.State], bool] = <function NotificationView.<lambda> at 0x1639d9840>, content_condition: Callable[[~ContentType], bool] = <function NotificationView.<lambda> at 0x1639d97b8>, notification_signal: Callable[[ableton.v3.control_surface.display.state.State, ableton.v3.control_surface.display.type_decl.Event], ~NotificationDataType] = <function on_notification.<locals>.signal_fn at 0x1639e7268>, name: str = 'notification', duration: Union[float, NoneType] = None, exclusive: bool = True, suppressing_signals: Tuple[Callable[[ableton.v3.control_surface.display.state.State, ableton.v3.control_surface.display.type_decl.Event], ~NotificationDataType], ...] = (), supports_new_line: bool = False)

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

content_condition(self, content) -> bool
init(self, state: ableton.v3.control_surface.display.state.State)
react(self, state: ableton.v3.control_surface.display.state.State, event: ableton.v3.control_surface.display.type_decl.Event)
render(self, state: ableton.v3.control_surface.display.state.State)
render_condition(self, state: ableton.v3.control_surface.display.state.State) -> bool
reset_state(self, state: ableton.v3.control_surface.display.state.State, delay: Union[float, NoneType] = None)

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 View(Generic)

Methods

__call__(self, state: ableton.v3.control_surface.display.state.State) -> ~ContentType

Call self as a function.

__init__(self, render: Callable[[ableton.v3.control_surface.display.state.State], ~ContentType], render_condition: Callable[[ableton.v3.control_surface.display.state.State], bool] = <function View.<lambda> at 0x1639d98c8>, content_condition: Callable[[~ContentType], bool] = <function View.<lambda> at 0x1639d9950>)

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

content_condition(self, content) -> bool
render(self, state: ableton.v3.control_surface.display.state.State) -> ~ContentType
render_condition(self, state: ableton.v3.control_surface.display.state.State) -> bool