Application

Represents the running Live application — the entry point to the LOM, returned by the module-level get_application() function. The Application class exposes Live’s version, the browser, the control-surface registry, and the Application.View for navigating Live’s windows and panels.

Application

This class represents the Live application. ^{From Live’s runtime docstring.}

Properties

Inherited from LomObject

_live_ptr: int

canonical_parent: NoneProbed asNonehigh confidence

• probe Application is the LOM root. It has no parent — the probe’s None observation reflects the structural shape, not an instance-specific nullability. Every other class’s canonical_parent probes as a concrete parent type; only this and Song.canonical_parent probe as None.

Returns the canonical parent of the application. ^{From Live’s runtime docstring.}

average_process_usage: float

Reports Live’s average CPU load. ^{From Live’s runtime docstring.}

browser: Browser

Returns an interface to the browser. ^{From Live’s runtime docstring.}

control_surfaces: Vector[object]

Const access to a list of the control surfaces selected in preferences, in the same order. The list contains None if no control surface is active at that index. ^{From Live’s runtime docstring.}

current_dialog_button_count: int

Number of buttons on the current dialog. ^{From Live’s runtime docstring.}

current_dialog_message: str

Text of the last dialog that appeared; Empty if all dialogs just disappeared. ^{From Live’s runtime docstring.}

number_of_push_apps_running: int

Returns the number of connected Push apps. ^{From Live’s runtime docstring.}

open_dialog_count: int

The number of open dialogs in Live. 0 if not dialog is open. ^{From Live’s runtime docstring.}

peak_process_usage: float

Reports Live’s peak CPU load. ^{From Live’s runtime docstring.}

unavailable_features: UnavailableFeatureVector

List of features that are unavailable due to limitations of the current Live edition. ^{From Live’s runtime docstring.}

view: View

Returns the applications view component. ^{From Live’s runtime docstring.}

Methods

get_bugfix_version()

Returns

int

Returns an integer representing the bugfix version of Live. ^{From Live’s runtime docstring.}

get_build_id()

Returns

str

Returns a string identifying the build. ^{From Live’s runtime docstring.}

get_document()

Returns

Song

Returns the current Live Set. ^{From Live’s runtime docstring.}

get_major_version()

Returns

int

Returns an integer representing the major version of Live. ^{From Live’s runtime docstring.}

get_minor_version()

Returns

int

Returns an integer representing the minor version of Live. ^{From Live’s runtime docstring.}

get_variant()

Returns

str

Returns one of the strings in Live.Application.Variants. ^{From Live’s runtime docstring.}

get_version_string()

Returns

str

Returns the full version string of Live. ^{From Live’s runtime docstring.}

has_option()

Parameters

• option_name: str

Returns

bool

Returns True if the given entry exists in Options.txt, False otherwise. ^{From Live’s runtime docstring.}

press_current_dialog_button()

Parameters

• index: int

Press a button, by index, on the current message box. ^{From Live’s runtime docstring.}

show_message()

Parameters

• text: Text
• buttons: MessageButtons | int = MessageButtons.OK_BUTTON
• enable_markup: bool = False
• show_success_icon: bool = False

Returns

int

Shows a message box, returning the position of the pressed button. ^{From Live’s runtime docstring.}

show_on_the_fly_message()

Parameters

• message: str
• buttons: MessageButtons | int = MessageButtons.OK_BUTTON
• enable_markup: bool = False
• show_success_icon: bool = False
• push_dialog_type: PushDialogType | int = PushDialogType.MESSAGE_BOX

Returns

int

Same as show_message, but for when there is no predefined Text object. ^{From Live’s runtime docstring.}

Nested types

• Application.View — This class represents the view aspects of the Live application.

Other classes

ControlDescription

Describes a control present in a control surface proxy ^{From Live’s runtime docstring.}

Properties

id: int

name: str

ControlDescriptionVector

A container for returning control descriptions. ^{From Live’s runtime docstring.}

Methods

append()

Parameters

• value: ControlDescription

extend()

Parameters

• values: Iterable[ControlDescription]

Returned by 1 member elsewhere in the LOM

ControlSurfaceProxy

• control_descriptions: ControlDescriptionVector

ControlSurfaceProxy

Represents a control surface running in a different process. For use by M4L ^{From Live’s runtime docstring.}

Properties

control_descriptions: ControlDescriptionVectorhigh confidence

• probe couldn’t reach this class — ControlSurfaceProxy is M4L-only.
• corpus _MxDCore/ControlSurfaceWrapper.py:238 iterates c.name for c in self._proxy.control_descriptions — confirms it’s a container of ControlDescription objects (each with a .name property).
• schema ControlDescriptionVector exists in the parsed tree with element_repr fixed below to ControlDescription.

pad_layout: strhigh confidence

• M4L external/max-for-live-docs/9.0/controlsurface.md:18: pad_layout symbol read-only observe — symbol is M4L parlance for a string (string-valued layout names like ‘session’, ‘note.drums.64_pads’).
• docstring “The layout of pads on Push.”

The layout of pads on Push. ^{From Live’s runtime docstring.}

type_name: strmedium confidence

• corpus no raw_doc, no M4L doc entry; binding access at _MxDCore/ControlSurfaceWrapper.py:234 returns self._proxy.type_name from a wrapper property and uses the value in tuple/string contexts. str is the strongest reading — promote via probe.

Listener Only

control_values_arrived

add_control_values_arrived_listener · remove_control_values_arrived_listener · control_values_arrived_has_listener

Fires when control values arrive from the connected hardware after a subscribe_to_control registration. Notification only — read the values via fetch_received_values after the callback.

midi_received

add_midi_received_listener · remove_midi_received_listener · midi_received_has_listener

Fires when MIDI input arrives at the control surface proxy after enable_receive_midi(True). Notification only — read the messages via fetch_received_midi_messages.

Methods

enable_receive_midi()

Parameters

• enabled: bool

fetch_received_midi_messages()

Returns

tuple[tuple[int, …], …]Probed astuplemedium confidence

• docstring -> tuple confirms the outer return is a tuple.
• corpus _MxDCore/ControlSurfaceWrapper.py:251 iterates for message in self._proxy.fetch_received_midi_messages(): and passes each message to handle_message(message). The corpus doesn’t unpack the inner tuple, so the inner shape tuple[int, ...] is inferred from MIDI semantics (MIDI messages are tuples of status + data bytes, all ints).

fetch_received_values()

Returns

tuple[tuple[int, Any], …]Probed astuplehigh confidence

• docstring -> tuple confirms the outer return is a tuple.
• corpus _MxDCore/ControlSurfaceWrapper.py:244 explicitly unpacks the inner 2-tuple: for control_id, value in self._proxy.fetch_received_values():. The first element is then used as a dict key (self._control_proxies_by_id[control_id]) confirming int; the second element is passed to receive_value(value) — value type depends on control, so Any.

grab_control()

Parameters

• control_id: int

release_control()

Parameters

• control_id: int

send_midi()

Parameters

• midi_event_bytes: tuple[int, …]Probed astuplehigh confidence
  • C++ signature void send_midi(APythonControlSurfaceProxy {lvalue}, boost::python::tuple) — the binding takes an untyped tuple at the C++ level.
  • schema narrowed to tuple[int, ...] per function semantics — MIDI bytes are 0–255 ints by definition.
  • corpus binding calls pass int tuples: FaderfoxScript.py:111 (self.c_instance.send_midi(midi_event_bytes)), Axiom_49_61_Classic/Axiom.py:70 (self._Axiom__c_instance.send_midi(midi_event_bytes)); wrapper composers also produce int tuples (LV2_LX2_LC2_LD2/LV2TransportController.py:69-71 (NOTEON_STATUS + channel, note, 127), LV2_LX2_LC2_LD2/FaderfoxMixerController.py:142 (175, 16, 16)).

send_value()

Parameters

• value: tuple[Any, …]Probed astuplehigh confidence
  • C++ signature void send_value(APythonControlSurfaceProxy {lvalue}, boost::python::tuple) — the binding strictly accepts a tuple.
  • schema tuple[Any, ...] matches the untyped Boost.Python tuple — the binding itself doesn’t constrain element type at the C++ level.
  • corpus calls like interface.send_value(0) or button.send_value(value) don’t contradict this — those go to Python wrappers (SysexElement.send_value at sysex_element.py:25, InputControlElement.send_value at InputControlElement.py:324) which compose a tuple internally before the binding call. Zero direct Live.Application.ControlSurfaceProxy.send_value callsites exist in the corpus.

subscribe_to_control()

Parameters

• control_id: int

unsubscribe_from_control()

Parameters

• control_id: int

UnavailableFeatureVector

A container for returning unavailable features. ^{From Live’s runtime docstring.}

Methods

append()

Parameters

• value: UnavailableFeature

extend()

Parameters

• values: Iterable[UnavailableFeature]

Returned by 1 member elsewhere in the LOM

Application

• unavailable_features: UnavailableFeatureVector

Variants

Holds strings representing what type of Live is running. ^{From Live’s runtime docstring.}

Constants

Application.View

This class represents the view aspects of the Live application. ^{From Live’s runtime docstring.}

Properties

Inherited from LomObject

_live_ptr: int

canonical_parent: Application

Get the canonical parent of the application view. ^{From Live’s runtime docstring.}

browse_mode: bool

Return true if HotSwap mode is active for any target. ^{From Live’s runtime docstring.}

focused_document_view: str

Return the name of the document view (‘Session’ or ‘Arranger’) shown in the currently selected window. ^{From Live’s runtime docstring.}

Listener Only

view_focus_changed

add_view_focus_changed_listener · remove_view_focus_changed_listener · view_focus_changed_has_listener

Fires when the focused view changes (Session/Arrangement switch, popup open/close, primary/secondary window focus shifts). Programmatic triggers include focus_view, show_view, hide_view, and toggle_browse; user interaction with Live’s UI also fires it.

Methods

available_main_views()

Returns

StringVector

Return a list of strings with the available subcomponent views, which is to be specified, when using the rest of this classes functions. A ‘subcomponent view’ is a main view component of a document view, like the Session view, the Arranger or Detailview and so on… ^{From Live’s runtime docstring.}

focus_view()

Parameters

• view: str

Show and focus one through the identifier string specified view. ^{From Live’s runtime docstring.}

hide_view()

Parameters

• view_name: str

Hide one through the identifier string specified view. ^{From Live’s runtime docstring.}

is_view_visible()

Parameters

• view_name: str
• main_window_only: bool = True

Returns

bool

Returns whether the view named by view_name is currently visible. With main_window_only=False, also checks the second window — note that notifications from the second window are not yet supported.

Parameterized observable — the LOM’s only one (as of 12.3.6). Read by calling is_view_visible(view_name). Subscribe via the matching listener triplet, which takes view_name as its first parameter:

add_is_view_visible_listener(view_name, callback)
remove_is_view_visible_listener(view_name, callback)
is_view_visible_has_listener(view_name, callback)

^{Runtime docstringReturn true if the through the identifier string specified view is currently
visible. If main_window_only is set to False, this will also check in second
window. Notifications from the second window are not yet supported.}

scroll_view()

Parameters

• direction: NavDirection | intProbed asinthigh confidence
  • docstring “into the given direction”.
  • schema Application.View nests a single enum (NavDirection) with members up/down/left/right — direct semantic match. Boost.Python emits the enum class as an int subclass, hence NavDirection | int (standard enum-widening pattern).
• view_name: str
• modifier_pressed: bool

Scroll through the identifier string specified view into the given direction, if possible. Will silently return if the specified view can not perform the requested action. ^{From Live’s runtime docstring.}

show_view()

Parameters

• view: str

Show one through the identifier string specified view. Will throw a runtime error if this is called in Live’s initialization scope. ^{From Live’s runtime docstring.}

toggle_browse()

Reveals the device chain, the browser and starts hot swap for the selected device. Calling this function again stops hot swap. ^{From Live’s runtime docstring.}

zoom_view()

Parameters

• direction: NavDirection | intProbed asinthigh confidence
  • docstring “into the given direction”.
  • schema Application.View nests a single enum (NavDirection) with members up/down/left/right — direct semantic match. Boost.Python emits the enum class as an int subclass, hence NavDirection | int (standard enum-widening pattern).
• view_name: str
• modifier_pressed: bool

Zoom through the identifier string specified view into the given direction, if possible. Will silently return if the specified view can not perform the requested action. ^{From Live’s runtime docstring.}

Nested types

• Application.View.NavDirection

Returned by 1 member elsewhere in the LOM

Application

• view: View

Enums

MessageButtons

Specifies the characteristics of the message box, e.g. which buttons to show. ^{From Live’s runtime docstring.}

Members

OK_BUTTON	0
OK_NEW_SET_BUTTON	1
OK_RETRY_BUTTON	2
SAVE_DONT_SAVE_BUTTON	3
OK_ACCOUNT_BUTTON	4
OK_PURCHASE_BUTTON	5

PushDialogType

Specifies the dialog type for Push. ^{From Live’s runtime docstring.}

Members

MESSAGE_BOX	0
OUT_OF_UNLOCKS_DIALOG	5
RENT_TO_OWN_LICENSE_EXPIRED_DIALOG	7

UnavailableFeature

Members

note_velocity_ranges_and_probabilities

0

Application.View.NavDirection

Members

up	0
down	1
left	2
right	3

Functions

combine_apcs()

Returns

bool

Returns true if multiple APCs should be combined. ^{From Live’s runtime docstring.}

encrypt_challenge()

Parameters

• dongle1: int
• dongle2: int
• key_index: int = 0

Returns

tuple[int, …]Probed astuplehigh confidence

• corpus Push/handshake_component.py:53 wraps it for encryption; _APC/APC.py:79 compares the return to a dongle challenge tuple.
• docstring baseline Application.md:38 lists it as a module-level static.

Returns an encrypted challenge based on the TEA algortithm ^{From Live’s runtime docstring.}

encrypt_challenge2()

Parameters

• challenge: int

Returns

int

Returns the UMAC hash for the given challenge. ^{From Live’s runtime docstring.}

get_application()

Returns

Application

Returns the application instance. ^{From Live’s runtime docstring.}

get_random_int()

Parameters

• min_value: int
• max_value: int

Returns

int

Returns a random integer from the given range. ^{From Live’s runtime docstring.}