173 commits

Author	SHA1	Message	Date
Guido Günther	d2a49e8bc5	docs/linking: Fix typo ... Signed-off-by: Guido Günther <agx@sigxcpu.org>	2025-10-25 16:12:01 +03:00
Guido Günther	b2c4993ab5	doc: Fix role based policy name ... The role-priority-system doesn't exist anymore Fixes: 0d995c56 ("wireplumber.conf: improve standard policy definition") Signed-off-by: Guido Günther <agx@sigxcpu.org>	2025-10-25 16:12:01 +03:00
George Kiagiadakis	df0136ce0b	docs: improve copyright & author statements	2025-09-05 18:19:25 +03:00
George Kiagiadakis	a5e58536dd	docs: add wpctl man page and Tools documentation section ... Add comprehensive wpctl documentation that generates both HTML docs and an installable man page from a single RST source. Closes: #825 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>	2025-09-05 18:15:08 +03:00
Pauli Virtanen	fb218fe016	scripts: add mpris-pause.lua to pause media streams when target removed ... When current output target of a media player application is removed, it can be useful if playback is paused (to avoid e.g. music playback to going to speakers when headset is accidentally unplugged). Android etc. implement a policy like this. Add a policy script that monitors stream target removals. When it detects a media player application that is linked to a no longer present output target, it checks whether the stream is associated with a media player seen in MPRIS. If yes, it sends MPRIS Pause() command to the media player. Enable this policy by default.	2025-07-23 10:19:44 +03:00
Philipp Jungkamp	404a634b92	docs: fix wrong description of software_dsp example	2025-05-18 15:49:59 +03:00
David Mandelberg	a2605a2cdf	Change node.dont-remix to stream.dont-remix ... I'm guessing this was a typo? I ran `git grep dont-remix` in both wireplumber's and pipewire's repos, and all the other references were to stream.dont-remix, including the definition of PW_KEY_STREAM_DONT_REMIX.	2025-04-07 17:28:15 +00:00
George Kiagiadakis	ff692952c4	docs: software_dsp: fix example config snippet ... The wireplumber.profiles section is an object, not an array	2025-03-05 17:50:43 +02:00
Hugo	d222b957af	Improve documentation for lua scripts ... I had a hard time figuring out all the steps relevant for this to work. Hopefully this brief summary and couple of links will help the next person writing their own script. See: #601	2025-02-24 06:48:40 +00:00
luzpaz	cb770c1d7e	docs: fix various codebase typos Found via codespell -q 3 -S "*.po,./po/*,NEWS.rst" -L bootup,gir,inout	2025-01-28 15:45:54 +01:00
George Kiagiadakis	e7dc79859d	docs: document multi-instance configuration profiles	2024-09-05 20:12:03 +03:00
Robert Rosengren	ec8975ac6a	docs: clarified how to setup debug logs in lua	2024-09-05 10:52:28 +00:00
George Kiagiadakis	773fee315a	docs: add info on how to set the log level via configuration	2024-07-09 08:59:18 +03:00
Barnabás Pőcze	7e21e27ca9	docs: gen-api-gtkdoc.py: fix SyntaxWarning with raw strings ... Use raw strings for regex patterns to avoid the invalid escape sequence `SyntaxWarning`.	2024-05-31 22:54:13 +02:00
George Kiagiadakis	0b51b6b570	gi: hide WP_PRIVATE_API functions from gir ... Document them and annotate them with (skip) so that they are marked as introspectable=0 in the gir file. Fixes: #599	2024-05-31 21:00:07 +03:00
James Calligeros	4c57647203	docs: document filter-path property of software DSP policy ... Signed-off-by: James Calligeros <jcalligeros99@gmail.com>	2024-04-17 18:31:09 +10:00
George Kiagiadakis	1fddefa072	docs: move the software_dsp document down in the TOC ... This is one of the least likely things that a user would want to discover and use, making it wierd to be the very first "policy" to present.	2024-03-30 15:52:14 +02:00
George Kiagiadakis	ab18cb1848	docs: improve the wording and formatting of the software_dsp doc	2024-03-30 15:44:38 +02:00
James Calligeros	b45eafa53c	docs: Document automatic software DSP handling ... Signed-off-by: James Calligeros <jcalligeros99@gmail.com>	2024-03-30 00:00:52 +10:00
George Kiagiadakis	3043d258b3	docs: remove main.rst ... This is out-of-date and wrong. I wanted to salvage the virtual-items configuration docs from in there, but we are going to change that soon - see https://gitlab.freedesktop.org/pipewire/wireplumber/-/issues/610 - so the entire file can go away.	2024-03-23 17:14:01 +02:00
George Kiagiadakis	04a248f4d1	docs: conf_file: raise more the visibility of the config break	2024-03-23 17:09:09 +02:00
George Kiagiadakis	e6dc547624	docs/daemon: re-arrange some sections in the toctree to make more sense	2024-03-23 17:05:49 +02:00
George Kiagiadakis	ccfc501e82	docs: move well-known settings docs from src/scripts/lib to where they belong ... These were documented in src/scripts/lib initially because the settings-manager scripts used to be also there and it made sense to keep them close together.	2024-03-23 16:49:13 +02:00
George Kiagiadakis	c4d4cd48f6	docs: add a basic "config migration from 0.4" guide	2024-03-23 16:45:32 +02:00
George Kiagiadakis	a562b22f60	docs: fix typo in {device,node}.disabled documentation ... Fixes: #609	2024-03-23 12:00:55 +02:00
George Kiagiadakis	8a893bdaf0	docs: add document on how to modify the configuration ... Including information about the rules syntax. Fixes: #595	2024-03-18 13:57:26 +02:00
George Kiagiadakis	59183e938a	docs: update access configuration doc	2024-03-18 13:57:26 +02:00
George Kiagiadakis	0649ba9aa6	docs: remove "policy" configuration doc page ... This is all part of the well-known settings now	2024-03-18 13:57:26 +02:00
George Kiagiadakis	7b918060c4	docs: improve bluetooth documentation and example config file	2024-03-18 13:57:26 +02:00
George Kiagiadakis	e0192789e9	docs: configuration: update docs on "settings" after the latest changes	2024-03-13 18:11:49 +02:00
George Kiagiadakis	857cee10cf	docs: conf_file: small updates	2024-03-12 16:39:44 +02:00
George Kiagiadakis	1ebed7804c	docs: installing: update dependency versions	2024-03-12 16:35:14 +02:00
Ashok Sidipotu	08ae195cdb	config: add {device|node}.disable	2024-03-11 07:19:27 +00:00
George Kiagiadakis	f24edf67fa	docs: update the documentation around file search locations	2024-03-07 19:58:52 +02:00
George Kiagiadakis	14daab576b	docs: add base-dirs in the generated C API documentation	2024-03-04 07:07:56 +00:00
Julian Bouzas	db21eb5dec	docs: fix documentation for WpMetadataItem	2024-03-04 06:33:04 +00:00
Julian Bouzas	424a8e5263	settings: add API to set, reset, save, delete and iterate settings ... Also improves and refactor the settings unit test to test all the new API added.	2024-02-28 10:20:20 -05:00
Julian Bouzas	a23248847a	metadata: remove wp_metadata_iterator_item_extract() API ... Similar to WpPropertiesItem, this implements a new WpMetadataItem type that is returned when iterating metadata	2024-02-28 08:15:17 -05:00
George Kiagiadakis	4dc7317010	docs: update ALSA documentation	2024-02-14 15:58:19 +02:00
Julian Bouzas	1d2fe9b62d	module-settings: remove 'settings.persistent' option ... This patch removes the 'settings.persistent' option from the configuration as it only allowed making settings persistent globally instead of individually. This issue has been addressed in a simpler way by creating a 'persistent-sm-settings' metadata. If a user wants to make a setting persistent, he can change the 'persistent-sm-settings' metadata object, if the user does not want to make a persistent change, he can use the 'sm-settings' metadata object. Any changes in the 'persistent-sm-settings' metadata will be also reflected in the 'sm-settings' metadata object.	2024-02-02 14:02:49 -05:00
Julian Bouzas	b3a71e3f1c	linking: rename props to 'node.dont-fallback', 'node.dont-move' and 'node.linger' ... This makes those properties more consistent with 'node.dont-reconnect'.	2024-02-02 11:15:31 +00:00
Julian Bouzas	1c46115433	docs: add linking documentation	2024-02-02 11:15:31 +00:00
George Kiagiadakis	32f86e38ad	docs: improve smart filters documentation	2024-01-31 16:12:17 +02:00
George Kiagiadakis	2fcd24b2d3	docs: move smart filters documentation to the policies section	2024-01-30 12:13:16 +02:00
George Kiagiadakis	052ca9b4a7	docs: add policies section	2024-01-30 12:07:25 +02:00
George Kiagiadakis	58b58b4b48	docs: reorder menu items under "Configuration" section ... Also remove "main.rst", which is to be removed entirely as a file (but only after its contents are all moved to other files).	2024-01-29 11:55:18 +02:00
George Kiagiadakis	ef24f35ff8	docs: rename settings section and add link back to the config option types	2024-01-29 11:55:18 +02:00
George Kiagiadakis	e19839dfce	docs: add link from the well-known features section back to components & profiles	2024-01-29 11:55:18 +02:00
George Kiagiadakis	d5926b08e0	docs: add info about the different configuration option types	2024-01-29 11:55:18 +02:00
George Kiagiadakis	4c94cee54c	docs: update multi-instance documentation	2024-01-29 11:55:18 +02:00