Blame doc/index.doxygen

Packit 4a16fb
/*! \mainpage Index Preamble and License
Packit 4a16fb
Packit 4a16fb
\author Jaroslav Kysela <perex@perex.cz>
Packit 4a16fb
\author Abramo Bagnara <abramo@alsa-project.org>
Packit 4a16fb
\author Takashi Iwai <tiwai@suse.de>
Packit 4a16fb
\author Frank van de Pol <fvdpol@coil.demon.nl>
Packit 4a16fb
Packit 4a16fb

Preface

Packit 4a16fb

The Advanced Linux Sound Architecture (\e ALSA) comes with a kernel

Packit 4a16fb
API and a library API. This document describes the library API and how
Packit 4a16fb
it interfaces with the kernel API.

Packit 4a16fb
Packit 4a16fb

Documentation License

Packit 4a16fb
Packit 4a16fb

This documentation is free; you can redistribute it without

Packit 4a16fb
any restrictions. Modifications or derived work must retain
Packit 4a16fb
the copyright and list all authors.

Packit 4a16fb
 
Packit 4a16fb

This documentation is distributed in the hope that it will be

Packit 4a16fb
useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 4a16fb
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Packit 4a16fb
Packit 4a16fb

API usage

Packit 4a16fb

Application programmers should use the library API rather than the

Packit 4a16fb
kernel API. The library offers 100% of the functionality of the kernel API,
Packit 4a16fb
but adds major improvements in usability, making the application code simpler
Packit 4a16fb
and better looking. In addition, future fixes or compatibility code
Packit 4a16fb
may be placed in the library code instead of the kernel driver.

Packit 4a16fb
Packit 4a16fb

API links

Packit 4a16fb
Packit 4a16fb
    Packit 4a16fb
      
  • Page \ref control explains the primitive controls API.
  • Packit 4a16fb
      
  • Page \ref hcontrol explains the high-level primitive controls API.
  • Packit 4a16fb
      
  • Page \ref mixer explains the mixer controls API.
  • Packit 4a16fb
      
  • Page \ref pcm explains the design of the PCM (digital audio) API.
  • Packit 4a16fb
      
  • Page \ref pcm_plugins explains the design of PCM (digital audio) plugins.
  • Packit 4a16fb
      
  • Page \ref pcm_external_plugins explains the external PCM plugin SDK.
  • Packit 4a16fb
      
  • Page \ref ctl_external_plugins explains the external control plugin SDK.
  • Packit 4a16fb
      
  • Page \ref rawmidi explains the design of the RawMidi API.
  • Packit 4a16fb
      
  • Page \ref timer explains the design of the Timer API.
  • Packit 4a16fb
      
  • Page \ref seq explains the design of the Sequencer API.
  • Packit 4a16fb
      
  • Page \ref ucm explains the use case API.
  • Packit 4a16fb
      
  • Page \ref topology explains the DSP topology API.
  • Packit 4a16fb
    Packit 4a16fb
    Packit 4a16fb

    Configuration

    Packit 4a16fb
    Packit 4a16fb
      Packit 4a16fb
        
    • Page \ref conf explains the syntax of library configuration files.
    • Packit 4a16fb
        
    • Page \ref confarg explains the run-time argument syntax.
    • Packit 4a16fb
        
    • Page \ref conffunc explains run-time function definitions and their usage.
    • Packit 4a16fb
        
    • Page \ref confhooks explains run-time hook definitions and their usage.
    • Packit 4a16fb
      Packit 4a16fb
      Packit 4a16fb
      */