pipewire: deprecate pw_stream_connect target_id in documentation

This commit is contained in:
Pauli Virtanen 2022-07-11 15:28:52 +03:00
parent ca87d40448
commit a56435c4dc

View file

@ -436,9 +436,16 @@ int pw_stream_update_properties(struct pw_stream *stream, const struct spa_dict
int int
pw_stream_connect(struct pw_stream *stream, /**< a \ref pw_stream */ pw_stream_connect(struct pw_stream *stream, /**< a \ref pw_stream */
enum pw_direction direction, /**< the stream direction */ enum pw_direction direction, /**< the stream direction */
uint32_t target_id, /**< the target object id to connect to or uint32_t target_id, /**< should have the value PW_ID_ANY.
* PW_ID_ANY to let the manager * To select a specific target
* select a target. */ * node, specify the
* PW_KEY_OBJECT_SERIAL or the
* PW_KEY_NODE_NAME value of the target
* node in the PW_KEY_TARGET_OBJECT
* property of the stream.
* Specifying target nodes by
* their id is deprecated.
*/
enum pw_stream_flags flags, /**< stream flags */ enum pw_stream_flags flags, /**< stream flags */
const struct spa_pod **params, /**< an array with params. The params const struct spa_pod **params, /**< an array with params. The params
* should ideally contain supported * should ideally contain supported