ableton.v3.control_surface.display.display_specification (runtime)¶
Live 11 — Live Object Model & framework reference (descriptions and signatures).
Module constants¶
DISCONNECT_EVENT = Event(name='disconnect', origin=None, value=None)INIT_EVENT = Event(name='init', origin=None, value=None)
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.
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.
capturing_stdout(temp_output_stream)¶
const(value)¶
contextmanager(func)¶
depends(**dependencies)¶
inject(**k)¶
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 0x1639aaea0>) -> None¶
_TransformDefaultText(transform_fn: 'Callable[[str], str]' =
Transport()¶
UndoRedo()¶
__init__(self, /, *args, **kwargs)¶
Initialize self. See help(type(self)) for accurate signature.
Attributes¶
controlled_range=Nonefull_velocity=Nonegeneric=Noneidentify=Nonenote_repeat=None
class Disconnectable¶
Methods¶
__init__(self, /, *args, **kwargs)¶
Initialize self. See help(type(self)) for accurate signature.
disconnect(self)¶
class Display(Disconnectable)¶
Properties¶
rendered_contentstate
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: Union[Callable[[], ableton.v3.control_surface.display.view.view.View], NoneType] = None, protocol=None, notifications: Union[Type[ableton.v3.control_surface.display.notifications.all.Notifications], NoneType] = None)¶
Initialize self. See help(type(self)) for accurate signature.
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]' =
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) -> boolrenderable_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) -> boolrepr_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 StringIO(_TextIOBase)¶
Text I/O implementation using an in-memory buffer.
The initial_value argument sets the value of object. The newline argument is like the one of TextIOWrapper's constructor.
Methods¶
__init__(self, /, *args, **kwargs)¶
Initialize self. See help(type(self)) for accurate signature.
_checkClosed(...)¶
_checkReadable(...)¶
_checkSeekable(...)¶
_checkWritable(...)¶
close(self, /)¶
Close the IO object.
Attempting any further operation after the object is closed will raise a ValueError.
This method has no effect if the file is already closed.
detach(...)¶
Separate the underlying buffer from the TextIOBase and return it.
After the underlying buffer has been detached, the TextIO is in an unusable state.
fileno(self, /)¶
Returns underlying file descriptor if one exists.
OSError is raised if the IO object does not use a file descriptor.
flush(self, /)¶
Flush write buffers, if applicable.
This is not implemented for read-only and non-blocking streams.
getvalue(self, /)¶
Retrieve the entire contents of the object.
isatty(self, /)¶
Return whether this is an 'interactive' stream.
Return False if it can't be determined.
read(self, size=-1, /)¶
Read at most size characters, returned as a string.
If the argument is negative or omitted, read until EOF is reached. Return an empty string at EOF.
readable(self, /)¶
Returns True if the IO object can be read.
readline(self, size=-1, /)¶
Read until newline or EOF.
Returns an empty string if EOF is hit immediately.
readlines(self, hint=-1, /)¶
Return a list of lines from the stream.
hint can be specified to control the number of lines read: no more lines will be read if the total size (in bytes/characters) of all lines so far exceeds hint.
seek(self, pos, whence=0, /)¶
Change stream position.
Seek to character offset pos relative to position indicated by whence: 0 Start of stream (the default). pos should be >= 0; 1 Current position - pos must be 0; 2 End of stream - pos must be 0. Returns the new absolute position.
seekable(self, /)¶
Returns True if the IO object can be seeked.
tell(self, /)¶
Tell the current file position.
truncate(self, pos=None, /)¶
Truncate size to pos.
The pos argument defaults to the current file position, as returned by tell(). The current file position is unchanged. Returns the new absolute position.
writable(self, /)¶
Returns True if the IO object can be written.
write(self, s, /)¶
Write string to file.
Returns the number of characters written, which is always equal to the length of the string.
writelines(self, lines, /)¶
Attributes¶
closed=<attribute 'closed' of '_io.StringIO' objects>encoding=<attribute 'encoding' of '_io._TextIOBase' objects>- Encoding of the text stream.errors=<attribute 'errors' of '_io._TextIOBase' objects>- The error setting of the decoder or encoder.line_buffering=<attribute 'line_buffering' of '_io.StringIO' objects>newlines=<attribute 'newlines' of '_io.StringIO' objects>- Line endings translated so far.
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.