system/pipewire
system/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire synced 2024-07-21 10:16:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
pipewire/doc/dox/index.dox

52 lines
1.8 KiB
Plaintext
Raw Normal View History

doc: switch from .md to .dox files and impose some general structure This is an attempt of breaking up the documentation, currently spread across several pages. We're left with a few high-level topics with various things grouped underneath those. Further refinement is necessary, but this can now be done in incremental steps over massive reworks.
2021-05-25 09:55:06 +00:00
/** \mainpage PipeWire
PipeWire is low-level multimedia framework that provides:
Documentation Updates
2022-05-08 17:06:28 +00:00
- 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.
doc: switch from .md to .dox files and impose some general structure This is an attempt of breaking up the documentation, currently spread across several pages. We're left with a few high-level topics with various things grouped underneath those. Further refinement is necessary, but this can now be done in incremental steps over massive reworks.
2021-05-25 09:55:06 +00:00
See \ref page_overview for an overview of PipeWire and \ref page_design
for the design principles guiding PipeWire.
doc: add 'Configuration' page Add pointer for readers to Wiki and WirePlumber docs, where the documentation actually is at, so the configuration docs can found starting from docs.pipewire.org
2024-02-04 10:14:31 +00:00
# Documentation
- \ref page_config
- \ref page_programs
- \ref page_modules
- \ref page_pulse_modules
See our [Wiki](https://gitlab.freedesktop.org/pipewire/pipewire/-/wikis/home) for
more information on how to configure and use PipeWire.
Documentation Updates
2022-05-08 17:06:28 +00:00
# Components
doc: switch from .md to .dox files and impose some general structure This is an attempt of breaking up the documentation, currently spread across several pages. We're left with a few high-level topics with various things grouped underneath those. Further refinement is necessary, but this can now be done in incremental steps over massive reworks.
2021-05-25 09:55:06 +00:00
PipeWire ships with the following components:
Documentation Updates
2022-05-08 17:06:28 +00:00
- 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.
doc: reorganize files Separate various autogen files from the documentation .dox files. Rename .dox files to match the intended tree structure.
2023-11-18 13:13:05 +00:00
- A set of \ref page_programs to introspect and use the \ref page_daemon.
Documentation Updates
2022-05-08 17:06:28 +00:00
- A \ref page_library to develop PipeWire applications and plugins (\ref
doc: switch from .md to .dox files and impose some general structure This is an attempt of breaking up the documentation, currently spread across several pages. We're left with a few high-level topics with various things grouped underneath those. Further refinement is necessary, but this can now be done in incremental steps over massive reworks.
2021-05-25 09:55:06 +00:00
page_tutorial "tutorial").
Documentation Updates
2022-05-08 17:06:28 +00:00
- The \ref page_spa used by both the \ref page_daemon and in the \ref
doc: switch from .md to .dox files and impose some general structure This is an attempt of breaking up the documentation, currently spread across several pages. We're left with a few high-level topics with various things grouped underneath those. Further refinement is necessary, but this can now be done in incremental steps over massive reworks.
2021-05-25 09:55:06 +00:00
page_library.
Documentation Updates
2022-05-08 17:06:28 +00:00
# API Documentation
doc: switch from .md to .dox files and impose some general structure This is an attempt of breaking up the documentation, currently spread across several pages. We're left with a few high-level topics with various things grouped underneath those. Further refinement is necessary, but this can now be done in incremental steps over massive reworks.
2021-05-25 09:55:06 +00:00
Documentation Updates
2022-05-08 17:06:28 +00:00
See \ref page_api.
doc: switch from .md to .dox files and impose some general structure This is an attempt of breaking up the documentation, currently spread across several pages. We're left with a few high-level topics with various things grouped underneath those. Further refinement is necessary, but this can now be done in incremental steps over massive reworks.
2021-05-25 09:55:06 +00:00
Documentation Updates
2022-05-08 17:06:28 +00:00
# Resources
doc: switch from .md to .dox files and impose some general structure This is an attempt of breaking up the documentation, currently spread across several pages. We're left with a few high-level topics with various things grouped underneath those. Further refinement is necessary, but this can now be done in incremental steps over massive reworks.
2021-05-25 09:55:06 +00:00
doc: add an older AGL Paper
2022-04-23 08:16:22 +00:00
- [PipeWire and AGL](https://wiki.automotivelinux.org/_media/pipewire_agl_20181206.pdf)
doc: add link to wiki
2021-09-30 11:31:08 +00:00
- [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)
doc: add some more links
2021-10-15 17:26:37 +00:00
- [PipeWire: The Linux audio/video bus (LWN)](https://lwn.net/Articles/847412)
- [PipeWire Wikipedia](https://en.wikipedia.org/wiki/PipeWire)
doc: Add good bluetooth article
2022-04-23 08:14:00 +00:00
- [Bluetooth, PipeWire and Whatsapp calls](https://gjhenrique.com/pipewire.html)
doc: add a bootlin.com blog post
2022-09-02 09:36:58 +00:00
- [Intoduction to PipeWire](https://bootlin.com/blog/an-introduction-to-pipewire/)
doc: add custom node bog post by bootlin
2023-03-09 12:13:35 +00:00
- [A custom PipeWire node](https://bootlin.com/blog/a-custom-pipewire-node/)
Documentation Updates
2022-05-08 17:06:28 +00:00
doc: switch from .md to .dox files and impose some general structure This is an attempt of breaking up the documentation, currently spread across several pages. We're left with a few high-level topics with various things grouped underneath those. Further refinement is necessary, but this can now be done in incremental steps over massive reworks.
2021-05-25 09:55:06 +00:00
*/
Reference in a new issue Copy permalink