mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-11-03 09:01:54 -05:00
8159797f89
The Doxygen "Modules" page is not very illuminative, as different parts of the API are mixed together and not all parts are included. Try to address this: Put all parts of the public API to some Doxygen group, usually one group per header file. Use short, systematic names. Make these groups sub-groups of a few top-level groups, roughly corresponding to the different logical parts of the API (core, impl, stream, filter, spa, utilities).
38 lines
1.3 KiB
Text
38 lines
1.3 KiB
Text
/** \mainpage PipeWire
|
|
|
|
PipeWire is low-level multimedia framework that provides:
|
|
- Graph based processing
|
|
- Support for out-of-process processing graphs with minimal overhead
|
|
- Flexible and extensible media format negotiation and buffer allocation
|
|
- Hard real-time capable plugins
|
|
- Very low-latency for both audio and video processing
|
|
|
|
See \ref page_overview for an overview of PipeWire and \ref page_design
|
|
for the design principles guiding PipeWire.
|
|
|
|
### Components
|
|
|
|
PipeWire ships with the following components:
|
|
|
|
- a \ref page_daemon that implements the IPC and graph processing
|
|
- an example \ref page_session_manager that manages objects in the \ref page_daemon
|
|
- a set of \ref page_tools to introspect and use the \ref page_daemon
|
|
- a \ref page_library to develop PipeWire applications and plugins (\ref
|
|
page_tutorial "tutorial").
|
|
- the \ref page_spa used by both the \ref page_daemon and in the \ref
|
|
page_library.
|
|
|
|
### API Documentation
|
|
|
|
See \ref page_api
|
|
|
|
### More Documentation
|
|
|
|
See our [Wiki](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/home) for
|
|
More information on how to configure and use PipeWire.
|
|
|
|
### Resources
|
|
|
|
- [LAC 2020 Paper](https://lac2020.sciencesconf.org/307881/document)
|
|
- [PipeWire Under The Hood](https://venam.nixers.net/blog/unix/2021/06/23/pipewire-under-the-hood.html)
|
|
*/
|