libpipewire-module-example-filter(7)          Miscellaneous Information Manual

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
       o node.description: a human readable name for the filter streams

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

       o 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:

       o remote.name

       o audio.rate

       o audio.channels

       o audio.position

       o media.name

       o node.latency

       o node.description

       o node.group

       o node.link.group

       o node.virtual

       o node.name: See notes below. If not specified, defaults to
         'filter-<pid>-<module-id>'.

       Stream only properties:

       o media.class

       o 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
       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] }'



PipeWire                             1.0.6
                                          libpipewire-module-example-filter(7)