libpipewire-module-example-sink - Man Page

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

libpipewire-module-example-sink

• 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 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

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

libpipewire-modules(7).