Commit graph

358 commits

Author SHA1 Message Date
Dylan Aïssi
4e9c3b26d9 doc: remove duplicate FULL_PATH_NAMES field
FULL_PATH_NAMES is defined twice. Remove the one set to YES
since including the full path breaks reproducible builds.

See https://reproducible-builds.org/docs/build-path/
2023-01-12 18:09:54 +01:00
Wim Taymans
846dbce7f1 doc: update after PIPEWIRE_DEBUG changes 2022-12-16 18:29:19 +01:00
Mersad Jelacic
72f5dbe6a6 doc: Change variable name to 'SPA_PLUGIN_DIR'
Sync with 'SPA_PLUGIN_DIR' name that is used in code.

Change-Id: Ibd8f84dd2aaf4ba7f581ad44140bf7b46ae43709
2022-12-12 10:53:15 +01:00
Wim Taymans
da44be28cf doc: add rtp sink to docs 2022-10-06 13:28:09 +02:00
Wim Taymans
18ffb1600e module-rtp: add to docs 2022-10-05 21:42:36 +02:00
Wim Taymans
225e89b8da doc: add a bootlin.com blog post 2022-09-02 11:36:58 +02:00
Barnabás Pőcze
1db52856ff doc: tutorial3: change "returns value" to "return value" 2022-07-21 07:20:11 +00:00
Barnabás Pőcze
cb3e625fa8 doc: tutorial3: remove a line break 2022-07-21 07:20:11 +00:00
Barnabás Pőcze
606e0dcdab doc: tutorial3: do not return anything from roundtrip()
The return value was constant 0 and it was not used by the caller.
2022-07-21 07:20:11 +00:00
Barnabás Pőcze
94d405be3b doc: tutorial3: mark vtable static 2022-07-21 07:20:11 +00:00
Barnabás Pőcze
473809190b doc: tutorial3: do not use nested functions
Nested functions are a GNU C extension, they are
not supported by clang, and by GCC in C++ mode.
2022-07-21 07:20:11 +00:00
Barnabás Pőcze
04e65a86a1 doc: tutorial3: remove done variable
Use `pw_main_loop_quit()` alone, which should be enough
to cause `pw_main_loop_run()` to return. `pw_main_loop_run()`
only returns prematurely when there is an error, but since
there is no error handling in this example, that scenario
is ignored.
2022-07-21 07:20:11 +00:00
Barnabás Pőcze
f61bb3aef5 doc: tutorial3: do not spa_zero() the hook objects
`spa_hook_list_append()` zeroes the hooks when they
are inserted into the list of hooks.
2022-07-21 07:20:11 +00:00
Barnabás Pőcze
bb0cda3d94 doc: tutorial3: use tabs for indentation 2022-07-21 07:20:11 +00:00
Wim Taymans
862a0746e4 docs: fix ref 2022-07-20 15:49:09 +02:00
Wim Taymans
9d48224c02 doc: add AVB module 2022-07-12 12:41:45 +02:00
Pauli Virtanen
ca87d40448 examples: use PW_KEY_TARGET_OBJECT
In examples, tell people how to use target.object.
2022-07-11 15:32:43 +03:00
Aleix Pol
74646d1be5 dma-buf.dox readability 2022-06-08 15:07:26 +02:00
Wim Taymans
ebe673aecb doc: update with pipe-tunnel 2022-06-03 16:23:34 +02:00
jasker5183
6b619dd1b3 Doxygen - enable client side search engine. 2022-05-16 15:33:27 +00:00
jasker5183
c71db353f1 Documentation Updates 2022-05-08 17:06:28 +00:00
Wim Taymans
e406ff9530 doc: add an older AGL Paper 2022-04-23 10:16:22 +02:00
Wim Taymans
54e96d2d10 doc: Add good bluetooth article 2022-04-23 10:14:00 +02:00
Quentin Wenger
22fc9eec35 Cleanup argument names in methods and events interfaces
First method argument is object, first event argument is data.

Closes !963
2022-04-15 10:11:49 +02:00
columbarius
8dccfbce4c doc: Clarify size properties wrt DMA-BUFs 2022-03-09 09:39:48 +01:00
Pauli Virtanen
02e6f9fbca module-fallback-sink: add dynamically appearing fallback sink
Add a module for a fallback dummy sink, which appears dynamically when
no other sinks are present.

Enable it for pipewire-pulse, because Pulseaudio will also show
dynamically a dummy sink.
2022-02-13 09:54:55 +00:00
Wim Taymans
ae077a4967 doc: update with config overrides info 2022-02-03 17:31:01 +01:00
Wim Taymans
0cd0ef5912 modules: add x11-bell module
It listens for X11 bell events and plays a sample with libcanberra.

Fixes #1668
2022-01-21 16:30:02 +01:00
Pauli Virtanen
88e744a06f doc: include manpages in html docs
Include manpages as raw text in html docs.  Simple and readable
enough...
2022-01-20 20:51:03 +00:00
Robbert van der Helm
2b73c86af5 modules: Rename module-rtkit to module-rt
I don't think PipeWire currently has a way to temporarily alias
module-rtkit to module-rt though, so right now this would break realtime
scheduling for people with modified configs that use module-rtkit.
2022-01-15 20:59:41 +01:00
Robbert van der Helm
6fc966f385 modules: Drop module-rt 2022-01-15 20:59:41 +01:00
Barnabás Pőcze
8ed46a283f treewide: meson.build: use project_{build,source}_root()
Use `meson.project_{build,source}_root()` instead of
`meson.{build,source}_root()` because those functions
do not work as expected when used inside a subproject,
and they have been deprecated in meson 0.56.0.
2021-12-28 18:37:18 +01:00
Wim Taymans
128f80dd6b doc: Add module-raop-discover 2021-12-14 10:47:41 +01:00
Wim Taymans
3e659d01b8 doc: add raop sink to docs 2021-11-12 16:58:27 +01:00
columbarius
2c10894970 docs: Update fixation on DmaBuf-docs 2021-11-10 22:23:30 +00:00
Pauli Virtanen
bbc2136e89 meson: ensure all examples are included in doc
Move declaration of examples to use same file lists for build and docs.
2021-11-02 09:46:14 +00:00
Peter Hutterer
98991e7972 doc: fix URL to the media session git repo 2021-10-19 13:25:55 +10:00
Peter Hutterer
1bced6b2ef Remove media-session from this tree
It is now available as a separate project in
https://gitlab.freedesktop.org/pipewire/media-session

The code required by pw-reservice has moved to src/tools/reserve.{c|h}
2021-10-18 20:44:07 +10:00
Wim Taymans
c4e1b69df2 doc: add some more links 2021-10-15 19:26:37 +02:00
Peter Hutterer
3560f3ba2d media-session: add MEDIA_SESSION_CONFIG_DIR as lookup location
Use this to override the default $PIPEWIRE_CONFIG_DIR/media-session.d
directory. This allows us to have separate configuration directories for
pipewire and media-session.
2021-10-14 07:51:27 +00:00
Pauli Virtanen
336caa9db3 doc: add tutorials as Doxygen examples 2021-10-10 00:35:46 +03:00
Pauli Virtanen
98a0e54d5f doc: link examples to Doxygen docs
Include examples to the documentation, using Doxygen's example system.
2021-10-10 00:35:46 +03:00
Björn Daase
cf38b7bdc4 fix codespell issues 2021-10-07 15:26:18 +00:00
Pauli Virtanen
7123fadc37 doc: further Doxygen tweaks
Make Doxygen see also macros defined inside struct declarations,
and to include also opaque structs.

Keep members in the order they are in the .h file, since Doxygen's
case-insensitive sort by name jumbles things.
2021-10-06 19:06:42 +00:00
Pauli Virtanen
75d76172fa doc: fix meson dependency list
Meson doesn't accept directories in input dependency list.
2021-10-05 20:31:35 +00:00
Pauli Virtanen
04f3948bb1 doc: avoid duplicate file listings in groups 2021-10-04 20:55:04 +03:00
Pauli Virtanen
49901f2d61 doc: add brief explanations for all groups 2021-10-04 20:55:04 +03:00
Pauli Virtanen
125051a700 doc: reorganize some \pages, and fix some group names
Move \pages having to do with the API usage to the API section.
Better group names for some groups.
2021-10-04 20:39:56 +03:00
Pauli Virtanen
f9cdc617a8 doc: don't generate Doxygen file list
The file list duplicates the Module structure, and is just confusing
since it also contains the .c files.
2021-10-04 20:37:35 +03:00
Pauli Virtanen
601560e343 doc: hide various Doxygen generated dot graphs
The Doxygen autogenerated graphs are very useful and take up lots of
space being on the top, so disable them.

Also disable references/referenced by relations, which add clutter.

Also hide most macro values.
2021-10-03 15:39:27 +03:00