doc/index.doxygen

   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
   8 <H2>Preface</H2>
   9 <P>The Advanced Linux Sound Architecture (\e ALSA) comes with a kernel
  10 API and a library API. This document describes the library API and how
  11 it interfaces with the kernel API.</P>
  12
  13 <H2>Documentation License</H2>
  14
  15 <P>This documentation is free; you can redistribute it without
  16 any restrictions. Modifications or derived work must retain
  17 the copyright and list all authors.</P>
  18
  19 <P>This documentation is distributed in the hope that it will be
  20 useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</P>
  22
  23 <H2>API usage</H2>
  24 <P>Application programmers should use the library API rather than the
  25 kernel API. The library offers 100% of the functionality of the kernel API,
  26 but adds major improvements in usability, making the application code simpler
  27 and better looking. In addition, future fixes or compatibility code
  28 may be placed in the library code instead of the kernel driver.</P>
  29
  30 <H2>API links</H2>
  31
  32 <UL>
  33   <LI>Page \ref control explains the primitive controls API.
  34   <LI>Page \ref control_plugins explains the design of primitive control plugins.
  35   <LI>Page \ref hcontrol explains the high-level primitive controls API.
  36   <LI>Page \ref mixer explains the mixer controls API.
  37   <LI>Page \ref pcm explains the design of the PCM (digital audio) API.
  38   <LI>Page \ref pcm_plugins explains the design of PCM (digital audio) plugins.
  39   <LI>Page \ref pcm_external_plugins explains the external PCM plugin SDK.
  40   <LI>Page \ref ctl_external_plugins explains the external control plugin SDK.
  41   <LI>Page \ref rawmidi explains the design of the RawMidi API.
  42   <LI>Page \ref timer explains the design of the Timer API.
  43   <LI>Page \ref seq explains the design of the Sequencer API.
  44   <LI>Page \ref ucm explains the use case API.
  45   <LI>Page \ref topology explains the DSP topology API.
  46 </UL>
  47
  48 <H2>Configuration</H2>
  49
  50 <UL>
  51   <LI>Page \ref conf explains the syntax of library configuration files.
  52   <LI>Page \ref confarg explains the run-time argument syntax.
  53   <LI>Page \ref conffunc explains run-time function definitions and their usage.
  54   <LI>Page \ref confhooks explains run-time hook definitions and their usage.
  55 </UL>
  56
  57 */