summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJaroslav Kysela <perex@perex.cz>2022-05-24 14:24:10 +0200
committerJaroslav Kysela <perex@perex.cz>2022-05-24 14:42:44 +0200
commit0ba999591b78e07a4b8e610ebced2c388197e36e (patch)
treed791940c1ad508edbcc93473819567eac6a21d62
parent7474518a96bbfad284f68b9267470f4252fa3f78 (diff)
downloadalsa-lib-0ba999591b78e07a4b8e610ebced2c388197e36e.tar.gz
use-case.h: add Channels/ChannelPos values to the documentation
We have use cases, where the channel split is required. We can use alsa-lib plugins for this job, but some sound servers or applications may want to do the split themselves. Signed-off-by: Jaroslav Kysela <perex@perex.cz>
-rw-r--r--include/use-case.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/include/use-case.h b/include/use-case.h
index 01f69a2e..04185e2b 100644
--- a/include/use-case.h
+++ b/include/use-case.h
@@ -315,6 +315,12 @@ int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr,
* - playback device sample rate
* - PlaybackChannels
* - playback device channel count
+ * - PlaybackChannel#
+ * - describe index of the logical channel in the PCM stream
+ * - e.g. "PlaybackChannel0 2" - logical channel 0 is third channel in the PCM stream
+ * - PlaybackChannelPos#
+ * - describe sound position of the logical channel (ALSA chmap names)
+ * - e.g. "PlaybackChannel0 FR" - logical channel 0 is at front left
* - PlaybackCTL
* - playback control device name
* - PlaybackVolume
@@ -329,6 +335,12 @@ int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr,
* - capture device sample rate
* - CaptureChannels
* - capture device channel count
+ * - CaptureChannel#
+ * - describe index of the logical channel in the PCM stream
+ * - e.g. "CaptureChannel0 2" - logical channel 0 is third channel in the PCM stream
+ * - CaptureChannelPos#
+ * - describe sound position of the logical channel (ALSA chmap names)
+ * - e.g. "CaptureChannel0 FR" - logical channel 0 is at front left
* - CaptureCTL
* - capture control device name
* - CaptureVolume