mirror of
https://github.com/alsa-project/alsa-lib.git
synced 2025-10-29 05:40:25 -04:00
document all PCM plugin parameters
This commit is contained in:
parent
2cb16f857d
commit
ef11ba77ed
11 changed files with 26 additions and 1 deletions
|
|
@ -588,7 +588,7 @@ int snd_pcm_adpcm_open(snd_pcm_t **pcmp, const char *name, snd_pcm_format_t sfor
|
||||||
|
|
||||||
\section pcm_plugins_adpcm Plugin: Ima-ADPCM
|
\section pcm_plugins_adpcm Plugin: Ima-ADPCM
|
||||||
|
|
||||||
This plugin converts Ima-ADPCM samples to linear or linear to Mu-Law samples
|
This plugin converts Ima-ADPCM samples to linear or linear to Ima-ADPCM samples
|
||||||
from master Ima-ADPCM conversion PCM to given slave PCM. The channel count,
|
from master Ima-ADPCM conversion PCM to given slave PCM. The channel count,
|
||||||
format and rate must match for both of them.
|
format and rate must match for both of them.
|
||||||
|
|
||||||
|
|
@ -601,6 +601,7 @@ pcm.name {
|
||||||
pcm STR # Slave PCM name
|
pcm STR # Slave PCM name
|
||||||
# or
|
# or
|
||||||
pcm { } # Slave PCM definition
|
pcm { } # Slave PCM definition
|
||||||
|
format STR # Slave format
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
\endcode
|
\endcode
|
||||||
|
|
|
||||||
|
|
@ -473,6 +473,7 @@ pcm.name {
|
||||||
pcm STR # Slave PCM name
|
pcm STR # Slave PCM name
|
||||||
# or
|
# or
|
||||||
pcm { } # Slave PCM definition
|
pcm { } # Slave PCM definition
|
||||||
|
format STR # Slave format
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
\endcode
|
\endcode
|
||||||
|
|
|
||||||
|
|
@ -991,6 +991,7 @@ pcm.name {
|
||||||
type dmix # Direct mix
|
type dmix # Direct mix
|
||||||
ipc_key INT # unique IPC key
|
ipc_key INT # unique IPC key
|
||||||
ipc_key_add_uid BOOL # add current uid to unique IPC key
|
ipc_key_add_uid BOOL # add current uid to unique IPC key
|
||||||
|
ipc_perm INT # IPC permissions (octal, default 0600)
|
||||||
slave STR
|
slave STR
|
||||||
# or
|
# or
|
||||||
slave { # Slave definition
|
slave { # Slave definition
|
||||||
|
|
@ -1011,6 +1012,7 @@ pcm.name {
|
||||||
bindings { # note: this is client independent!!!
|
bindings { # note: this is client independent!!!
|
||||||
N INT # maps slave channel to client channel N
|
N INT # maps slave channel to client channel N
|
||||||
}
|
}
|
||||||
|
slowptr BOOL # slow but more precise pointer updates
|
||||||
}
|
}
|
||||||
\endcode
|
\endcode
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -727,6 +727,7 @@ pcm.name {
|
||||||
type dshare # Direct sharing
|
type dshare # Direct sharing
|
||||||
ipc_key INT # unique IPC key
|
ipc_key INT # unique IPC key
|
||||||
ipc_key_add_uid BOOL # add current uid to unique IPC key
|
ipc_key_add_uid BOOL # add current uid to unique IPC key
|
||||||
|
ipc_perm INT # IPC permissions (octal, default 0600)
|
||||||
slave STR
|
slave STR
|
||||||
# or
|
# or
|
||||||
slave { # Slave definition
|
slave { # Slave definition
|
||||||
|
|
@ -747,6 +748,7 @@ pcm.name {
|
||||||
bindings { # note: this is client independent!!!
|
bindings { # note: this is client independent!!!
|
||||||
N INT # maps slave channel to client channel N
|
N INT # maps slave channel to client channel N
|
||||||
}
|
}
|
||||||
|
slowptr BOOL # slow but more precise pointer updates
|
||||||
}
|
}
|
||||||
\endcode
|
\endcode
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -677,6 +677,7 @@ pcm.name {
|
||||||
type dsnoop # Direct snoop
|
type dsnoop # Direct snoop
|
||||||
ipc_key INT # unique IPC key
|
ipc_key INT # unique IPC key
|
||||||
ipc_key_add_uid BOOL # add current uid to unique IPC key
|
ipc_key_add_uid BOOL # add current uid to unique IPC key
|
||||||
|
ipc_perm INT # IPC permissions (octal, default 0600)
|
||||||
slave STR
|
slave STR
|
||||||
# or
|
# or
|
||||||
slave { # Slave definition
|
slave { # Slave definition
|
||||||
|
|
@ -697,6 +698,7 @@ pcm.name {
|
||||||
bindings { # note: this is client independent!!!
|
bindings { # note: this is client independent!!!
|
||||||
N INT # maps slave channel to client channel N
|
N INT # maps slave channel to client channel N
|
||||||
}
|
}
|
||||||
|
slowptr BOOL # slow but more precise pointer updates
|
||||||
}
|
}
|
||||||
\endcode
|
\endcode
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -432,6 +432,7 @@ pcm.name {
|
||||||
pcm STR # Slave PCM name
|
pcm STR # Slave PCM name
|
||||||
# or
|
# or
|
||||||
pcm { } # Slave PCM definition
|
pcm { } # Slave PCM definition
|
||||||
|
format STR # Slave format
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
\endcode
|
\endcode
|
||||||
|
|
|
||||||
|
|
@ -488,6 +488,7 @@ pcm.name {
|
||||||
pcm STR # Slave PCM name
|
pcm STR # Slave PCM name
|
||||||
# or
|
# or
|
||||||
pcm { } # Slave PCM definition
|
pcm { } # Slave PCM definition
|
||||||
|
format STR # Slave format
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
\endcode
|
\endcode
|
||||||
|
|
|
||||||
|
|
@ -488,6 +488,7 @@ pcm.name {
|
||||||
pcm STR # Slave PCM name
|
pcm STR # Slave PCM name
|
||||||
# or
|
# or
|
||||||
pcm { } # Slave PCM definition
|
pcm { } # Slave PCM definition
|
||||||
|
format STR # Slave format
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
\endcode
|
\endcode
|
||||||
|
|
|
||||||
|
|
@ -1428,6 +1428,8 @@ pcm.name {
|
||||||
pcm STR # Slave PCM name
|
pcm STR # Slave PCM name
|
||||||
# or
|
# or
|
||||||
pcm { } # Slave PCM definition
|
pcm { } # Slave PCM definition
|
||||||
|
rate INT # Slave rate
|
||||||
|
[format STR] # Slave format
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
\endcode
|
\endcode
|
||||||
|
|
|
||||||
|
|
@ -1047,6 +1047,13 @@ pcm.name {
|
||||||
pcm STR # Slave PCM name
|
pcm STR # Slave PCM name
|
||||||
# or
|
# or
|
||||||
pcm { } # Slave PCM definition
|
pcm { } # Slave PCM definition
|
||||||
|
[format STR] # Slave format
|
||||||
|
[channels INT] # Slave channels
|
||||||
|
}
|
||||||
|
ttable { # Transfer table (bi-dimensional compound of cchannels * schannels numbers)
|
||||||
|
CCHANNEL {
|
||||||
|
SCHANNEL REAL # route value (0.0 - 1.0)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
\endcode
|
\endcode
|
||||||
|
|
|
||||||
|
|
@ -1515,6 +1515,11 @@ pcm.name {
|
||||||
# or
|
# or
|
||||||
slave { # Slave definition
|
slave { # Slave definition
|
||||||
pcm STR # Slave PCM name
|
pcm STR # Slave PCM name
|
||||||
|
[format STR] # Slave format
|
||||||
|
[channels INT] # Slave channels
|
||||||
|
[rate INT] # Slave rate
|
||||||
|
[period_time INT] # Slave period time in us
|
||||||
|
[buffer_time INT] # Slave buffer time in us
|
||||||
}
|
}
|
||||||
bindings {
|
bindings {
|
||||||
N INT # Slave channel INT for client channel N
|
N INT # Slave channel INT for client channel N
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue