Tutorials

A guided tour of dart-yse, organised in five progressive phases that mirror the bundled demos under example/. Each demo is a runnable Dart program — work through them in order if you are new to the wrapper, or jump straight to the one you need if you are looking up a specific capability.

The Dart demos are ports of the C++ Demo.Windows.Native demos shipped with libYSE upstream, so if you follow both worlds the source shapes will look familiar.

Phase 1 — Fundamentals

The minimum you need to put a sound on the speakers — covered in the Hello, sound walkthrough above.

Phase 2 — Spatial audio and mixing

3D positioning, channels, audio devices. Demos:

• demo04_channels.dart — route sounds through pre-built channels.

• demo06_devices.dart — list the output devices without opening a stream (System.refreshDevices() on an offline session). Opening and switching devices is covered in Sessions and devices.

• demo19_bus.dart — name a synth, a sound, a channel and a patcher, then drive them all through Bus.publish() while a Bus.tap() and a Bus.subscribe() print what goes by. See Bus.

Phase 3 — Effects

Reverb zones and DSP effects on individual sounds:

• demo05_reverb.dart — multiple positioned Reverb zones that blend into the listener mix as the listener moves through them.

• demo07_dsp_buffer.dart — load bytes into a DspBuffer and play it as a sound source via Sound.fromBuffer().

• demo08_dsp_modules.dart — chain DspObject effects (lowpass, sweep, granulator, …) onto a sound.

Phase 4 — MIDI and music

• demo16_midi.dart — enumerate MIDI output ports and send Note-On / Note-Off via MidiOut.

• demo17_music.dart — build Note / PNote / Scale / Motif objects, then let a generative Player improvise on a Synth with them.

• demo20_clocks_clips.dart — loop a bar of notes into a Synth with a ClipTransport on a DomainClock, glide the tempo and swap the notes while it plays. Written up as a full tutorial:

• Clocks and clips

Phase 5 — Modular synthesis

• Patcher: modular synthesis in code

The patcher and clocks-and-clips tutorials are written as full prose — they are the largest API surfaces and benefit from a guided introduction. Other tutorials are inline comments in each demo file; refer to the source under example/.

How to follow along

Demos hard-code paths into the third_party/yse-soundengine/TestResources/ directory of the engine submodule, so they should be launched from the dart-yse repository root:

dart run example/hello_sound.dart
dart run example/demo13_patcher.dart
# ...

On Windows x64 and Linux x64 the examples run against the engine the package’s build hook bundles, with no setup (see Install). To use another build, such as one from source in third_party/yse-soundengine/build/bin/, set YSE_DLL_PATH to the directory holding libyse first.