system/pipewire
system/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire synced 2024-10-14 11:53:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: move spa/foo.md to spa-foo.md

Browse source 
Flatten the hierarchy a bit to make it easier to handle.
This commit is contained in:
Peter Hutterer 2021-05-25 11:19:17 +10:00 committed by Wim Taymans
parent 5e5b9e3050
commit f8243f3cc1
10 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/architecture.md
View file

@ -34,7 +34,7 @@ described in an external protocol file but implemented directly in
a protocol plugin. Protocol plugins can be added to add new a protocol plugin. Protocol plugins can be added to add new
objects or even protocols when required. objects or even protocols when required.
Messages are encoded with [SPA PODs](spa/pod.md), which make it Messages are encoded with [SPA PODs](spa-pod.md), which make it
possible to encode complex objects with right types. possible to encode complex objects with right types.
Events from the server can be a reply to a method or can be emitted Events from the server can be a reply to a method or can be emitted

2
doc/index.md
View file

@ -8,7 +8,7 @@ found here.
Start the tutorial about how to use the PipeWire API Start the tutorial about how to use the PipeWire API
[here](tutorial-index.md). [here](tutorial-index.md).
Notes about the design of the low-level [SPA](spa/design.md) Notes about the design of the low-level [SPA](spa-design.md)
layer. layer.
Some Resources: Some Resources:

8
doc/meson.build
View file

@ -55,10 +55,10 @@ extra_docs = [
'tutorial4.md', 'tutorial4.md',
'tutorial5.md', 'tutorial5.md',
'tutorial6.md', 'tutorial6.md',
'spa/index.md', 'spa-index.md',
'spa/design.md', 'spa-design.md',
'spa/pod.md', 'spa-pod.md',
'spa/buffer.md', 'spa-buffer.md',
'pulseaudio.md', 'pulseaudio.md',
] ]

0
doc/spa/buffer.md → doc/spa-buffer.md
View file

0
doc/spa/design.md → doc/spa-design.md
View file

6
doc/spa/index.md → doc/spa-index.md
View file

@ -4,6 +4,6 @@ SPA (Simple Plugin API) is an extensible API to implement all kinds of
plugins. It is inspired by many other plugin APIs, mostly LV2 and plugins. It is inspired by many other plugin APIs, mostly LV2 and
GStreamer. GStreamer.
* SPA [Design](design.md) * SPA [Design](spa-design.md)
* [Data format](pod.md) * [Data format](spa-pod.md)
* SPA [Buffers](buffer.md) * SPA [Buffers](spa-buffer.md)

0
doc/spa/pod.md → doc/spa-pod.md
View file

2
doc/tutorial3.md
View file

@ -85,7 +85,7 @@ This triggers the `sync` method on the core object with id
Because this is a method on a proxy object, it will be executed Because this is a method on a proxy object, it will be executed
asynchronously and the returns value will reflect this. PipeWire asynchronously and the returns value will reflect this. PipeWire
uses the return values of the underlying SPA (Simple Plugin API) uses the return values of the underlying SPA (Simple Plugin API)
helper objects (See also [error codes](spa/design.md#error-codes)). helper objects (See also [error codes](spa-design.md#error-codes)).
Because all messages on the PipeWire server are handled sequentially, Because all messages on the PipeWire server are handled sequentially,
the sync method will be executed after all previous methods are the sync method will be executed after all previous methods are

4
doc/tutorial4.md
View file

@ -208,7 +208,7 @@ which means that it enumerates the possible formats for this stream. We have
only one, a Signed 16 bit stereo format at 44.1KHz. only one, a Signed 16 bit stereo format at 44.1KHz.
We use `spa_format_audio_raw_build()` which is a helper function to make the param We use `spa_format_audio_raw_build()` which is a helper function to make the param
with the builder. See [SPA POD](spa/pod.md) for more information about how to with the builder. See [SPA POD](spa-pod.md) for more information about how to
make these POD objects. make these POD objects.
Now we're ready to connect the stream and run the main loop: Now we're ready to connect the stream and run the main loop:
@ -291,7 +291,7 @@ static void on_process(void *userdata)
} }
``` ```
Check out the docs for [buffers](spa/buffer.md) for more information Check out the docs for [buffers](spa-buffer.md) for more information
about how to work with buffers. about how to work with buffers.
Try to change the number of channels, samplerate or format; the stream Try to change the number of channels, samplerate or format; the stream

2
doc/tutorial5.md
View file

@ -246,7 +246,7 @@ We have something similar for the framerate.
Note that there are other video parameters that we don't specify here. This Note that there are other video parameters that we don't specify here. This
means that we don't have any restrictions for their values. means that we don't have any restrictions for their values.
See [SPA POD](spa/pod.md) for more information about how to make these See [SPA POD](spa-pod.md) for more information about how to make these
POD objects. POD objects.
Now we're ready to connect the stream and run the main loop: Now we're ready to connect the stream and run the main loop: