pipewire/doc/tutorial-index.md

# 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](tutorial1.md)).

2) Enumerating objects ([tutorial 2](tutorial2.md)).

3) Forcing a roundtrip ([tutorial 3](tutorial3.md)).

4) Playing a tone with `pw_stream` ([tutorial 4](tutorial4.md)).

5) Capture video frames with `pw_stream` ([tutorial 5](tutorial5.md)).

6) Bind to an object ([tutorial 6](tutorial6.md)).
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 09:09:45 +10:00			`# Tutorial - The PipeWire API`
doc: add tutorial index 2020-06-11 13:43:29 +02:00
doc: fix typos Signed-off-by: Siwon Kang <siwon.kang@daimler.com> 2020-09-14 20:00:59 +02:00			`Welcome to the PipeWire tutorial. The goal is to learn`
doc: add tutorial index 2020-06-11 13:43:29 +02:00			`PipeWire API step-by-step with simple short examples.`

docs: more tutorial 2020-06-11 15:32:52 +02:00			`1) Getting started ([tutorial 1](tutorial1.md)).`
doc: add tutorial index 2020-06-11 13:43:29 +02:00
docs: more tutorial 2020-06-11 15:32:52 +02:00			`2) Enumerating objects ([tutorial 2](tutorial2.md)).`
docs: add tutorial 3 2020-06-11 16:25:47 +02:00
			`3) Forcing a roundtrip ([tutorial 3](tutorial3.md)).`
doc: add tutorial for pw_stream playback 2020-06-13 21:26:21 +02:00
			4) Playing a tone with `pw_stream` ([tutorial 4](tutorial4.md)).

doc: add video capture tutorial 2020-06-19 16:36:12 +02:00			5) Capture video frames with `pw_stream` ([tutorial 5](tutorial5.md)).

doc: add tutorial about binding objects 2020-06-23 15:44:01 +02:00			`6) Bind to an object ([tutorial 6](tutorial6.md)).`