API Reference

Here is a list of all topics with brief descriptions:

Stream	PipeWire stream objects
Filter	PipeWire filter object class
Security Context	Security Context interface
Filter Graph	Graph of filters
JSON Utils	Relaxed JSON variant parsing Utils
Core API	This determines the ordering of items in Doxygen sidebar
Initialization	Initializing PipeWire and loading SPA modules
Main Loop	A main loop object
Context	The PipeWire context object manages all locally available resources
Client	Client interface
Core	The core global object
Device	Device interface
Factory	Factory interface
Link	A link is the connection between 2 nodes (Node)
Loop	PipeWire loop object provides an implementation of the spa loop interfaces
Module	Module interface
Node	Node interface
Permission	Permissions are kept for a client and describe what the client is allowed to do with an object
Port	Port interface
Proxy	Represents an object on the client side
Registry	The registry object is a singleton object that keeps track of global objects on the PipeWire instance
Type info	Type information
Key Names
Implementation API	PipeWire Object Implementation API
Client Impl	PipeWire client object class
Core Impl	PipeWire core interface
Device Impl	The device is an object that manages nodes
Factory Impl	The factory is used to make objects on demand
Link Impl	PipeWire link object
Metadata Impl	The metadata is used to store key/type/value pairs per object id
Module Impl	A dynamically loadable module
Node Impl	The node object processes data
Port Impl	A port can be used to link two nodes
Buffers	Buffer handling
Control	A control can be used to control a port property
Data Loop	PipeWire rt-loop object
Global	A global object visible to remote clients
Protocol	Manages protocols and their implementation
Resource	Client owned objects
Thread Loop	The threaded loop object runs a Loop in a separate thread and ensures proper locking is done
Timer Queue	Processing of timer events
Work Queue	Queued processing of work items
Utilities	PipeWire Utilities
Array	An array object
Configuration	Loading/saving properties from/to configuration files
Internationalization	Gettext interface
Logging	Logging functions of PipeWire
Map	A map that holds pointers to objects indexed by id
Memory Blocks	Memory allocation and pools
Properties	Properties are used to pass around arbitrary key/value pairs
Thread	Functions to manipulate threads
Utilities	Various utility functions
Extensions	PipeWire Extensions
Client Node	Client node interface
Metadata	Metadata interface
Profiler	Profiler interface
Native Protocol	PipeWire native protocol interface
Session Manager	Session manager interface
SPA	Simple Plugin API
POD
Buffers	Buffers describe the data and metadata that is exchanged between ports of a node
Control	Control type declarations
Debug	Debugging utilities
Device	The device interface can be used to monitor all kinds of devices and create objects as a result
Graph	Node graph
Node	A spa_node is a component that can consume and produce buffers
Parameters	Parameter value enumerations and type information
Utilities	Utility data structures, macros, etc
ANSI codes	ANSI color code macros
Miscellaneous	Helper macros and functions
Dictionary	Dictionary data structure
List	Doubly linked list data structure
Hooks	A SPA Hook is a data structure to keep track of callbacks
Interfaces	Generic implementation of implementation-independent interfaces
JSON	Relaxed JSON variant parsing
JSON to POD	JSON to POD conversion
Key Names	Key names used by SPA plugins
Factory Names	SPA plugin factory names
Result handling	Asynchronous result utilities
Ringbuffer	Ring buffer implementation
String handling	String handling utilities
Types	Data type information enumerations
Support	Support interfaces provided by host
CPU	Querying CPU properties
DBus	DBus communication
I18N	Gettext interface
Log	Logging interface
Loop	Event loop interface
Plugin Handle	SPA plugin handle and factory interfaces
Plugin Loader	SPA plugin loader
System	I/O, clock, polling, timer, and signal interfaces
Thread	Threading utility interfaces
Capability Names	A collection of capabilities that can be advertised by end points in streams