mirror of
https://github.com/alsa-project/alsa-lib.git
synced 2025-11-02 09:01:48 -05:00
More updates regarding configuration
This commit is contained in:
parent
4ee6606bab
commit
0908dac385
5 changed files with 175 additions and 4 deletions
56
doc/confarg.doxygen
Normal file
56
doc/confarg.doxygen
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
/*! \page confarg Configuration - runtime arguments
|
||||
|
||||
<P>The ALSA library can accept runtime arguments for some configuration
|
||||
blocks. This extension is on top of the basic syntax of the configuration
|
||||
files.<P>
|
||||
|
||||
\section confarg_define Defining arguments
|
||||
|
||||
Arguments are specified by id (key) @args and array values containing
|
||||
the string names of arguments:
|
||||
|
||||
\code
|
||||
@args [ CARD ] # or
|
||||
@args.0 CARD
|
||||
\endcode
|
||||
|
||||
\section confarg_type Defining argument type and default value
|
||||
|
||||
Arguments type is specified by id (key) @args and argument name. The type
|
||||
and default value is specified in the compound:
|
||||
|
||||
\code
|
||||
@args.CARD {
|
||||
type string
|
||||
default "abcd"
|
||||
}
|
||||
\endcode
|
||||
|
||||
\section confarg_refer Refering argument
|
||||
|
||||
Arguments are refered by dollar-sign ($) and name of argument:
|
||||
|
||||
\code
|
||||
card $CARD
|
||||
\endcode
|
||||
|
||||
\section confarg_example Example
|
||||
|
||||
\code
|
||||
pcm.demo {
|
||||
@args [ CARD DEVICE ]
|
||||
@args.CARD {
|
||||
type string
|
||||
default "supersonic"
|
||||
}
|
||||
@args.DEVICE {
|
||||
type integer
|
||||
default 0
|
||||
}
|
||||
type hw
|
||||
card $CARD
|
||||
device $DEVICE
|
||||
}
|
||||
\endcode
|
||||
|
||||
*/
|
||||
Loading…
Add table
Add a link
Reference in a new issue