libpipewire-module-example-source(7)

libpipewire-module-example-source7

Example source

Overview

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

We refer to the source code for more information.

Module name

libpipewire-module-example-source

Options

•

node.name: a unique name for the stream

•

node.description: a human readable name for the stream

•

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

Options

Options with well-known behavior.

•

remote.name

•

audio.format

•

audio.rate

•

audio.channels

•

audio.layout

•

audio.position

•

media.name

•

node.latency

•

node.name

•

node.description

•

node.group

•

node.virtual

•

media.class

Example configuration

# ~/.config/pipewire/pipewire.conf.d/my-example-source.conf
context.modules = [
{   name = libpipewire-module-example-source
    args = {
        node.name = "example_source"
        node.description = "My Example Source"
        stream.props = {
            audio.position = [ FL FR ]
        }
    }
}
]

Releases

2 releases since Debian 13 (Trixie); the text changed 1 time.

  1. 13
  2. Arch

From libpipewire 1:1.6.10-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.