Commit Graph

80 Commits

Author SHA1 Message Date
Julian Bouzas
a8d6d50e2a config: use wireplumber nomenclature for the setting names 2023-04-17 07:48:18 -04:00
Julian Bouzas
a76e780b4b docs: update new configuration file names 2023-04-17 07:47:09 -04:00
Ashok Sidipotu
8e9d852124 docs: configs-refactor changes. 2023-04-17 07:44:19 -04:00
George Kiagiadakis
5cefe9e800 settings: fix doxygen/g-i strings/commands and link them to the sphinx site 2023-04-17 07:44:19 -04:00
Wim Taymans
11733bed4c docs: add new ACP option do docs
Add api.acp.pro-channels to set the number of channels when probing the
Pro Audio profile.
2023-01-31 16:08:24 +01:00
Wim Taymans
6b32ef5e64 docs: add api.acp.probe-rate docs
document the property used to configure the samplerate used when
opening the device for probing.
2023-01-12 09:35:02 +01:00
Supreeeme
6df6e1f392 Mention wpexec in lua docs 2022-12-22 18:13:55 -05:00
Tom A. Wagner
7586d4d858 meson: Add options to configure whether to build daemon, tools and modules.
This adds three meson options to enable or disable building daemon, tools, and modules.

Building the daemon or tools depends on building the modules, and disabling modules without disabling
the other two will result in meson giving an appropriate error.

These new options will let users skip building and installing unneeded items when they are not needed,
e.g. when only using the C API in another application.
2022-11-23 10:06:11 +00:00
Tom A. Wagner
cde0125443 gir: Add pkg-config package name and main header
This adds information about the name of the pkg-config package provided by wireplumber
as well as which header a C program needs to include to use the library to the
generated .gir file.
2022-10-29 12:28:20 +02:00
TestingPlant
254c3284e3 Change LUA to Lua 2022-06-28 05:45:02 +00:00
George Kiagiadakis
1a534f17ed docs: fix WIREPLUMBER_DEBUG examples
See !259
2022-05-19 13:44:32 +03:00
George Kiagiadakis
459e3834da Enable proper syntax highlighting. 2022-05-16 11:01:41 +00:00
jasker5183
6e35daa0d2 Add alsa_monitor.rule example, capitalization, syntax. 2022-05-12 15:36:39 +00:00
Julian Bouzas
5a7dec4385 docs: add placeholder for lua_spa_pod 2022-05-04 16:04:56 -04:00
Julian Bouzas
0bda5ca189 docs: remove deprecated doxygen configuration params 2022-05-04 15:47:08 -04:00
George Kiagiadakis
b216594497 docs: fix sandbox documentation to reflect changes 2022-04-23 20:14:59 +03:00
George Kiagiadakis
17a257ddbe wplua: move under modules/module-lua-scripting
It's unlikely that wplua will ever be useful outside the context
of module-lua-scripting, so let's move it to keep all the code in one place
2022-03-24 09:47:59 +02:00
Julian Bouzas
961771fb93 docs: add WpSpaJson C API Documentation files 2022-02-07 15:29:20 +00:00
George Kiagiadakis
c22fbe9ad0 docs: actually mention correct numbers in the priority.session note 2022-01-19 12:57:34 +02:00
George Kiagiadakis
f84778ff8e docs: add a note about good priority values for nodes
Related to #145
2022-01-19 12:29:12 +02:00
George Kiagiadakis
1c85139640 bump pipewire dep to 0.3.43
we now need it for spa_json_parse_stringn()
2022-01-05 18:13:10 +02:00
George Kiagiadakis
74bac56aed docs: update documented versions of dependencies 2022-01-05 08:28:52 +02:00
George Kiagiadakis
a65f17d6fa docs: update the "running" instructions 2022-01-05 08:28:52 +02:00
George Kiagiadakis
1da5d11317 docs: split up and enrich configuration docs
* Add information about multiple instances
* Document better how the lua config files work
* Document how lua config files get merged from different places
* Copy over additional documentation for ALSA from pw-media-session
* Fix rst syntax issues
2022-01-05 08:28:52 +02:00
Julian Bouzas
7483f3573f docs: update daemon configuration to match new config files
Fixes #68
2021-12-10 07:20:34 -05:00
Peter Hutterer
5ec2138a72 log: support strings as level selectors in WIREPLUMBER_DEBUG
This allows for WIREPLUMBER_DEBUG="D" which avoids users having to
remember which numerical value the various levels have. The strings to
select are the ones printed by the logger, i.e. UECWMIDT.
2021-11-18 12:17:19 +00:00
George Kiagiadakis
c8f75b5f2c docs: lua proxies: add since markers for new methods 2021-08-19 17:58:57 +03:00
George Kiagiadakis
cef9b00daf docs: impl-module: add since markers and improve the Lua doc appearence 2021-08-19 17:58:07 +03:00
George Kiagiadakis
8949e98d1f remove wpipc
This component has been split out to form a separate project,
moved to https://git.automotivelinux.org/src/pipewire-ic-ipc/
2021-08-19 16:53:28 +03:00
Arun Raghavan
129b44bb0c doc: Add WpImplModule docs for the C and Lua API 2021-08-18 16:04:39 +00:00
Peter Hutterer
d38c3fb4cc lib: add functions to search in configuration/data directories
The previous approach to loading config files was to ask WP for the
directory and then search those for the config files. This patch changes the
approach - a caller now asks WP to search for a specific config file or
iterate over a config file directory.

This allows us to implement a directory lookup order, i.e.
"wireplumber.conf" may be in XDG_CONFIG_DIR, /etc/,
/usr/share and the first one found is used.

For configuration directories, the new method iterates over all matching
entries (files + directories) and invokes a callback for each entry.

This enables distributions to ship default files in /usr/share/wireplumber
but have admins and users override them on a local basis. For lua scripts in
particular, overriding a distribution-provided file with an empty file
effectively disables it, adding a file adds it in the right sort order.
2021-07-15 15:17:01 +00:00
Peter Hutterer
2461654017 doc: fix documentation for passing a config file
WIREPLUMBER_CONFIG_FILE support was replaced with the --config-file option
in 1d0ecc3d88
2021-07-15 15:17:01 +00:00
Niklāvs Koļesņikovs
d8365fe33e meson: adds summary() to auto features 2021-07-05 12:30:49 +03:00
George Kiagiadakis
6ef84a1309 docs: document the lua ObjectManager / Interest / Constraint APIs 2021-07-02 20:24:25 +03:00
George Kiagiadakis
888d6e5033 lua: add Port.get_direction() + documentation for it 2021-06-30 19:51:21 +03:00
George Kiagiadakis
532340cc8f docs: mention the new matrix room in the community resources 2021-06-30 19:51:21 +03:00
George Kiagiadakis
068f7f3000 docs: complete lua Node api docs and fix some ref links 2021-06-30 19:51:21 +03:00
George Kiagiadakis
2bd0c1b687 docs: relax doxygen version requirement
1.8.x also works just fine
2021-06-28 17:36:47 +03:00
George Kiagiadakis
48ef823318 meson: avoid source_root(), as it fails when wireplumber is a subproject 2021-06-16 19:44:43 +03:00
George Kiagiadakis
f9767d19a6 lib: add struct paddings to be able to maintain ABI compatibility
Aim for 8 pointers on each struct, wich exceptions:
- 12 pointers for already crowded/important ones
- 4 pointers for empty ones that are used for proxies; we are
  unlikely to add any virtual methods on these classes ever
2021-06-08 17:38:14 +03:00
George Kiagiadakis
72297e0909 docs: set breathe_default_members to get struct members to show up in the docs
Otherwise structs do not have any members shown by default.
This was accidentally removed in an older commit.
2021-06-08 17:14:54 +03:00
George Kiagiadakis
06c0e44609 docs: remove :project: annotations for breathe
there is a breathe_default_project in conf.py.in that sets this
2021-06-08 17:12:26 +03:00
Jason Francis
d9cd0e4fdf docs: Write gtk-doc comments for constant variables 2021-06-02 17:38:34 +00:00
Jason Francis
1b5df6096a docs: include wp.h in gir sources 2021-06-02 17:38:34 +00:00
George Kiagiadakis
9db0e741cd lua: allow the Log api to debug boxed objects (useful for pods) 2021-06-02 19:38:51 +03:00
George Kiagiadakis
132de309cb lua: fix PipewireObject api: s/set_params/set_param/ and cleanup 2021-06-02 19:38:51 +03:00
George Kiagiadakis
ec7541e840 docs: make progress on lua api documentation 2021-05-28 19:22:56 +03:00
George Kiagiadakis
f038666399 meson: add reference to bugfix
so that we can safely remove our hack in the future, when we
will be able to depend on the next version of meson
2021-05-28 17:42:16 +03:00
George Kiagiadakis
bfbe97c8b3 meson: force the gir target to depend on wp-gtkdoc.h
With a hacky workaround, because the generate_gir() implementation
has a bug and does not pass the file dependencies properly down
to the custom_target() that it creates internally
2021-05-26 21:22:24 +03:00
George Kiagiadakis
5d7cdfabec docs: tidy up most documents and try to update the information in them
- use code blocks properly
- use note/important blocks
- stop using ` for emphasis, use `` or * appropriately
- update info on contributing, community, running, logging
2021-05-26 19:20:05 +03:00