nixos/pipewire: add docs for passthru.requiredLv2Packages

This commit is contained in:
Hans Christian Schmitz 2024-02-29 10:15:06 +01:00
parent b97450b007
commit 3f86bd950c
No known key found for this signature in database
GPG key ID: 1D729DE4757DE669
2 changed files with 10 additions and 2 deletions

View file

@ -246,6 +246,9 @@ in {
description = lib.mdDoc ''
List of packages that provide PipeWire configuration, in the form of
`share/pipewire/*/*.conf` files.
LV2 dependencies will be picked up from config packages automatically
via `passthru.requiredLv2Packages`.
'';
};
@ -258,7 +261,8 @@ in {
be made available to PipeWire for [filter chains][wiki-filter-chain].
Config packages have their required LV2 plugins added automatically,
so they don't need to be specified here.
so they don't need to be specified here. Config packages need to set
`passthru.requiredLv2Packages` for this to work.
[wiki-filter-chain]: https://docs.pipewire.org/page_module_filter_chain.html
'';

View file

@ -30,6 +30,9 @@ in
description = lib.mdDoc ''
List of packages that provide WirePlumber configuration, in the form of
`share/wireplumber/*/*.lua` files.
LV2 dependencies will be picked up from config packages automatically
via `passthru.requiredLv2Packages`.
'';
};
@ -42,7 +45,8 @@ in
be made available to WirePlumber for [filter chains][wiki-filter-chain].
Config packages have their required LV2 plugins added automatically,
so they don't need to be specified here.
so they don't need to be specified here. Config packages need to set
`passthru.requiredLv2Packages` for this to work.
[wiki-filter-chain]: https://docs.pipewire.org/page_module_filter_chain.html
'';