1libpipewire-module-rt(7)Miscellaneous Information Manuallibpipewire-module-rt(7)
2
3
4

NAME

6       libpipewire-module-rt - RT
7

DESCRIPTION

9       The rt modules can give real-time priorities to processing threads.
10
11       It uses the operating system's scheduler to enable realtime scheduling
12       for certain threads to assist with low latency audio processing. This
13       requires RLIMIT_RTPRIO to be set to a value that's equal to this
14       module's rt.prio parameter or higher. Most distros will come with some
15       package that configures this for certain groups or users. If this is
16       not set up and DBus is available, then this module will fall back to
17       using the Portal Realtime DBus API or RTKit.
18

MODULE NAME

20       libpipewire-module-rt
21

MODULE OPTIONS

23       • nice.level: The nice value set for the application thread. It
24         improves performance of the communication with the pipewire daemon.
25
26       • rt.prio: The realtime priority of the data thread. Higher values are
27         higher priority.
28
29       • rt.time.soft, rt.time.hard: The amount of CPU time an RT thread can
30         consume without doing any blocking calls before the kernel kills the
31         thread. This is a safety measure to avoid lockups of the complete
32         system when some thread consumes 100%.
33
34       • rlimits.enabled: enable the use of rtlimits, default true.
35
36       • rtportal.enabled: enable the use of realtime portal, default true
37
38       • rtkit.enabled: enable the use of rtkit, default true
39
40       • uclamp.min: the minimum utilisation value the scheduler should
41         consider
42
43       • uclamp.max: the maximum utilisation value the scheduler should
44         consider
45
46       The nice level is by default set to an invalid value so that clients
47       don't automatically have the nice level raised.
48
49       The PipeWire server processes are explicitly configured with a valid
50       nice level.
51

EXAMPLE CONFIGURATION

53       context.modules = [
54       {   name = libpipewire-module-rt
55           args = {
56               #nice.level   = 20
57               #rt.prio      = 88
58               #rt.time.soft = -1
59               #rt.time.hard = -1
60               #rlimits.enabled = true
61               #rtportal.enabled = true
62               #rtkit.enabled = true
63               #uclamp.min = 0
64               #uclamp.max = 1024
65           }
66           flags = [ ifexists nofail ]
67       }
68       ]
69
70PipeWire                             1.0.0            libpipewire-module-rt(7)
Impressum