mirror of
				https://github.com/alsa-project/alsa-lib.git
				synced 2025-11-03 09:01:52 -05:00 
			
		
		
		
	pcm: empty plugin - fix the docs
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
This commit is contained in:
		
							parent
							
								
									10e2490023
								
							
						
					
					
						commit
						bb646ecb47
					
				
					 1 changed files with 15 additions and 10 deletions
				
			
		| 
						 | 
					@ -1,12 +1,12 @@
 | 
				
			||||||
/**
 | 
					/**
 | 
				
			||||||
 * \file pcm/pcm_empty.c
 | 
					 * \file pcm/pcm_empty.c
 | 
				
			||||||
 * \ingroup PCM_Plugins
 | 
					 * \ingroup PCM_Plugins
 | 
				
			||||||
 * \brief PCM Null Plugin Interface
 | 
					 * \brief PCM Empty Plugin Interface
 | 
				
			||||||
 * \author Jaroslav Kysela <perex@perex.cz>
 | 
					 * \author Jaroslav Kysela <perex@perex.cz>
 | 
				
			||||||
 * \date 2006
 | 
					 * \date 2006
 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
/*
 | 
					/*
 | 
				
			||||||
 *  PCM - Null plugin
 | 
					 *  PCM - Empty plugin
 | 
				
			||||||
 *  Copyright (c) 2006 by Jaroslav Kysela <perex@perex.cz>
 | 
					 *  Copyright (c) 2006 by Jaroslav Kysela <perex@perex.cz>
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
| 
						 | 
					@ -36,21 +36,26 @@ const char *_snd_module_pcm_empty = "";
 | 
				
			||||||
 | 
					
 | 
				
			||||||
/*! \page pcm_plugins
 | 
					/*! \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
 | 
					This plugin just redirects the PCM stream to another plugin.
 | 
				
			||||||
samples.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Note: This implementation uses devices /dev/null (playback, must be writable)
 | 
					 | 
				
			||||||
and /dev/full (capture, must be readable).
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
\code
 | 
					\code
 | 
				
			||||||
pcm.name {
 | 
					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
 | 
					\endcode
 | 
				
			||||||
 | 
					
 | 
				
			||||||
\subsection pcm_plugins_null_funcref Function reference
 | 
					\subsection pcm_plugins_empty_funcref Function reference
 | 
				
			||||||
 | 
					
 | 
				
			||||||
<UL>
 | 
					<UL>
 | 
				
			||||||
  <LI>_snd_pcm_empty_open()
 | 
					  <LI>_snd_pcm_empty_open()
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue