API Reference

Here is a list of all topics with brief descriptions:

[detail level 123]

Stream
Filter
▼Core API	This determines the ordering of items in Doxygen sidebar
Initialization	Initializing PipeWire and loading SPA modules
Main Loop
Context
Client	Client interface
Core
Device	Device interface
Factory	Factory interface
Link
Loop
Module	Module interface
Node	Node interface
Permission
Port	Port interface
Proxy
Registry
Type info	Type information
Key Names
▼Implementation API
Client Impl
Core Impl
Device Impl
Factory Impl
Link Impl
Metadata Impl
Module Impl
Node Impl
Port Impl
Buffers	Buffer handling
Control
Data Loop
Global
Protocol
Resource
Thread Loop
Work Queue	Queued processing of work items
▼Utilities
Array
Configuration	Loading/saving properties from/to configuration files
Internationalization	Gettext interface
Logging
Map
Memory Blocks	Memory allocation and pools
Properties
Thread
Utilities
▼Extensions
Client Node	Client node interface
Metadata	Metadata interface
Profiler	Profiler interface
Native Protocol	PipeWire native protocol interface
Session Manager	Session manager interface
▼SPA
POD
Buffers
Control	Control type declarations
Debug	Debugging utilities
Device
Graph	Node graph
Node
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
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