From: Jaroslav Kysela <perex@perex.cz>
Date: Fri, 3 Apr 2020 16:00:43 +0000 (+0200)
Subject: usecase: allow indexes also for modifier names
X-Git-Tag: v1.2.3~82
X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=341326c21ededb8c768c43ec2c9c7a80e7a26d35;p=alsa-lib.git

usecase: allow indexes also for modifier names

Signed-off-by: Jaroslav Kysela <perex@perex.cz>
---

diff --git a/include/use-case.h b/include/use-case.h
index 27cb3fe1..c2ba79a9 100644
--- a/include/use-case.h
+++ b/include/use-case.h
@@ -120,7 +120,7 @@ extern "C" {
  * allowed. The names with numbers must be continuous. It is allowed to put
  * a whitespace between name and index (like 'Line 1') for the better
  * readability. The device names 'Line 1' and 'Line1' are equal for
- * thus purpose.
+ * this purpose.
  *
  * If EnableSequence/DisableSequence controls independent paths in the hardware
  * it is also recommended to split playback and capture UCM devices and use
@@ -149,6 +149,13 @@ extern "C" {
  * The use case modifier allows runtime configuration changes to deal with
  * asynchronous events.
  *
+ * If multiple modifiers with the same name exists, the number suffixes should
+ * be added to these names like 'Echo Reference 1','Echo Reference 2' etc.
+ * No number gaps are allowed. The names with numbers must be continuous.
+ * It is allowed to put a whitespace between name and index for the better
+ * readability. The modifier names 'Something 1' and 'Something1' are equal
+ * for this purpose.
+ *
  * e.g. to record a voice call :-
  *  1. Set verb to SND_USE_CASE_VERB_VOICECALL (for voice call)
  *  2. Set modifier SND_USE_CASE_MOD_CAPTURE_VOICE when capture required.