Skip to content
LiveAPI

Base

The LOM’s foundational layer. The Vector family — the generic base plus its concrete subclasses — is what every collection-valued LOM property returns; Text carries Live’s translatable strings, and Timer schedules callbacks.

Classes

Section titled “Classes”

FloatVector

Section titled “FloatVector”

A simple container for returning floats from Live. From Live’s runtime docstring.

Methods

Section titled “Methods”
append()
Section titled “append()”
Parameters
  • value: float
extend()
Section titled “extend()”
Parameters
  • values: Iterable[float]

IntU64Vector

Section titled “IntU64Vector”

A simple container for returning unsigned long integers from Live. From Live’s runtime docstring.

Methods

Section titled “Methods”
append()
Section titled “append()”
Parameters
  • value: int
extend()
Section titled “extend()”
Parameters
  • values: Iterable[int]
Returned by 2 members elsewhere in the LOM
Clip

IntVector

Section titled “IntVector”

A simple container for returning integers from Live. From Live’s runtime docstring.

Methods

Section titled “Methods”
append()
Section titled “append()”
Parameters
  • value: int
extend()
Section titled “extend()”
Parameters
  • values: Iterable[int]
Returned by 2 members elsewhere in the LOM
Clip
Song

LimitationError

Section titled “LimitationError”

ObjectVector

Section titled “ObjectVector”

A simple read only container for returning python objects. From Live’s runtime docstring.

Methods

Section titled “Methods”
append()
Section titled “append()”
Parameters
  • value: object
extend()
Section titled “extend()”
Parameters
  • values: Iterable[object]

StringVector

Section titled “StringVector”

A simple container for returning strings from Live. From Live’s runtime docstring.

Methods

Section titled “Methods”
append()
Section titled “append()”
Parameters
  • value: str
extend()
Section titled “extend()”
Parameters
  • values: Iterable[str]
Returned by 50 members elsewhere in the LOM
Application.View
CcControlDevice
DeviceParameter
DriftDevice
HybridReverbDevice
LooperDevice
PluginDevice
RoarDevice
ShifterDevice
SpectralResonatorDevice
Track
WavetableDevice

Text

Section titled “Text”

A translatable, immutable string. From Live’s runtime docstring.

Properties

Section titled “Properties”
text: strhigh confidence
  • corpus assigns/reads as string: pushbase/message_box_component.py:159 self._message_box.text = message; Push2/model/repr.py:726 reads.
  • M4L docs confirm string content.
Section titled “text: strhigh confidencecorpus assigns/reads as string: pushbase/message_box_component.py:159 self._message_box.text = message; Push2/model/repr.py:726 reads.M4L docs confirm string content.”

Timer

Section titled “Timer”

A timer that will trigger a callback after a certain inverval. The timer can be repeated and will trigger the callback every interval. Errors in the callback will stop the timer. From Live’s runtime docstring.

Properties

Section titled “Properties”
running: bool
Section titled “running: bool”

Methods

Section titled “Methods”
restart()
Section titled “restart()”
start()
Section titled “start()”
stop()
Section titled “stop()”

Vector

Section titled “Vector”

Parametric base class — Live registers a single Live.Base.Vector on the Boost.Python side and reuses it for every LOM list-valued property whose elements are LomObjects. Vector[Track], Vector[Clip], Vector[Scene], Vector[Device], … all return the same Python class; the element type varies per call site.

LomObject elements get the parametric form. Non-LomObject element types get their own concrete container class (IntVector, StringVector, RoutingChannelVector, MidiNoteVector, WarpMarkerVector, …), each declared on the module that owns the element type and registered separately on the Boost.Python side. One observed exception: Device.ATimeableValueVector holds DeviceParameter (a LomObject) but is its own concrete class — Live’s naming suggests “automatable value” is the relevant identity, not just “container of parameters.”

Behavior is identical across both patterns: iterable, indexable. The structural distinction matters only for isinstance checks and type annotations. The concrete XVector classes do not derive from Vector — both Live.Base.Vector and every XVector have the same single direct base, Boost.Python.instance; they’re siblings in the runtime class hierarchy, not a parent / child chain. isinstance(routing_channels, Live.Base.Vector) is structurally False.

Bound mutators. Every container class binds append and extend methods at the runtime level — Boost.Python wraps the underlying C++ std::vector<T> operations. Live’s own docstring on Vector describes the class as “read only,” however, and the LOM provides dedicated state-change methods (Track.create_audio_clip, Song.delete_track, …) for modifying tracked collections. Whether calling append / extend directly on a LOM-returned vector produces consistent state (listener fires, UI updates, persistence) is unverified. Runtime docstringA simple read only container for returning objects from Live.

Methods

Section titled “Methods”
append()
Section titled “append()”
Parameters
  • value: T
extend()
Section titled “extend()”
Parameters
  • values: Iterable[T]

Functions

Section titled “Functions”

get_text()

Section titled “get_text()”
Parameters
  • classname: str
  • textname: str
Returns
Text

Retrieves the (translated) Text identified by classname and textname. From Live’s runtime docstring.

log()

Section titled “log()”
Parameters
  • string: str

subst_args()

Section titled “subst_args()”
Parameters
  • text: Text
  • arg1: str = ”
  • arg2: str = ”
  • arg3: str = ”
  • arg4: str = ”
  • arg5: str = ”
Returns
str

This is an independent reference site. Not affiliated with, endorsed by, or sponsored by Ableton AG. “Ableton”, “Live”, “Push”, and related marks are trademarks of Ableton AG.