Home

Welcome to the esp32-sound wiki!

Overview

This module does what it name say — it implements totally flexible support for playing sound via DAC.

It operate on two basic classes: SoundMixer, which mix channels and out audio and SoundProvider - abstract class for implementing sources.

Important note: you should carry about SoundProviders by youself — keep it in memory until you sure, that it will never be accessed (it finished or you stopped it). Rememer, that it is NOT safe to remove it from memory when state(provider_cannel) != STOPPED. In next version (which is in development and will be in master soon) I will use std::shared_ptr

End-user manual

If you just want to integrate this library into your programm, it should be easy. Follow this steps:

1. At first, you need custom provider (search by topic esp32-sound).
2. Integrate selected provider(s) and this component into your project via git submodule git_url dir_name in your components folder.
3. Import data to your programm - module's manual should contain instructions.
4. Configure base module and/or providers in menuconfig - Sound module configuration. In most cases default configuration should work fine, but providers may require more advanced settings.
5. For basic API's read this article.

Provider writers manual

You want to create your own sound provider? Great! Read dev notes and explore provider creation overview.