summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGeorge Kiagiadakis <george.kiagiadakis@collabora.com>2021-08-03 12:50:45 +0300
committerGeorge Kiagiadakis <george.kiagiadakis@collabora.com>2021-08-03 12:51:20 +0300
commitb436c72ce47b6cd47d8311cae23bd65cb2fba771 (patch)
treed2eefa6b69d9d907bd1f6b121a60792b7eb98b43 /README.md
parent684d1b175d14b455d3a8f88da00aace451d7d516 (diff)
Signed-off-by: George Kiagiadakis <george.kiagiadakis@collabora.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 97d88c2..558c360 100644
--- a/README.md
+++ b/README.md
@@ -87,6 +87,23 @@ To demo it with `libpipewire-module-protocol-ic-ipc` being the server, use:
* `send SUSPEND` - suspend playback on the host
* `send RESUME` - resume playback on the host
+## Writing IC apps that use libicipc
+
+IC apps that need to use this SUSPEND/RESUME mechanism for sound, should
+directly use libicipc.
+
+For API documentation, refer to `lib/client.h`. Clients should use only
+the API provided in this file.
+
+To link to libicipc, use the provided `icipc-0.1` pkg-config package:
+```
+$ pkg-config --cflags --libs icipc-0.1
+```
+
+By default, the libicipc library is built statically. If you wish to build
+a dynamically linked version, pass the `-Ddefault_library=dynamic` option to
+meson when compiling `pipewire-ic-ipc`
+
## Compilation & Running
To compile: