Skip to main content

Module contract

Module contract 

Source
Expand description

What a driver tells Oscyl about one synth model.

Programs are opaque bytes in the driver’s own native layout; generic code reads and writes them only through the driver. Field indices are positions in Driver::fields.

Structs§

Bank
A run of program slots, numbered from first.
Capabilities
What the synth can do. Apps show only what is listed here.
DriverError
A driver-specific failure, as text the apps can show.
FieldInfo
One program parameter: raw stored values min..=max.
FileFormat
A vendor file format a driver reads and writes.
Info
Which synth a driver serves.
LibProgram
One program in a library, with its author metadata.
LibraryData
A library’s contents, independent of any file format.
NameRules
Program-name limits.
UnitKind
One kind of user unit (custom oscillator, effect, …) and its slot count.

Enums§

SessionEvent
Results of SessionOps, in order.
SessionOp
A generic operation on a connected synth.

Traits§

Driver
One synth model: everything the apps know about it. Object-safe, so apps can hold several at once, as &dyn Driver. A driver crate exposes one as pub static DRIVER.
DriverSession
A sans-IO session with one connected synth.
PanelListener
Decodes the Control Changes a synth’s panel sends: one per synth, as it keeps state between messages (a 10-bit value’s lower bits, an NRPN selection).
Simulator
A sans-IO simulated synth, for tests and demo mode.