Expand description
performance — a running Program: sample-accurate transport, a bounded scheduled-command queue, stingers, click-free program swaps, metrics, and deterministic command capture/replay (ADR 0005).
A Performance is the runtime half of Song::compile → Program: the
host schedules commands at frames, beats, bars, markers, or sections, and
the render executes them at exact frames in submission order — no Python,
game loop, or OS timer ever needs to wake on a musical boundary. The
callback path performs no allocation beyond first-use growth of the
pre-sized scratch (see SCRATCH_FRAMES): a stinger is rendered at
schedule time, so firing one mid-callback only mixes a pre-rendered
buffer — no render, no allocation on the render path.
This API is stable — frozen at 1.10.0-rc.1 (docs/api-tiers.md).
Structs§
- Performance
- A running program — see the module docs.
- Performance
Metrics - A point-in-time health snapshot — read off the audio path; all counters advance on the render side without formatting or allocation.
- Performance
Snapshot - A point-in-time control snapshot (see
Performance::snapshot). - Timestamped
Command - A command pinned to an exact frame with its submission order — the unit of deterministic replay.
Enums§
- At
- Where a command lands on the timeline, resolved to an exact frame at schedule time (the transport lives on the control side, so musical resolution never touches the render path).
- Command
- One schedulable runtime command.
- Performance
Error - Why a schedule call failed.
Constants§
- COMMAND_
QUEUE_ CAP - The command queue’s capacity. A full queue rejects the new command (the caller decides what to drop) and counts it — the defined exhaustion behavior (ADR 0005).