1/*! \mainpage Index, Preamble and License 2 3\author Jaroslav Kysela <perex@perex.cz> 4\author Abramo Bagnara <abramo@alsa-project.org> 5\author Takashi Iwai <tiwai@suse.de> 6\author Frank van de Pol <fvdpol@coil.demon.nl> 7 8Preface 9------- 10 11The Advanced Linux Sound Architecture (\e ALSA) comes with a kernel 12API and a library API. This document describes the library API and how 13it interfaces with the kernel API. 14 15### Documentation License 16 17 This documentation is free; you can redistribute it without 18 any restrictions. Modifications or derived work must retain 19 the copyright and list all authors. 20 21 This documentation is distributed in the hope that it will be 22 useful, but WITHOUT ANY WARRANTY; without even the implied warranty of 23 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 24 25API usage 26--------- 27 28Application programmers should use the library API rather than the 29kernel API. The library offers 100% of the functionality of the kernel API, 30but adds major improvements in usability, making the application code simpler 31and better looking. In addition, future fixes or compatibility code 32may be placed in the library code instead of the kernel driver. 33 34API links 35--------- 36 37- Page \subpage control explains the primitive controls API. 38- Page \subpage control_plugins explains the design of primitive control plugins. 39- Page \subpage hcontrol explains the high-level primitive controls API. 40- Page \subpage mixer explains the mixer controls API. 41- Page \subpage pcm explains the design of the PCM (digital audio) API. 42- Page \subpage pcm_plugins explains the design of PCM (digital audio) plugins. 43- Page \subpage pcm_external_plugins explains the external PCM plugin SDK. 44- Page \subpage ctl_external_plugins explains the external control plugin SDK. 45- Page \subpage rawmidi explains the design of the RawMidi API. 46- Page \subpage timer explains the design of the Timer API. 47- Page \subpage seq explains the design of the Sequencer API. 48- Page \subpage ucm explains the use case API. 49- Page \subpage topology explains the DSP topology API. 50 51Configuration 52------------- 53 54- Page \subpage conf explains the syntax of library configuration. 55- Page \subpage confarg explains the run-time argument syntax. 56- Page \subpage conffunc explains run-time function definitions and their usage. 57- Page \subpage confhooks explains run-time hook definitions and their usage. 58- Page \subpage ucm_conf explains the UCM configuration and their usage. 59 60*/ 61