Documentation

Using the library

• Getting started: requirements, building, installing, build options, the model the API follows.
• Devices and streams: contexts, devices, playing and capturing, following the default, notifications, suspension, timing, duplex, loopback, exclusive and object streams.
• Offline rendering: rendering without hardware, and scripting device changes for tests.
• Voice processing: the platform's processing and the library's detector, gain control, noise suppressor and echo canceller.
• Spatial audio: HRTF sets, the binaural effect, the ambisonic bed, speakers, the direct effect and the reverb.
• Environments: the spatializer, scenes, reverberation, reflections, probe sets, paths and bakes.
• Platforms: what each platform needs, and what to check when there is no sound.
• Private backends: building a backend kept outside the library.
• API reference, generated from the headers.

How it works

• Overview: the library profile and how the parts fit.
• Glossary.
• Real-time rules, Devices, Streams, Backends, The web, Voice processing.
• Spatial rendering, Propagation, File formats.
• Maul conventions: the rules every Maul library follows.

Maintaining it

• Development: toolchain, building and testing, generated data, benchmarks, fuzzing.
• Checks: the local tiers, the CI jobs and their budgets.
• Test environments: the sound servers, Wine, simulators, emulators and browsers the tests run against.
• Device checklist: what is checked by hand on real hardware before a release.
• Release: how release-please makes a release, and what to check before merging it.