mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-12-19 08:57:14 -05:00
Run codespell on the entire codebase
This tool detects and fixes common English spelling mistakes, with generally very few mistakes. Here is the command I used to generate this commit. There were a few changes that had to be done manually, and of course adding the ignore file: ```shell codespell -I .codespell-ignore -x .codespell-ignore -w ``` I didn’t add it to the CI, but this would be a good place for it.
This commit is contained in:
parent
688a1ab082
commit
14fdf07e8f
56 changed files with 152 additions and 141 deletions
|
|
@ -1,6 +1,6 @@
|
|||
# SPA Design
|
||||
|
||||
SPA (Simple Plugin API) is an extensible API to implement alls kinds of plugins.
|
||||
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.
|
||||
|
||||
Plugins are dynamically loadable objects that contain objects and interfaces that
|
||||
|
|
@ -14,7 +14,7 @@ SPA provides the following functionality:
|
|||
|
||||
SPA was designed with the following goals in mind:
|
||||
|
||||
* No dependencies, SPA is shipped as a set of header files that have no dependecies
|
||||
* No dependencies, SPA is shipped as a set of header files that have no dependencies
|
||||
except for the standard c library.
|
||||
* Very efficient both in space and in time.
|
||||
* Very configurable and usable in many different environments. All aspects of
|
||||
|
|
@ -210,7 +210,7 @@ When you retrieve an interface from a handle, you get a reference to
|
|||
a small structure that contains the type (string) of the interface,
|
||||
a version and a structure with a set of methods (and data) that are
|
||||
the implementation of the interface. Calling a method on the interface
|
||||
will just call the apropriate method in the implementation.
|
||||
will just call the appropriate method in the implementation.
|
||||
|
||||
Interfaces are defined in a header file (for example see
|
||||
`<spa/support/log.h>` for the logger API). It is a self contained
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ DBus Variant or LV2 Atom.
|
|||
|
||||
A POD can express nested structures of Objects (with properties), Vectors,
|
||||
Arrays, sequences and various primitives types. All information in the POD
|
||||
is layed out sequentially in memory and can be written directly to
|
||||
is laid out sequentially in memory and can be written directly to
|
||||
storage or exchanged between processes or threads without additional
|
||||
marshalling..
|
||||
|
||||
|
|
@ -27,7 +27,7 @@ PODs can contain a number of basic SPA types:
|
|||
* `SPA_TYPE_Bool`: a boolean value
|
||||
* `SPA_TYPE_Id`: an enumerated value
|
||||
* `SPA_TYPE_Int`, `SPA_TYPE_Long`, `SPA_TYPE_Float`, `SPA_TYPE_Double`:
|
||||
various numerial types, 32 and 64 bits.
|
||||
various numeral types, 32 and 64 bits.
|
||||
* `SPA_TYPE_String`: a string
|
||||
* `SPA_TYPE_Bytes`: a byte array
|
||||
* `SPA_TYPE_Rectangle`: a rectangle with width and height
|
||||
|
|
@ -196,8 +196,8 @@ pod = spa_pod_builder_pop(&b, &f);
|
|||
```
|
||||
|
||||
As you can see, first push the choice as a Range, then the values. A Range
|
||||
choice expects at least 3 values, the default value, mininum and maximum
|
||||
values. There is a shotcut for this as well using varargs:
|
||||
choice expects at least 3 values, the default value, minimum and maximum
|
||||
values. There is a shortcut for this as well using varargs:
|
||||
|
||||
```c
|
||||
pod = spa_pod_builder_add_object(&b,
|
||||
|
|
@ -299,7 +299,7 @@ below.
|
|||
|
||||
## Object Properties
|
||||
|
||||
To iterate over the properies in an object you can do:
|
||||
To iterate over the properties in an object you can do:
|
||||
|
||||
```c
|
||||
struct spa_pod_prop *prop;
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue