keys: add follow-suspend passive mode to keys docs

Add the missing follow-suspend values for the passive modes.

Make the string to passive mode conversion a bit more explicit about
true and false.
This commit is contained in:
Wim Taymans 2026-06-12 11:59:36 +02:00
parent cf72a5945b
commit d7f32af545
2 changed files with 9 additions and 4 deletions

View file

@ -214,8 +214,10 @@ extern "C" {
* object */ * object */
#define PW_KEY_NODE_PASSIVE "node.passive" /**< indicate that a node wants passive links #define PW_KEY_NODE_PASSIVE "node.passive" /**< indicate that a node wants passive links
* on output/input/all ports. A ','-separated * on output/input/all ports. A ','-separated
* array of values "out"/"out-follow"/"in"/ * array of values "out"/"out-follow"/
* "in-follow"/"true"/"follow" is accepted. */ * "out-follow-suspend"/"in"/"in-follow"/
* "in-follow-suspend"/"true"/"follow"/
* "follow-suspend" is accepted. */
#define PW_KEY_NODE_LINK_GROUP "node.link-group" /**< the node is internally linked to #define PW_KEY_NODE_LINK_GROUP "node.link-group" /**< the node is internally linked to
* nodes with the same link-group. Can be an * nodes with the same link-group. Can be an
* array of group names. */ * array of group names. */
@ -250,7 +252,8 @@ extern "C" {
#define PW_KEY_PORT_EXTRA "port.extra" /**< api specific extra port info, API name #define PW_KEY_PORT_EXTRA "port.extra" /**< api specific extra port info, API name
* should be prefixed. "jack:flags:56" */ * should be prefixed. "jack:flags:56" */
#define PW_KEY_PORT_PASSIVE "port.passive" /**< the ports wants passive links. Values #define PW_KEY_PORT_PASSIVE "port.passive" /**< the ports wants passive links. Values
* can be "true" or "follow". Since 0.3.67 */ * can be "true"/"follow"/"follow-suspend".
* Since 0.3.67 */
#define PW_KEY_PORT_IGNORE_LATENCY "port.ignore-latency" /**< latency ignored by peers, since 0.3.71 */ #define PW_KEY_PORT_IGNORE_LATENCY "port.ignore-latency" /**< latency ignored by peers, since 0.3.71 */
#define PW_KEY_PORT_GROUP "port.group" /**< the port group of the port 1.2.0 */ #define PW_KEY_PORT_GROUP "port.group" /**< the port group of the port 1.2.0 */
#define PW_KEY_PORT_EXCLUSIVE "port.exclusive" /**< link port only once 1.6.0 */ #define PW_KEY_PORT_EXCLUSIVE "port.exclusive" /**< link port only once 1.6.0 */

View file

@ -1011,7 +1011,9 @@ static inline uint32_t passive_mode_from_string(const char *str)
return PASSIVE_MODE_FOLLOW; return PASSIVE_MODE_FOLLOW;
else if (spa_streq(str, "follow-suspend")) else if (spa_streq(str, "follow-suspend"))
return PASSIVE_MODE_FOLLOW_SUSPEND; return PASSIVE_MODE_FOLLOW_SUSPEND;
return spa_atob(str); else if (spa_atob(str))
return PASSIVE_MODE_TRUE;
return PASSIVE_MODE_FALSE;
} }
struct pw_control_link { struct pw_control_link {