pipewire/doc/tutorial1.dox

59 lines
1.6 KiB
Text
Raw Normal View History

/** \page page_tutorial1 Tutorial - Part 1: Getting started
2020-06-11 15:32:52 +02:00
\ref page_tutorial "Index" | \ref page_tutorial2
2020-06-11 09:51:32 +02:00
In this tutorial we show the basics of a simple PipeWire application.
Use this tutorial to get started and help you set up your development
environment.
## Initialization
Let get started with the simplest application.
\code{.c}
#include <pipewire/pipewire.h>
2020-06-11 09:51:32 +02:00
int main(int argc, char *argv[])
{
pw_init(&argc, &argv);
fprintf(stdout, "Compiled with libpipewire %s\n"
"Linked with libpipewire %s\n",
pw_get_headers_version(),
pw_get_library_version());
return 0;
}
\endcode
2020-06-11 09:51:32 +02:00
Before you can use any PipeWire functions, you need to call `pw_init()`.
## Compilation
PipeWire provides a pkg-config file named `libpipewire-0.3` (note: the version
suffix may change with future releases of pipewire).
2020-06-11 09:51:32 +02:00
To compile the simple test application, copy it into a test1.c file and
use pkg-config to provide the required dependencies:
2020-06-11 09:51:32 +02:00
gcc -Wall test1.c -o test1 $(pkg-config --cflags --libs libpipewire-0.3)
2020-06-11 09:51:32 +02:00
then run it with:
# ./test1
Compiled with libpipewire 0.3.5
Linked with libpipewire 0.3.5
#
Use your build system's pkg-config support to integrate it into your project.
For example, a minimal [meson.build](https://mesonbuild.com/) entry would look
like this:
project('test1', ['c'])
pipewire_dep = dependency('libpipewire-0.3')
executable('test1', 'test1.c',
dependencies: [pipewire_dep])
\ref page_tutorial "Index" | \ref page_tutorial2
2020-06-11 09:51:32 +02:00
*/