From: Jaroslav Kysela <perex@perex.cz>
Date: Tue, 24 May 2022 12:24:10 +0000 (+0200)
Subject: use-case.h: add Channels/ChannelPos values to the documentation
X-Git-Tag: v1.2.7~3
X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=0ba999591b78e07a4b8e610ebced2c388197e36e;p=alsa-lib.git

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>
---

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