WirePlumber
WirePlumber is a modular session / policy manager for PipeWire and a GObject-based high-level library that wraps PipeWire's API, providing convenience for writing the daemon's modules as well as external tools for managing PipeWire.
The WirePlumber daemon implements the session & policy management service. It follows a modular design, having plugins that implement the actual management functionality.
The WirePlumber Library provides API that allows you to extend the WirePlumber daemon, to write management or status tools for PipeWire (apps that don't do actual media streaming) and to write custom session managers for embedded devices.
Documentation
The latest version of the documentation is available online here
Table of Contents
The WirePlumber Daemon
- Getting started
- Installing WirePlumber
- Running the WirePlumber daemon
- Configuration
- The configuration file
- Components & Profiles
- Configuration option types
- Modifying configuration
- Migrating configuration from 0.4
- Well-known features
- Well-known settings
- ALSA configuration
- Stream configuration
- Bluetooth configuration
- Video & camera configuration
- Access configuration
- Example configuration fragments
- Locations of WirePlumber's files
- Debug Logging
- Running multiple instances
WirePlumber's Design
WirePlumber's Policies
The WirePlumber Library
- C API Documentation
- Library Initialization
- Core
- WpObject
- Object Manager
- Object Interest
- Iterator
- Transitions
- Error Codes
- Debug Logging
- PipeWire Proxy
- PipeWire Object
- PipeWire Global Object Proxy
- PipeWire Node
- PipeWire Port
- PipeWire Link
- PipeWire Device
- PipeWire Client
- WpPermissionManager
- PipeWire Metadata
- Spa Device
- Local Nodes
- Local Modules
- Properties Dictionary
- Spa Type Information
- Spa Json
- Spa Pod (Plain Old Data)
- Plugins
- Events
- Event Dispatcher
- Event Hooks
- Component Loader
- Settings
- Static Configuration
- Session Items
- Session Items Interfaces
- Session Items Factory
- PipeWire Factory
- State Storage
- Json Utilities
- Process Utilities
- Base Directories File Lookup
Man Pages