pipewire/doc/tutorial-index.md
Peter Hutterer ac05f6bb03 doc: add the various markdown prose docs to the doxygen output
Note that the order of the includes matters - that's how doxygen will sort
them. There is no specific structure other than the include order - one reason
why the headers are being changed. Without polluting the markdown files with
doxygen commands we cannot use \subpage, so all files convert to a regular
\page and are listed as flat hierarchy in the sidebar (and in Related Pages).

Changing the headers at least provides some visual grouping with comon
prefixes.
2021-05-07 10:27:26 +10:00

488 B

Tutorial - The PipeWire API

Welcome to the PipeWire tutorial. The goal is to learn PipeWire API step-by-step with simple short examples.

  1. Getting started (tutorial 1).

  2. Enumerating objects (tutorial 2).

  3. Forcing a roundtrip (tutorial 3).

  4. Playing a tone with pw_stream (tutorial 4).

  5. Capture video frames with pw_stream (tutorial 5).

  6. Bind to an object (tutorial 6).