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 01f69a2eb0244ddcd7fec1d05f71e8ec168405d3..04185e2b08203fbafb47f8d3e9f91f326006f973 100644 (file)
--- 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