reference

PHILOSOPHY

Soir is organized around the concept of live coding - writing and modifying code in real-time to create music. The API is designed to be minimal, expressive, and organized into modules that each handle a specific aspect of music creation.

All modules are available globally when running Soir, so you can use them directly without imports. This design keeps your live coding sessions clean and focused on the music.

BASICS

The best place to start is with the core facilities, which provide the fundamental decorators and functions you'll use in every Soir session. Once you understand these core facilities, explore the modules below.

MODULES

Module Description
core Core decorators and utils for live coding
bpm Tempo control and beat timing
ctrls Parameter controls and modulation
errors Error types and exception handling
fx Audio effects and processing
levels Audio level metering for tracks and master output
midi MIDI input/output and control
rnd Random number generation for musical variation
sampler Sample playback and management
system System utilities and configuration
tracks Track management and routing