Reference

libpipewire-module-example-source(7)

Example Source

NAME

libpipewire-module-example-source - Example Source

DESCRIPTION

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

MODULE 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

GENERAL 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 ]
        }
    }
}
]

History