mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-10-31 22:25:38 -04:00
modules: update docs
This commit is contained in:
parent
75f4fca1d7
commit
10af59bdc2
2 changed files with 26 additions and 0 deletions
|
|
@ -103,6 +103,10 @@
|
||||||
* }
|
* }
|
||||||
* ]
|
* ]
|
||||||
*\endcode
|
*\endcode
|
||||||
|
|
||||||
|
* ## See also
|
||||||
|
*
|
||||||
|
* `pw-loopback` : a tools thats loads the loopback module with given parameters.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#define NAME "loopback"
|
#define NAME "loopback"
|
||||||
|
|
|
||||||
|
|
@ -42,6 +42,28 @@
|
||||||
#include <pipewire/extensions/profiler.h>
|
#include <pipewire/extensions/profiler.h>
|
||||||
|
|
||||||
/** \page page_module_profiler PipeWire Module: Profiler
|
/** \page page_module_profiler PipeWire Module: Profiler
|
||||||
|
*
|
||||||
|
* The profiler module provides a Profiler interface for applications that
|
||||||
|
* can be used to receive profiling information.
|
||||||
|
*
|
||||||
|
* Use tools like pw-top and pw-profiler to collect profiling information
|
||||||
|
* about the pipewire graph.
|
||||||
|
*
|
||||||
|
* ## Example configuration
|
||||||
|
*
|
||||||
|
* The module has no arguments and is usually added to the config file of
|
||||||
|
* the main pipewire daemon.
|
||||||
|
*
|
||||||
|
*\code{.unparsed}
|
||||||
|
* context.modules = [
|
||||||
|
* { name = libpipewire-module-profiler }
|
||||||
|
* ]
|
||||||
|
*\endcode
|
||||||
|
*
|
||||||
|
* ## See also
|
||||||
|
*
|
||||||
|
* `pw-top`: a tool to display realtime profiler data
|
||||||
|
* `pw-profiler`: a tool to collect and render profiler data
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#define NAME "profiler"
|
#define NAME "profiler"
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue