Manpage logo

libpipewire-module-example-sink - Example Sink

NAME  DESCRIPTION  MODULE NAME  MODULE OPTIONS  GENERAL OPTIONS  EXAMPLE CONFIGURATION 

NAME

libpipewire-module-example-sink − Example Sink

DESCRIPTION

The example sink is a good starting point for writing a custom sink. We refer to the source code for more information.

MODULE NAME

libpipewire-module-example-sink

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.position

•

media.name

•

node.latency

•

node.name

•

node.description

•

node.group

•

node.virtual

•

media.class

EXAMPLE CONFIGURATION

# ˜/.config/pipewire/pipewire.conf.d/my−example−sink.conf

context.modules = [
{ name = libpipewire−module−example−sink
args = {
node.name = "example_sink"
node.description = "My Example Sink"
stream.props = {
audio.position = [ FL FR ]
}
}
}
]


Updated 2026-06-01 - jenkler.se | uex.se