Reference

libpipewire-module-example-filter(7)

Example Filter

NAME

libpipewire-module-example-filter - Example Filter

DESCRIPTION

The example filter is a good starting point for writing a custom filter.

We refer to the source code for more information.

MODULE NAME

libpipewire-module-example-filter

MODULE OPTIONS

•

node.description: a human readable name for the filter streams

•

capture.props = {}: properties to be passed to the input stream

•

playback.props = {}: properties to be passed to the output stream

GENERAL OPTIONS

Options with well-known behavior. Most options can be added to the global configuration or the individual streams:

•

remote.name

•

audio.rate

•

audio.channels

•

audio.layout

•

audio.position

•

media.name

•

node.latency

•

node.description

•

node.group

•

node.link.group

•

node.virtual

•

node.name : See notes below. If not specified, defaults to 'filter-PID-MODULEID'.

Stream only properties:

•

media.class

•

node.name : if not given per stream, the global node.name will be prefixed with 'input.' and 'output.' to generate a capture and playback stream node.name respectively.

EXAMPLE CONFIGURATION OF A VIRTUAL SOURCE

# ~/.config/pipewire/pipewire.conf.d/my-example-filter.conf
context.modules = [
{   name = libpipewire-module-example-filter
    args = {
      node.description = "Example Filter"
      capture.props = {
          audio.position = [ FL FR ]
          node.passive = true
      }
      playback.props = {
          node.name = "Example Filter"
          media.class = "Audio/Source"
          audio.position = [ FL FR ]
      }
    }
}
]


pw-cli -m lm libpipewire-module-example-filter '{ audio.position=[FL FR] }'

History