diff --git a/doc/architecture.md b/doc/architecture.md index 1d6d99f69..0b2540a0e 100644 --- a/doc/architecture.md +++ b/doc/architecture.md @@ -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 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. Events from the server can be a reply to a method or can be emitted diff --git a/doc/index.md b/doc/index.md index 179aa1fe0..dc945477e 100644 --- a/doc/index.md +++ b/doc/index.md @@ -8,7 +8,7 @@ found here. Start the tutorial about how to use the PipeWire API [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. Some Resources: diff --git a/doc/meson.build b/doc/meson.build index 744b0ee81..f89b9ede2 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -55,10 +55,10 @@ extra_docs = [ 'tutorial4.md', 'tutorial5.md', 'tutorial6.md', - 'spa/index.md', - 'spa/design.md', - 'spa/pod.md', - 'spa/buffer.md', + 'spa-index.md', + 'spa-design.md', + 'spa-pod.md', + 'spa-buffer.md', 'pulseaudio.md', ] diff --git a/doc/spa/buffer.md b/doc/spa-buffer.md similarity index 100% rename from doc/spa/buffer.md rename to doc/spa-buffer.md diff --git a/doc/spa/design.md b/doc/spa-design.md similarity index 100% rename from doc/spa/design.md rename to doc/spa-design.md diff --git a/doc/spa/index.md b/doc/spa-index.md similarity index 66% rename from doc/spa/index.md rename to doc/spa-index.md index f60667684..665da5f2a 100644 --- a/doc/spa/index.md +++ b/doc/spa-index.md @@ -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 GStreamer. -* SPA [Design](design.md) -* [Data format](pod.md) -* SPA [Buffers](buffer.md) +* SPA [Design](spa-design.md) +* [Data format](spa-pod.md) +* SPA [Buffers](spa-buffer.md) diff --git a/doc/spa/pod.md b/doc/spa-pod.md similarity index 100% rename from doc/spa/pod.md rename to doc/spa-pod.md diff --git a/doc/tutorial3.md b/doc/tutorial3.md index 6a46b4676..914e5828e 100644 --- a/doc/tutorial3.md +++ b/doc/tutorial3.md @@ -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 asynchronously and the returns value will reflect this. PipeWire 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, the sync method will be executed after all previous methods are diff --git a/doc/tutorial4.md b/doc/tutorial4.md index d0afe1872..0d9490340 100644 --- a/doc/tutorial4.md +++ b/doc/tutorial4.md @@ -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. 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. 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. Try to change the number of channels, samplerate or format; the stream diff --git a/doc/tutorial5.md b/doc/tutorial5.md index 75335cb2b..d9c1c4892 100644 --- a/doc/tutorial5.md +++ b/doc/tutorial5.md @@ -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 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. Now we're ready to connect the stream and run the main loop: