Home

Welcome to the esp32-sound wiki!

NOTE: I'm trying to update this wiki to 1.0 version so information may be out-of-sync. Sorry.

Overview

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

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

End-user manual

If you just want to integrate this library into your program, 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 program - 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.

If you're using CMake build

You need to set

set(CMAKE_CXX_STANDARD 14)

in top-level CMakeLists.txt to get this library working. C++17 on beta toolchain should work as well.

Provider writers manual

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