summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorTanu Kaskinen <tanu.kaskinen@linux.intel.com>2014-06-26 13:30:25 +0300
committerTakashi Iwai <tiwai@suse.de>2014-06-27 14:22:28 +0200
commit7a748af4db17cb0b26d19e5f9939d277128ec94b (patch)
treeb00963cd03e0e98c4fe9b7ac218102c87da0ae24 /include
parentc2f8ef7ab0c9c6daaab77191238f57b2ca49341e (diff)
ucm: Document PlaybackPCMIsDummy and CapturePCMIsDummy values
At least PulseAudio needs special handling for dummy devices. To allow that to happen automatically, the UCM configuration should contain the information about which PCMs are dummy. Signed-off-by: Tanu Kaskinen <tanu.kaskinen@linux.intel.com> Acked-by: Liam Girdwood <liam.r.girdwood@linux.intel.com> Signed-off-by: Takashi Iwai <tiwai@suse.de>
Diffstat (limited to 'include')
-rw-r--r--include/use-case.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/include/use-case.h b/include/use-case.h
index 4e132491..f30168f8 100644
--- a/include/use-case.h
+++ b/include/use-case.h
@@ -258,7 +258,17 @@ int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr,
* Recommended names for values:
* TQ - Tone Quality
* PlaybackPCM - full PCM playback device name
+ * PlaybackPCMIsDummy - Valid values: "yes" and "no". If set to "yes", the
+ * PCM named by the PlaybackPCM value is a dummy device,
+ * meaning that opening it enables an audio path in the
+ * hardware, but writing to the PCM device has no
+ * effect.
* CapturePCM - full PCM capture device name
+ * CapturePCMIsDummy - Valid values: "yes" and "no". If set to "yes", the
+ * PCM named by the CapturePCM value is a dummy device,
+ * meaning that opening it enables an audio path in the
+ * hardware, but reading from the PCM device has no
+ * effect.
* PlaybackRate - playback device sample rate
* PlaybackChannels - playback device channel count
* PlaybackCTL - playback control device name