diff --git a/src/modules/module-example-sink.c b/src/modules/module-example-sink.c index a0651b096..ebdc2671e 100644 --- a/src/modules/module-example-sink.c +++ b/src/modules/module-example-sink.c @@ -49,6 +49,47 @@ #include /** \page page_module_example_sink PipeWire Module: Example Sink + * + * The example sink is a good starting point for writing a custom + * sink. We refer to the source code for more information. + * + * ## Module Options + * + * - `node.name`: a unique name for the stream + * - `node.description`: a human readable name for the stream + * - `stream.props = {}`: properties to be passed to the stream + * + * ## General options + * + * Options with well-known behavior. + * + * - \ref PW_KEY_REMOTE_NAME + * - \ref PW_KEY_AUDIO_RATE + * - \ref PW_KEY_AUDIO_CHANNELS + * - \ref SPA_KEY_AUDIO_POSITION + * - \ref PW_KEY_MEDIA_NAME + * - \ref PW_KEY_NODE_LATENCY + * - \ref PW_KEY_NODE_NAME + * - \ref PW_KEY_NODE_DESCRIPTION + * - \ref PW_KEY_NODE_GROUP + * - \ref PW_KEY_NODE_VIRTUAL + * - \ref PW_KEY_MEDIA_CLASS + * + * ## Example configuration + * + *\code{.unparsed} + * context.modules = [ + * { name = libpipewire-module-example-sink + * args = { + * node.name = "example_sink" + * node.description = "My Example Sink" + * stream.props = { + * audio.position = [ FL FR ] + * } + * } + * } + * ] + *\endcode */ #define NAME "example-sink" diff --git a/src/modules/module-example-source.c b/src/modules/module-example-source.c index 21d9d75bd..5d653e54d 100644 --- a/src/modules/module-example-source.c +++ b/src/modules/module-example-source.c @@ -49,6 +49,47 @@ #include /** \page page_module_example_source PipeWire Module: Example Source + * + * The example source is a good starting point for writing a custom + * source. We refer to the source code for more information. + * + * ## Module Options + * + * - `node.name`: a unique name for the stream + * - `node.description`: a human readable name for the stream + * - `stream.props = {}`: properties to be passed to the stream + * + * ## General options + * + * Options with well-known behavior. + * + * - \ref PW_KEY_REMOTE_NAME + * - \ref PW_KEY_AUDIO_RATE + * - \ref PW_KEY_AUDIO_CHANNELS + * - \ref SPA_KEY_AUDIO_POSITION + * - \ref PW_KEY_MEDIA_NAME + * - \ref PW_KEY_NODE_LATENCY + * - \ref PW_KEY_NODE_NAME + * - \ref PW_KEY_NODE_DESCRIPTION + * - \ref PW_KEY_NODE_GROUP + * - \ref PW_KEY_NODE_VIRTUAL + * - \ref PW_KEY_MEDIA_CLASS + * + * ## Example configuration + * + *\code{.unparsed} + * context.modules = [ + * { name = libpipewire-module-example-source + * args = { + * node.name = "example_source" + * node.description = "My Example Source" + * stream.props = { + * audio.position = [ FL FR ] + * } + * } + * } + * ] + *\endcode */ #define NAME "example-source"