mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-05 13:30:02 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

modules: document metadata module

Browse source
This commit is contained in:
Wim Taymans 2025-01-27 16:13:14 +01:00
parent e210925c24
commit 4d5ed3f292
1 changed files with 16 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

24
src/modules/module-metadata.c
View file

@ -20,13 +20,19 @@
* *
* Allows clients to create a metadata store. * Allows clients to create a metadata store.
* *
* This module creates a new factory. Clients that can see the factory * Both the client and the server need to load this module for the metadata to be
* can use the factory name (`metadata`) to create a new metadata * useful.
* objects with \ref pw_core_create_object(). It is also possible to create
* objects in the config file.
* *
* Objects of the \ref PW_TYPE_INTERFACE_Metadata will be created and a proxy * This module creates a new factory and a new export type for the
* to it will be returned. * \ref PW_TYPE_INTERFACE_Metadata interface.
*
* A client will first create an implementation of the PW_TYPE_INTERFACE_Metadata
* interface with \ref pw_context_create_metadata(), for example. With the
* \ref pw_core_export(), this module will create a server size resource to expose
* the metadata implementation to other clients. Modifications done by the client
* on the local metadata interface will be visible to all PipeWire clients.
*
* It is also possible to create metadata in the config file.
* *
* As an argument to the create_object call, a set of properties will * As an argument to the create_object call, a set of properties will
* control the name of the metadata and some initial values. * control the name of the metadata and some initial values.
@ -61,7 +67,8 @@
* *
* ## Example configuration * ## Example configuration
* *
* The module is usually added to the config file of the main pipewire daemon. * The module is usually added to the config file of the main PipeWire daemon and the
* clients.
* *
*\code{.unparsed} *\code{.unparsed}
* context.modules = [ * context.modules = [
@ -72,7 +79,8 @@
* ## Config objects * ## Config objects
* *
* To create an object from the factory, one can use the \ref pw_core_create_object() * To create an object from the factory, one can use the \ref pw_core_create_object()
* method or make an object in the `context.objects` section like: * method or make an object in the `context.objects` section like in the main PipeWire
* daemon config file:
* *
*\code{.unparsed} *\code{.unparsed}
* context.objects = [ * context.objects = [