NAudio

NAudio is an open source .NET audio library written by Mark Heath

📖 Documentation site — tutorials and the full API reference.

NAudio 3

NAudio 3 is a major release. The headlines:

• The single NAudio assembly is split into focused packages — take only what you need. The NAudio meta-package pulls in the core Windows stack (WASAPI, Media Foundation, WinMM); ASIO, DMO/DirectSound and WinForms are separate packages.
• The core is cross-platform and Native-AOT compatible. NAudio.Core, NAudio.Midi, NAudio.Effects, NAudio.Sampler and NAudio.SoundFile run on Windows, Linux and macOS.
• Minimum target framework is net9.0 — legacy .NET Framework and .NET Standard 2.0 support is dropped.
• New subsystems: an audio effects framework, a software sampler, VST 3 hosting, ALSA playback/capture on Linux, and cross-platform file I/O via libsndfile.
• Modernised WASAPI and ASIO — the new WasapiPlayer / WasapiRecorder and AsioDevice APIs.

Upgrading from NAudio 2? Start with Migrating from NAudio 2 to NAudio 3. The full list of changes is in RELEASE_NOTES.md.

Packages

Installing the NAudio meta-package is the right default on Windows, from any netX.0 or netX.0-windows project: it gets you WASAPI, Media Foundation and WinMM playback and recording, MIDI, and AudioFileReader. Add NAudio.Asio, NAudio.Dmo (DirectSound and DMO effects) or NAudio.WinForms if you need them. The Windows backends are marked [SupportedOSPlatform("windows")], so the compiler flags unguarded calls in cross-platform code. On Linux or macOS, reference NAudio.Core and the backend you need directly rather than the meta-package.

Package	Platform	What it gives you
NAudio	any	Meta-package — Core, Midi, WinMM and Wasapi, plus AudioFileReader and Mp3FileReader
NAudio.Core	cross-platform	WaveStream / ISampleProvider model, WAV & AIFF I/O, mixing, resampling, DSP, NAudio.Effects, sequencing
NAudio.Midi	cross-platform (+ WinRT MIDI on Windows)	MIDI event model, Standard MIDI File reading & writing
NAudio.Wasapi	Windows	WASAPI playback, capture and loopback; Media Foundation codecs
NAudio.WinMM	Windows	WaveOut / WaveIn, classic MIDI I/O, ACM codecs, mixer controls
NAudio.Asio	Windows	Low-latency multichannel playback and capture through ASIO drivers
NAudio.Dmo	Windows	DMO effects, DMO MP3 decoder and resampler, DirectSoundOut
NAudio.WinForms	Windows	WinForms controls, and the window-callback WaveOutWindow / WaveInWindow
NAudio.Sampler	cross-platform	Polyphonic software sampler — SoundFont (.sf2), SFZ and single-sample instruments
NAudio.Nam	cross-platform	Neural Amp Modeler (.nam) guitar amp and pedal captures as a real-time effect
NAudio.SoundFile

NAudio.Core, NAudio.Midi, NAudio.Wasapi, NAudio.WinMM, NAudio.Asio, NAudio.Dmo, NAudio.Sampler, NAudio.Nam, NAudio.SoundFile and NAudio.Alsa are Native-AOT compatible. See the assembly layout plan for the reasoning behind the split.

Documentation

• Documentation site — tutorials and the full API reference.
• Tutorials — the task-focused how-to guides listed below, also in Docs/.
• Migrating from NAudio 2 — every breaking change, with before/after code.
• NAudio articles on Mark Heath's blog.

NAudio comes with several demo applications, which are the quickest way to see how the various features fit together: NAudioDemo (WinForms), NAudioWpfDemo, and the smaller NAudioConsoleTest, AudioFileInspector, MidiFileConverter and MixDiff tools. They have the advantage of being kept up to date, whilst some of the tutorials you will find on the internet refer to old versions of NAudio.

This is the beginning of the README. Read the rest at the original. Read the full README ↗