PipeWire: API Reference

PipeWire 1.2.1

Loading...
Searching...
No Matches
API Reference
Here is a list of all topics with brief descriptions:
[detail level 123]

Stream |
Filter |
Security Context | Security Context interface
▼Core API | This determines the ordering of items in Doxygen sidebar
Initialization | Initializing PipeWire and loading SPA modules
Main Loop |
Context | The PipeWire context object manages all locally available resources. It is used by both clients and servers
Client | Client interface
Core | The core global object
Device | Device interface
Factory | Factory interface
Link |
Loop |
Module | Module interface
Node | Node interface
Permission |
Port | Port interface
Proxy | Represents an object on the client side
Registry |
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 |
Factory Impl |
Link Impl | PipeWire link object
Metadata Impl |
Module Impl |
Node Impl |
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 |
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 |
Thread | functions to manipulate threads
Utilities |
▼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 |
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 | 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