Index Preamble and License

Preface

The Advanced Linux Sound Architecture (ALSA) comes with a kernel API and a library API. This document describes the library API and how it interfaces with the kernel API.

Documentation License

This documentation is free; you can redistribute it without any restrictions. Modifications or derived work must retain the copyright and list all authors.

This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

API usage

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

API links

Page Control interface explains the primitive controls API.
Page High level control interface explains the high-level primitive controls API.
Page Mixer interface explains the mixer controls API.
Page PCM (digital audio) interface explains the design of the PCM (digital audio) API.
Page PCM (digital audio) plugins explains the design of PCM (digital audio) plugins.
Page PCM External Plugin SDK explains the external PCM plugin SDK.
Page External Control Plugin SDK explains the external control plugin SDK.
Page RawMidi interface explains the design of the RawMidi API.
Page Timer interface explains the design of the Timer API.
Page Sequencer interface explains the design of the Sequencer API.
Page Use Case Interface explains the use case API.
Page ALSA Topology Interface explains the DSP topology API.

Configuration

Page Configuration files explains the syntax of library configuration files.
Page Runtime arguments in configuration files explains the run-time argument syntax.
Page Runtime functions in configuration files explains run-time function definitions and their usage.
Page Hooks in configuration files explains run-time hook definitions and their usage.

Further Reading:

Configuration Interface

Constants for Digital Audio Interfaces

Constants for MIDI v1.0

MIDI Commands

MIDI Controllers

Control Interface

High level Control Interface

Setup Control Interface

Error handling

External Control Plugin SDK

External PCM plugin SDK

External Filter plugin SDK

External I/O plugin SDK

Global defines and functions

Hardware Dependant Interface

Input Interface

MIDI Sequencer

Sequencer Client Interface
Sequencer Event API
Sequencer Event Definitions
Sequencer Event Type Checks
Sequencer Middle Level Interface
Sequencer Miscellaneous
Sequencer Port Interface
Sequencer Port Subscription
Sequencer Queue Interface
Sequencer event <-> MIDI byte stream coder

Mixer Interface

Simple Mixer Interface

Output Interface

PCM Interface

Access Mask Functions
Debug Functions
Deprecated Functions
Description Functions
Direct Access (MMAP) Functions
Format Mask Functions
Hardware Parameters
Helper Functions
Hook Extension
Scope Plugin Extension
Simple setup functions
Software Parameters
Status Functions
Stream Information
Subformat Mask Functions

Related Pages:

ALSA Topology Interface
ALSA Use Case Interface
Bug List
Configuration files
Control interface
Deprecated List
External Control Plugin SDK
High level control interface
Hooks in configuration files
Mixer interface
PCM (digital audio) interface
PCM (digital audio) plugins
PCM External Plugin SDK
RawMidi interface
Runtime arguments in configuration files
Runtime functions in configuration files
Sequencer interface
Timer interface

Examples:

/test/latency.c
/test/pcm.c
/test/pcm_min.c
/test/rawmidi.c
/test/timer.c

Reference and Index:

Global Namespace

Index