Blame doc/index.doxygen

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

Preface

Packit Service db8eaa

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

Packit Service db8eaa
API and a library API. This document describes the library API and how
Packit Service db8eaa
it interfaces with the kernel API.

Packit Service db8eaa
Packit Service db8eaa

Documentation License

Packit Service db8eaa
Packit Service db8eaa

This documentation is free; you can redistribute it without

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

Packit Service db8eaa
 
Packit Service db8eaa

This documentation is distributed in the hope that it will be

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

Packit Service db8eaa
Packit Service db8eaa

API usage

Packit Service db8eaa

Application programmers should use the library API rather than the

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

Packit Service db8eaa
Packit Service db8eaa

API links

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

    Configuration

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