]> git.alsa-project.org Git - alsa-lib.git/commitdiff
ucm: docs - add JackCTL, rearrange JackControl and JackDev
authorJaroslav Kysela <perex@perex.cz>
Tue, 3 Dec 2019 14:01:04 +0000 (15:01 +0100)
committerJaroslav Kysela <perex@perex.cz>
Tue, 3 Dec 2019 14:01:04 +0000 (15:01 +0100)
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
include/use-case.h

index 71fcc949a11783baf3b25723fc47f1f9520bab2b..25998cb9bad5c2efbddf5ce0cc7b582a3a8cecbd 100644 (file)
@@ -338,14 +338,20 @@ int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr,
  *      - Valid values: "soft" (software attenuation)
  *   - EDIDFile
  *      - Path to EDID file for HDMI devices
- *   - JackControl, JackDev
- *      - Jack information for a device. The jack status can be reported via
- *        a kcontrol and/or via an input device. **JackControl** is the
- *        kcontrol name of the jack, and **JackDev** is the input device id of
- *        the jack (if the full input device path is /dev/input/by-id/foo, the
- *        JackDev value should be "foo"). UCM configuration files should
- *        contain both JackControl and JackDev when possible, because
- *        applications are likely to support only one or the other.
+ *   - JackCTL
+ *      - jack control device name
+ *   - JackControl
+ *      - jack control identificator
+ *      - can be parsed using snd_use_case_parse_ctl_elem_id()
+ *      - UCM configuration files should contain both JackControl and JackDev
+ *        when possible, because applications are likely to support only one
+ *        or the other
+ *   - JackDev
+ *      - the input device id of the jack (if the full input device path is
+ *        /dev/input/by-id/foo, the JackDev value should be "foo")
+ *      - UCM configuration files should contain both JackControl and JackDev
+ *        when possible, because applications are likely to support only one
+ *        or the other
  *   - JackHWMute
  *       If this value is set, it indicates that when the jack is plugged
  *       in, the hardware automatically mutes some other device(s). The