mirrors/alsa-lib
1
0
Fork 0
mirror of https://github.com/alsa-project/alsa-lib.git synced 2025-11-02 09:01:48 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

pcm: empty plugin - fix the docs

Browse source 
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
This commit is contained in:
Jaroslav Kysela 2021-04-06 20:03:40 +02:00
parent 10e2490023
commit bb646ecb47
1 changed files with 15 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

25
src/pcm/pcm_empty.c
View file

@ -1,12 +1,12 @@
/**
* \file pcm/pcm_empty.c
* \ingroup PCM_Plugins
* \brief PCM Null Plugin Interface
* \brief PCM Empty Plugin Interface
* \author Jaroslav Kysela <perex@perex.cz>
* \date 2006
*/
/*
* PCM - Null plugin
* PCM - Empty plugin
* Copyright (c) 2006 by Jaroslav Kysela <perex@perex.cz>
*
*
@ -36,21 +36,26 @@ const char *_snd_module_pcm_empty = "";
/*! \page pcm_plugins
\section pcm_plugins_null Plugin: Null
\section pcm_plugins_empty Plugin: Empty
This plugin discards contents of a PCM stream or creates a stream with zero
samples.
Note: This implementation uses devices /dev/null (playback, must be writable)
and /dev/full (capture, must be readable).
This plugin just redirects the PCM stream to another plugin.
\code
pcm.name {
type null # Null PCM
type empty # Null PCM
slave STR # Slave name
# or
slave { # Slave definition
pcm STR # Slave PCM name
# or
pcm { } # Slave PCM definition
[format STR] # Slave format
[channels INT] # Slave channels
}
}
\endcode
\subsection pcm_plugins_null_funcref Function reference
\subsection pcm_plugins_empty_funcref Function reference
<UL>
<LI>_snd_pcm_empty_open()