VAE - Virtual Audio Engine 1
Small Data Driven Audio Engine
documentation.hpp
Go to the documentation of this file.
1/**
2 * @mainpage VAE Documentation
3 * @section intro_sec Introduction
4 * VAE is a very basic data riven audio engine.
5 * Banks are read in as json files and contain all data neded to play back audio.
6 *
7 * [See the main readme for more details](../README.md)
8 *
9 * [See readme about the driving data structures](../src/core/pod/README.md)
10 *
11 * Also vae::EnginePimpl or vae::core::Engine is a good place to start
12 * @section install_sec Installation
13 * All dependencies are included, submodules need to be initalized.
14 * cmake will build a static a static lib by default and a simple example from the dev folder.
15 * Building with BUILD_SHARED_LIBS builds a dynamic lib to be used with the generated pimpl api
16 */