PipeWire 1.1.0
Loading...
Searching...
No Matches
Example Sink

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.

Example configuration

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