WirePlumber

https://pipewire.pages.freedesktop.org/wireplumber/
Admin
WirePlumber is a modular session and policy manager for PipeWire that provides a GObject-based...
Tokens:284,037
Snippets:2,519
Trust Score:7.9
Update:17 hours ago
Show doc for...
Tokens:
Raw
### Installation directory for example fragments

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/configuration/example_fragments.html

Shows where the ready-made, fully commented configuration fragments are installed. Distributions may ship them in a separate package such as wireplumber-doc.

```text
$PREFIX/share/doc/wireplumber/examples/wireplumber.conf.d/
```

--------------------------------

### Meson setup basic syntax

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/installing.html

Shows the basic syntax for configuring the WirePlumber build with meson setup. Replace [--prefix=/path], [...options...], [build directory], and [source directory] with your values.

```bash
meson setup [--prefix=/path] [...options...] [build directory] [source directory]
```

--------------------------------

### Enable and start WirePlumber service

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/getting_started.html

Enable and start the WirePlumber user service if it is not running.

```bash
$ systemctl --user --now enable wireplumber
```

--------------------------------

### Show runtime WirePlumber settings with wpctl

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/getting_started.html

Display and change many options at runtime without editing any file.

```bash
$ wpctl settings
```

--------------------------------

### Create a WirePlumber configuration fragment

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/getting_started.html

Create a user configuration directory and open a fragment file to override settings without editing the shipped configuration.

```bash
$ mkdir -p ~/.config/wireplumber/wireplumber.conf.d
$ $EDITOR ~/.config/wireplumber/wireplumber.conf.d/50-my-config.conf
```

--------------------------------

### Run wpctl status under gdb using wp-uninstalled.sh wrapper

Source: https://pipewire.pages.freedesktop.org/wireplumber/resources/contributing.html

Shows how to use wp-uninstalled.sh directly as a wrapper to set up the environment and then execute any command, here running wpctl status under gdb.

```shell
$ ./wp-uninstalled.sh gdb --args wpctl status
```

--------------------------------

### Copy and edit an example fragment (alsa.conf)

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/configuration/example_fragments.html

Commands to copy an example fragment into your own configuration directory and open it for editing. Everything in the fragment is commented out, so copying it as-is changes nothing; uncomment options one at a time.

```bash
$ mkdir -p ~/.config/wireplumber/wireplumber.conf.d
$ cp /usr/share/doc/wireplumber/examples/wireplumber.conf.d/alsa.conf \
     ~/.config/wireplumber/wireplumber.conf.d/
$ $EDITOR ~/.config/wireplumber/wireplumber.conf.d/alsa.conf
```

--------------------------------

### Get WirePlumber logs with journalctl

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/getting_started.html

View the WirePlumber daemon logs from the user journal.

```bash
$ journalctl --user -u wireplumber
```

--------------------------------

### Run WirePlumber with debug logging

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/getting_started.html

Run WirePlumber with the WIREPLUMBER_DEBUG environment variable to select topics and set the log level for a single run.

```bash
$ WIREPLUMBER_DEBUG=s-linking:D wireplumber
```

--------------------------------

### Show WirePlumber graph status with wpctl

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/getting_started.html

Display an overview of devices, sinks, sources, and streams managed by WirePlumber, each with an id used by other commands.

```bash
$ wpctl status
```

--------------------------------

### Install WirePlumber with ninja

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/installing.html

Installs the built WirePlumber using the ninja install target.

```bash
$ ninja -C build install
```

--------------------------------

### Run node-extra-params.c C example

Source: https://pipewire.pages.freedesktop.org/wireplumber/resources/testing.html

Runs the C example that demonstrates setting additional node properties in the special params field of Props. It is built as part of the normal build.

```shell
$ ./wp-uninstalled.sh ./build/tests/examples/node-extra-params
```

--------------------------------

### Start WirePlumber with a custom profile using --profile

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/multi_instance.html

Use the --profile command line option to load a specific profile when starting WirePlumber. If no profile is specified, the main profile is loaded by default.

```bash
$ wireplumber --profile=custom
```

--------------------------------

### Control devices with wpctl commands

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/getting_started.html

Change volume, toggle mute, set default device, and inspect objects using wpctl. The ids come from 'wpctl status'.

```bash
# change the volume of the default sink
$ wpctl set-volume @DEFAULT_SINK@ 50%

# mute and unmute it
$ wpctl set-mute @DEFAULT_SINK@ toggle

# make a different device the default
$ wpctl set-default 47

# look at everything WirePlumber knows about an object
$ wpctl inspect 47
```

--------------------------------

### Start JACK D-Bus server manually

Source: https://pipewire.pages.freedesktop.org/wireplumber/resources/testing.html

Start the JACK D-Bus server manually as an alternative to using qjackctl. Run jackdbus auto, then use qdbus to start the server. This is part of testing device reservation with JACK.

```bash
$ jackdbus auto
$ qdbus org.jackaudio.service /org/jackaudio/Controller org.jackaudio.JackControl.StartServer
```

--------------------------------

### Run get-default-sink-volume.lua example

Source: https://pipewire.pages.freedesktop.org/wireplumber/resources/testing.html

Executes the Lua example that prints the default sink volume, demonstrating Core.require_api() with the default-nodes and mixer plugins. Run from the top-level directory with wp-uninstalled.sh.

```shell
$ ./wp-uninstalled.sh wpexec tests/examples/get-default-sink-volume.lua
```

--------------------------------

### AsyncEventHook example with steps, start, register, and transition:advance

Source: https://pipewire.pages.freedesktop.org/wireplumber/scripting/lua_api/lua_events_api.html

Constructs an asynchronous event hook using AsyncEventHook. The 'steps' table defines a state machine starting at 'start' and following 'next' links until 'none'. Each step's execute function must call 'transition:advance ()' to proceed, or 'transition:return_error (message)' to abort. Register the hook with ':register ()'.

```lua
AsyncEventHook {
  name = "node/create-item",
  interests = {
    EventInterest {
      Constraint { "event.type", "=", "node-added" },
    },
  },
  steps = {
    start = {
      next = "register",
      execute = function (event, transition)
        local node = event:get_subject ()
        -- ... create and configure the item ...
        transition:advance ()
      end
    },
    register = {
      next = "none",
      execute = function (event, transition)
        -- ... register the item ...
        transition:advance ()
      end
    },
  },
}:register ()
```

--------------------------------

### Run interactive.lua example with arguments

Source: https://pipewire.pages.freedesktop.org/wireplumber/resources/testing.html

Runs the interactive Lua example, which demonstrates how arguments are passed to a script. It accepts a JSON object as its second argument.

```shell
$ ./wp-uninstalled.sh wpexec tests/examples/interactive.lua \
      '{ option1 = "value1" }'
```

--------------------------------

### Run a script from a build tree without installing

Source: https://pipewire.pages.freedesktop.org/wireplumber/man/wpexec.html

Uses the wp-uninstalled.sh helper to run wpexec from a build tree, avoiding the need to install WirePlumber first.

```bash
$ ./wp-uninstalled.sh wpexec tests/examples/interactive.lua
```

--------------------------------

### SPA-JSON common syntax example

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/configuration/conf_file.html

Shows the most common SPA-JSON syntax: unquoted keys and values, '=' separators, and comments starting with '#'. This is a valid configuration file format.

```spa-json
# This is the most common syntax
section1 = {
  string-key = value1
  number-key = 123
  boolean-key = true
}
section2 = [
  val1, val2, val3
]
```

--------------------------------

### Start a PulseAudio client with gst-launch-1.0

Source: https://pipewire.pages.freedesktop.org/wireplumber/resources/testing.html

Start a PulseAudio client while PulseAudio is running. This is the first step in testing device reservation with PulseAudio. The device in use by PA will not be available in PipeWire until the PA client stops.

```bash
$ gst-launch-1.0 audiotestsrc ! pulsesink
```

--------------------------------

### Uninstall WirePlumber with ninja

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/installing.html

Reverts the installation using the ninja uninstall target.

```bash
$ ninja -C build uninstall
```

--------------------------------

### Equivalent logical expression for the example rule

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/configuration/modifying_configuration.html

Shows the logical equivalent of the example rule: `(object.name == "my_object" and object.profile.name == "my_profile") or (object.name == "other_object")` triggers `object.tag = "matched_by_my_rule"`.

```python
if (properties["object.name"] == "my_object" and properties["object.profile.name"] == "my_profile") or (properties["object.name"] == "other_object"):
     properties["object.tag"] = "matched_by_my_rule"
```

--------------------------------

### wp_spa_log_get_instance

Source: https://pipewire.pages.freedesktop.org/wireplumber/library/c_api/log_api.html

Gets WirePlumber's instance of spa_log, which can be used to redirect PipeWire's log messages to the currently installed GLogWriterFunc. This is installed automatically when you call wp_init() with WP_INIT_SET_PW_LOG set in the flags.

```APIDOC
## wp_spa_log_get_instance

### Description
Gets WirePlumber's instance of spa_log, which can be used to redirect PipeWire's log messages to the currently installed GLogWriterFunc. This is installed automatically when you call wp_init() with WP_INIT_SET_PW_LOG set in the flags.

### Function Signature
struct spa_log *wp_spa_log_get_instance(void)

### Returns
WirePlumber's instance of spa_log.
```

--------------------------------

### Check WirePlumber service status with systemctl

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/getting_started.html

Check whether the WirePlumber daemon is running on a systemd-based system.

```bash
$ systemctl --user status wireplumber
```

--------------------------------

### Set WirePlumber log level at runtime

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/getting_started.html

Raise the log level to D (debug) for the current session using wpctl.

```bash
$ wpctl set-log-level D
```

--------------------------------

### context.modules loading example

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/configuration/conf_file.html

Loads the PipeWire adapter and metadata modules. The metadata module is ignored if not found due to its ifexists flag.

```conf
context.modules = [
  { name = libpipewire-module-adapter }
  {
    name = libpipewire-module-metadata,
    flags = [ ifexists ]
  }
]
```

--------------------------------

### SpaDevice constructor example

Source: https://pipewire.pages.freedesktop.org/wireplumber/scripting/lua_api/lua_spa_device_api.html

Creates a SpaDevice from a SPA factory, connects to the 'create-object' and 'object-removed' signals, and activates it. Connect to signals before activating to avoid missing startup objects. Returns nil if the factory could not be loaded.

```lua
local device = SpaDevice("api.alsa.enum.udev", properties)
if device then
  device:connect("create-object", createDevice)
  device:connect("object-removed", removeDevice)
  device:activate(Feature.SpaDevice.ENABLED)
end
```

--------------------------------

### Configure and compile WirePlumber

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/installing.html

Configures the build with a prefix of /usr in the 'build' directory and compiles it. Run these commands from the source tree.

```bash
$ meson setup --prefix=/usr build
$ meson compile -C build
```

--------------------------------

### context.spa-libs mapping example

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/configuration/conf_file.html

Maps SPA factory name regular expressions to library names. The default configuration already includes well-known mappings; add entries only for custom SPA plugins.

```conf
context.spa-libs = {
  api.alsa.*      = alsa/libspa-alsa
  audio.convert.* = audioconvert/libspa-audioconvert
}
```

--------------------------------

### Get attached permission manager with Client.get_permission_manager

Source: https://pipewire.pages.freedesktop.org/wireplumber/scripting/lua_api/lua_proxies_api.html

Retrieves the permission manager attached to a client, returning nil if none is attached. The example checks the manager and accesses its default permissions.

```lua
local pm = client:get_permission_manager()
if pm then
  local perms = pm:get_default_permissions()
  -- check permission bits
end
```

--------------------------------

### Show all WirePlumber settings with wpctl settings

Source: https://pipewire.pages.freedesktop.org/wireplumber/man/wpctl.html

Displays all current WirePlumber settings. Use without arguments to view the full configuration.

```bash
wpctl settings
```

--------------------------------

### Run qjackctl with pw-jack

Source: https://pipewire.pages.freedesktop.org/wireplumber/resources/testing.html

Launch qjackctl under the PipeWire JACK compatibility layer. The Graph window should show the PipeWire graph and connections should work correctly.

```bash
$ pw-jack qjackctl
```

--------------------------------

### WP_DEFINE_LOCAL_LOG_TOPIC usage example

Source: https://pipewire.pages.freedesktop.org/wireplumber/library/c_api/log_api.html

Shown as a recommended practice to start every WirePlumber source file with a local log topic definition. The macro defines a static WpLogTopic* variable named WP_LOCAL_LOG_TOPIC that is automatically initialized when first used.

```c
WP_DEFINE_LOCAL_LOG_TOPIC ("some-topic")
```

--------------------------------

### List all audio sinks with wpctl list

Source: https://pipewire.pages.freedesktop.org/wireplumber/man/wpctl.html

Lists all audio sink nodes. Use 'audio sinks' as the object type.

```bash
wpctl list audio sinks
```

--------------------------------

### Run WirePlumber daemon under strace using make run DBG variable

Source: https://pipewire.pages.freedesktop.org/wireplumber/resources/contributing.html

Shows how to run the WirePlumber daemon under any wrapper program by setting the DBG variable on the make run target. Replace 'strace' with any other wrapper command.

```shell
$ make run DBG="strace"
```

--------------------------------

### loopback-1.conf with filter.smart.after and target

Source: https://pipewire.pages.freedesktop.org/wireplumber/policies/smart_filters.html

Configuration for the loopback-1 filter in ~/.config/pipewire/pipewire.conf.d/loopback-1.conf. Sets filter.smart.after to [ loopback-2 ] and filter.smart.target to { node.name = "not-default-audio-device" }, so the filter is only linked when the application stream targets that device.

```conf
context.modules = [
    {   name = libpipewire-module-loopback
        args = {
            node.name = loopback-1-sink
            node.description = "Loopback 1 Sink"
            capture.props = {
                audio.position = [ FL FR ]
                media.class = Audio/Sink
                filter.smart = true
                filter.smart.name = loopback-1
                filter.smart.after = [ loopback-2 ]
                filter.smart.target = { node.name = "not-default-audio-device" }
            }
            playback.props = {
                audio.position = [ FL FR ]
                node.passive = true
                stream.dont-remix = true
            }
        }
    }
]
```

--------------------------------

### wp_object_manager_is_installed

Source: https://pipewire.pages.freedesktop.org/wireplumber/library/c_api/obj_manager_api.html

Checks if an object manager is installed. Returns TRUE if the object manager is installed (i.e. the WpObjectManager `installed` signal has been emitted), FALSE otherwise.

```APIDOC
## wp_object_manager_is_installed

### Description
Checks if an object manager is installed.

### Parameters
- **self** (WpObjectManager *) - The object manager

### Returns
TRUE if the object manager is installed (i.e. the WpObjectManager `installed` signal has been emitted), FALSE otherwise

```

--------------------------------

### WirePlumber components and profiles with dependency chain

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/configuration/components_and_profiles.html

Configuration file showing how components provide features and profiles require them. The main profile requires monitor.alsa, which wants support.reserve-device, which requires support.dbus, pulling in all three components.

```ini
wireplumber.components = [
  {
    name = libwireplumber-module-dbus-connection, type = module
    provides = support.dbus
  }
  {
    name = libwireplumber-module-reserve-device, type = module
    provides = support.reserve-device
    requires = [ support.dbus ]
  }
  {
    name = monitors/alsa.lua, type = script/lua
    provides = monitor.alsa
    wants = [ support.reserve-device ]
  }
]

wireplumber.profiles = {
  main = {
    monitor.alsa = required
  }
}
```

--------------------------------

### Constraint Examples with Different Verbs

Source: https://pipewire.pages.freedesktop.org/wireplumber/scripting/lua_api/lua_object_interest_api.html

Illustrates various Constraint verbs: equals, not-equals, matches, in-list, in-range, is-present, and is-absent. Shows both string and numeric values, and the character shorthand for verbs like '=' and '#'.

```lua
Constraint { "node.id", "equals", "42" }
Constraint { "node.id", "equals", 42 }
Constraint { "port.physical", "=", true }

Constraint { "audio.channel", "not-equals", "FL" }

Constraint { "node.name", "matches", "v4l2_input*" }
Constraint { "format.dsp", "#", "*mono audio*" }

-- matches either "default" or "settings" as a possible value for "metadata.name"
Constraint { "metadata.name", "in-list", "default", "settings" }

-- matches any priority.session between 0 and 1000, inclusive
Constraint { "priority.session", "in-range", 0, 1000 }

-- matches when the object has a "media.role" property
Constraint { "media.role", "is-present" }

-- matches when "media.role" is not present in the properties list
Constraint { "media.role", "is-absent" }
```

--------------------------------

### video-play: Play Video with Default Device

Source: https://pipewire.pages.freedesktop.org/wireplumber/resources/testing.html

Run the video-play example from the PipeWire source directory using the default device.

```bash
$ cd path/to/pipewire-source-dir
$ ./build/src/examples/video-play
```

--------------------------------

### access.rules example with flatpak access categories

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/configuration/access.html

Defines access rules that match clients by access category and properties, applying default permissions via the update-props action. The first rule matches flatpak clients with media.category Manager and sets access to flatpak-manager with default_permissions 'all'; the second matches all flatpak clients and sets default_permissions to 'rx'.

```spa
access.rules = [
  {
    matches = [
      {
        access = "flatpak"
        media.category = "Manager"
      }
    ]
    actions = {
      update-props = {
        access = "flatpak-manager"
        default_permissions = "all",
      }
    }
  }
  {
    matches = [
      {
        access = "flatpak"
      }
    ]
    actions = {
      update-props = {
        default_permissions = "rx"
      }
    }
  }
]
```

--------------------------------

### wp_settings_get_spec

Source: https://pipewire.pages.freedesktop.org/wireplumber/library/c_api/settings_api.html

Gets the specification of a setting.

```APIDOC
## wp_settings_get_spec

### Description
Gets the specification of a setting.

### Signature
WpSettingsSpec *wp_settings_get_spec(WpSettings *self, const gchar *name)

### Parameters
- **self** (WpSettings*) - Required - The settings object
- **name** (const gchar*) - Required - The name of the setting

### Returns
(transfer full) (nullable): the specification of the setting
```

--------------------------------

### wp_core_get_properties

Source: https://pipewire.pages.freedesktop.org/wireplumber/library/c_api/core_api.html

Gets the properties of the core.

```APIDOC
## wp_core_get_properties

### Description
Gets the properties of the core.

### Method
Function

### Signature
`WpProperties *wp_core_get_properties(WpCore *self)`

### Parameters
- **self** (WpCore*) - Required - The core

### Returns
(transfer full): the properties of _self_
```

--------------------------------

### wp_event_get_properties

Source: https://pipewire.pages.freedesktop.org/wireplumber/library/c_api/event_api.html

Gets the properties of the event.

```APIDOC
## wp_event_get_properties

### Description
Gets the properties of the Event.

### Signature
```c
WpProperties *wp_event_get_properties(WpEvent *self);
```

### Parameters
- **self** (WpEvent*) - Required - The handle

### Returns
(transfer full) The properties of the event
```

--------------------------------

### Save all current settings with wpctl settings --save

Source: https://pipewire.pages.freedesktop.org/wireplumber/man/wpctl.html

Persists all current WirePlumber settings to the configuration file. Use after making changes.

```bash
wpctl settings --save
```

--------------------------------

### wp_event_get_priority

Source: https://pipewire.pages.freedesktop.org/wireplumber/library/c_api/event_api.html

Gets the priority of the event.

```APIDOC
## wp_event_get_priority

### Description
Gets the priority of the event.

### Signature
```c
gint wp_event_get_priority(WpEvent *self);
```

### Parameters
- **self** (WpEvent*) - Required - The event

### Returns
The event priority
```

--------------------------------

### wp_event_get_name

Source: https://pipewire.pages.freedesktop.org/wireplumber/library/c_api/event_api.html

Gets the name of the event.

```APIDOC
## wp_event_get_name

### Description
Gets the name of the event.

### Signature
```c
const gchar *wp_event_get_name(WpEvent *self);
```

### Parameters
- **self** (WpEvent*) - Required - The event

### Returns
The event name
```

--------------------------------

### pacat: Record and Play with Default Device

Source: https://pipewire.pages.freedesktop.org/wireplumber/resources/testing.html

Verify the default device with wpctl status, then record and play using parecord and paplay.

```bash
$ wpctl status  # verify the default device
$ parecord test.wav
$ paplay test.wav
```

--------------------------------

### wp_spa_device_new_from_spa_factory

Source: https://pipewire.pages.freedesktop.org/wireplumber/library/c_api/spa_device_api.html

Constructs a WpSpaDevice by loading a SPA device from a given SPA factory. This is useful for running device monitors inside the session manager.

```APIDOC
## wp_spa_device_new_from_spa_factory

### Description
Constructs a `SPA_TYPE_INTERFACE_Device` by loading the given SPA factory. To export this device to the PipeWire server, call wp_object_activate() requesting WP_PROXY_FEATURE_BOUND.

### Method
Function

### Signature
WpSpaDevice *wp_spa_device_new_from_spa_factory(WpCore *core, const gchar *factory_name, WpProperties *properties)

### Parameters
- **core** (WpCore*) - Required - The wireplumber core
- **factory_name** (const gchar*) - Required - The name of the SPA factory
- **properties** (WpProperties*) - Optional - Properties to be passed to device constructor (nullable, transfer full)

### Returns
(nullable, transfer full): A new WpSpaDevice wrapping the device constructed by the factory, or NULL if the factory does not exist or was unable to construct the device
```

--------------------------------

### wp_settings_get

Source: https://pipewire.pages.freedesktop.org/wireplumber/library/c_api/settings_api.html

Gets the WpSpaJson value of a setting.

```APIDOC
## wp_settings_get

### Description
Gets the WpSpaJson value of a setting.

### Signature
WpSpaJson *wp_settings_get(WpSettings *self, const gchar *name)

### Parameters
- **self** (WpSettings*) - Required - The settings object
- **name** (const gchar*) - Required - The name of the setting

### Returns
(transfer full) (nullable): The WpSpaJson value of the setting, or NULL if the setting does not exist
```

--------------------------------

### wp_settings_item_get_value

Source: https://pipewire.pages.freedesktop.org/wireplumber/library/c_api/settings_api.html

Gets the value from a settings item.

```APIDOC
## wp_settings_item_get_value

### Description
Gets the value from a settings item.

### Parameters
- **self** (WpSettingsItem*) - Required - the item held by the GValue that was returned from the WpIterator of wp_settings_new_iterator()

### Returns
(transfer full): the settings value of the _item_
```

--------------------------------

### access.permission-managers and access.rules example

Source: https://pipewire.pages.freedesktop.org/wireplumber/daemon/configuration/access.html

Defines a permission manager named 'custom' with default_permissions 'all', core_permissions 'rx', and a rule that sets permissions to '-' for objects with media.class Audio/Source. Then references the manager from access.rules for clients with application.name 'paplay'.

```spa
access.permission-managers = [
  {
    name = "custom"
    default_permissions = "all"
    core_permissions = "rx"
    rules = [
      {
        matches = [
          {
            media.class = "Audio/Source"
          }
        ]
        actions = {
          set-permissions = "-"
        }
      }
    ]
  }
]

access.rules = [
  {
    matches = [
      {
        application.name = "paplay"
      }
    ]
    actions = {
      update-props = {
        permission_manager_name = "custom"
      }
    }
  }
]
```

--------------------------------

### Plugin.find example: locate standard-event-source plugin

Source: https://pipewire.pages.freedesktop.org/wireplumber/scripting/lua_api/lua_misc_api.html

Looks up a loaded plugin by name, such as 'standard-event-source', to access its functionality through GObject action signals. Returns the plugin or nil if it is not loaded.

```lua
source = Plugin.find ("standard-event-source")
```

--------------------------------

### wp_settings_item_get_key

Source: https://pipewire.pages.freedesktop.org/wireplumber/library/c_api/settings_api.html

Gets the key from a settings item.

```APIDOC
## wp_settings_item_get_key

### Description
Gets the key from a settings item.

### Parameters
- **self** (WpSettingsItem*) - Required - the item held by the GValue that was returned from the WpIterator of wp_settings_new_iterator()

### Returns
(transfer none): the settings key of the _item_
```

--------------------------------

### wp_settings_spec_get_value_type

Source: https://pipewire.pages.freedesktop.org/wireplumber/library/c_api/settings_api.html

Gets the type of a settings spec.

```APIDOC
## wp_settings_spec_get_value_type

### Description
Gets the type of a settings spec.

### Parameters
- **self** (WpSettingsSpec*) - Required - the settings spec object

### Returns
the type of the settings spec
```

--------------------------------

### pavucontrol: Launch Volume Control

Source: https://pipewire.pages.freedesktop.org/wireplumber/resources/testing.html

Launch pavucontrol. Volume level meters and volume changes should work.

```bash
$ pavucontrol
```
Tokens:
Raw