summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWim Taymans <wtaymans@redhat.com>2020-02-22 12:28:07 +0100
committerWim Taymans <wtaymans@redhat.com>2020-02-22 12:28:07 +0100
commit603e511122fc8566f4796501ff1093e4b424e9e9 (patch)
treed93811038f42ba40ca14512bfd17ff57387604f2
parente31bfc78acfab10d3c25eed74fbcfe4eba517047 (diff)
docs: update docsdoc
-rw-r--r--src/pipewire/context.h20
-rw-r--r--src/pipewire/pipewire.h13
2 files changed, 25 insertions, 8 deletions
diff --git a/src/pipewire/context.h b/src/pipewire/context.h
index 9007a30c..c3b5273b 100644
--- a/src/pipewire/context.h
+++ b/src/pipewire/context.h
@@ -36,9 +36,25 @@ extern "C" {
*
* \brief the PipeWire context
*
- * The context object manages all available resources.
+ * The context object manages all locally available resources. It
+ * is used by both clients and servers.
*
- * See \ref page_context_api
+ * The context is used to:
+ *
+ * - Load modules and extend the functionality. This includes
+ * extending the protocol with new object types or creating
+ * any of the available objects.
+ *
+ * - Create implementations of various objects like nodes,
+ * devices, factories, modules, etc.. This will usually also
+ * create pw_global objects that can then be shared with
+ * clients.
+ *
+ * - Connect to another PipeWire instance (the main daemon, for
+ * example) and interact with it (See \subpage page_core_api).
+ *
+ * - Export a local implementation of an object to another
+ * instance.
*/
struct pw_context;
diff --git a/src/pipewire/pipewire.h b/src/pipewire/pipewire.h
index 7a7fd017..b3b6bae5 100644
--- a/src/pipewire/pipewire.h
+++ b/src/pipewire/pipewire.h
@@ -67,15 +67,16 @@ extern "C" {
* This document describes the API for the PipeWire multimedia framework.
* The API consists of two parts:
*
- * \li The context API and tools to build new modules (See
- * \subpage page_context_api)
- * \li The remote API (See \subpage page_remote_api)
+ * \li The core API to access a PipeWire instance.
+ * (See \subpage page_core_api)
+ * \li The implementation API and tools to build new objects and
+ * modules (See \subpage page_implementation_api)
*
* \section sec_errors Error reporting
*
- * Functions return either NULL or a negative int error code when an
- * error occurs. Error codes are used from the SPA plugin library on
- * which PipeWire is built.
+ * Functions return either NULL with errno set or a negative int error
+ * code when an error occurs. Error codes are used from the SPA plugin
+ * library on which PipeWire is built.
*
* Some functions might return asynchronously. The error code for such
* functions is positive and SPA_RESULT_IS_ASYNC() will return true.