API Reference¶

Core Modules¶

Module	Description
SynthDef Builder	`SynthDefBuilder`, `SynthDef`, `UGen` base class, `@synthdef` decorator
Server	`Server` class -- boot/quit lifecycle, node control, buffer management & numpy data exchange, `sync()`, introspection (`status`/`query_tree`/`reset`), and node notifications. See the Server Control guide
Envelopes	`Envelope` class and `EnvGen` UGen
OSC Codec	`OscMessage` and `OscBundle` encode/decode
Enums	`CalculationRate`, `DoneAction`, `BinaryOperator`, `UnaryOperator`, etc.
Options	`Options` dataclass and `EmbeddedProcessProtocol`
Compiler	SCgf binary serialization and `compile_synthdefs()`
Exceptions	`NanosynthError` hierarchy

Module	Description
Patterns	`Pseq`/`Prand`/`Pwhite` value patterns, `Pbind` events, `Clock` and `Player`
Node Proxies	`NodeProxy` and `Ndef` -- hot-swappable sources for live coding
Score (NRT)	Offline rendering to an audio file without an audio device

Module	Description
Supernova	Parallel-DSP engine lifecycle. See the Supernova Guide
MIDI	`MidiIn` and parsed message types. See the MIDI Guide

340+ UGen classes organized by category. See the UGen index for an overview.