.TH "libpipewire-module-profiler" 7 "1.6.4" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
libpipewire-module-profiler \- Profiler 
.SH DESCRIPTION
.PP
The profiler module provides a Profiler interface for applications that can be used to receive profiling information\&.

.PP
Use tools like pw-top and pw-profiler to collect profiling information about the pipewire graph\&.

.PP
.SH "MODULE NAME"
.PP

.PP
\fRlibpipewire-module-profiler\fP

.PP
.SH "MODULE OPTIONS"
.PP

.PP
.IP "\(bu" 2
\fRprofile\&.interval\&.ms\fP: Can be used to avoid gathering profiling information on every processing cycle\&. This allows trading off CPU usage for profiling accuracy\&. Default 0
.PP

.PP
.SH "CONFIG OVERRIDE"
.PP

.PP
A \fRmodule\&.profiler\&.args\fP config section can be added to override the module arguments\&.

.PP
.PP
.nf
# ~/\&.config/pipewire/pipewire\&.conf\&.d/my\-profiler\-args\&.conf

module\&.profiler\&.args = {
    #profile\&.interval\&.ms = 10
}
.fi
.PP

.PP
.SH "EXAMPLE CONFIGURATION"
.PP

.PP
The module is usually added to the config file of the main pipewire daemon\&.

.PP
.PP
.nf
context\&.modules = [
{ name = libpipewire\-module\-profiler
  args = {
      #profile\&.interval\&.ms = 0
  }
}
]
.fi
.PP

.PP
.SH "SEE ALSO"
.PP

.PP
.IP "\(bu" 2
\fRpw-top\fP: a tool to display realtime profiler data
.IP "\(bu" 2
\fRpw-profiler\fP: a tool to collect and render profiler data 
.PP


