From 7a46c07230b8d8108c0e8e80df4522d0ac116538 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 20:28:17 +0200 Subject: Adding upstream version 0.3.65. Signed-off-by: Daniel Baumann --- doc/tutorial1.dox | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 doc/tutorial1.dox (limited to 'doc/tutorial1.dox') diff --git a/doc/tutorial1.dox b/doc/tutorial1.dox new file mode 100644 index 0000000..6e88cce --- /dev/null +++ b/doc/tutorial1.dox @@ -0,0 +1,47 @@ +/** \page page_tutorial1 Tutorial - Part 1: Getting Started + + +\ref page_tutorial "Index" | \ref page_tutorial2 + +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. + +\snippet tutorial1.c code + +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). +To compile the simple test application, copy it into a test1.c file and +use pkg-config to provide the required dependencies: + + gcc -Wall test1.c -o test1 $(pkg-config --cflags --libs libpipewire-0.3) + +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 + +*/ -- cgit v1.2.3