Wim Taymans
3b5fd0bd7a
doc: fix pod sizes
2023-05-23 09:30:36 +02:00
Wim Taymans
83718f431b
doc: update
2023-05-23 09:19:35 +02:00
Arun Raghavan
b216a2cfb0
doc: Some minor fixups to the scheduling doc
...
s/evenfd/eventfd and some minor formatting.
2023-05-18 14:58:49 -03:00
Wim Taymans
957470bd9f
doc: add more docs
2023-05-16 16:15:54 +02:00
Wim Taymans
f5a65a27b0
docs: document some more
2023-05-16 15:44:22 +02:00
Wim Taymans
4eb64f5a6c
doc: improve formatting
2023-05-16 12:55:48 +02:00
Wim Taymans
b5224a6844
doc: improve formatting
2023-05-16 12:50:18 +02:00
Wim Taymans
d7315ee572
docs: add more docs
2023-05-16 12:42:36 +02:00
Wim Taymans
56f3d0d417
docs: document some more
2023-05-16 12:27:05 +02:00
Wim Taymans
e759a2feed
doc: document registry events and methods
2023-05-16 11:21:03 +02:00
Wim Taymans
aad69d22c1
doc: add more docs
2023-05-16 11:01:54 +02:00
Wim Taymans
fb5c9688a2
doc: fix comment
2023-05-15 12:04:06 +02:00
Wim Taymans
a9d6807ec1
doc: add some more docs
2023-05-15 11:44:41 +02:00
Wim Taymans
4a81c17b68
modules: add jackdbus-detect module
...
Loads jack-tunnel based on jackdbus state.
2023-04-30 10:34:19 +02:00
Wim Taymans
ab0cee29dd
doc: add jack-tunnel to docs
2023-04-27 17:03:10 +02:00
Wim Taymans
f6d4306a37
doc: mention .conf extension for config files
...
See #3079
2023-04-14 15:51:21 +02:00
Wim Taymans
0885899b7a
module-rtp: fix docs
2023-03-09 13:14:22 +01:00
Wim Taymans
e8119cb087
docs: improve docs
2023-03-09 13:14:22 +01:00
Wim Taymans
c36d9bef38
doc: add custom node bog post by bootlin
2023-03-09 13:13:35 +01:00
Wim Taymans
29787b51ef
modules: add combine-stream module
...
The module can:
- Make a sink that sends all or some channels to other sinks.
- Make a source that combines multiple sources into one.
The selection of what streams to combine is implemented with rules so
that the selection is very configurable. By default all Audio/Sink or
Audio/Source nodes are selected.
2023-01-23 17:06:56 +01:00
Barnabás Pőcze
375cc73b9d
doc: specify Doxygen OUTPUT_DIRECTORY as an absolute path
...
Currently, doxygen is run by ninja in the top-level build directory,
therefore the "doc" folder is always created there. However, when
pipewire is built as a subproject, it should not touch the top-level
build directory because it can cause conflicts and because the
documentation won't be created where meson thinks it will be,
so the "doxygen" target will always be dirty and installation will fail.
2023-01-15 15:08:47 +00:00
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