LIBPIPEWIRE-MODULE-EXAMPLE-SOURCE(7)

✨ libpipewire-module-example-source(7) ✨

okay bestie, welcome to the Miscellaneous Information Manual πŸ’– this little page is all about libpipewire-module-example-source, and honestly? it's giving starter pack energy, in the best way.


πŸŽ€ NAME πŸŽ€

libpipewire-module-example-source β€” Example Source πŸ‘‘


🌸 DESCRIPTION 🌸

so the example source is literally the perfect lil starting point if you wanna write your own custom source πŸ¦‹ like, it's the blueprint, the moment, the template.

for more info we just point you at the source code, iykyk πŸ‘€


πŸ’… MODULE NAME πŸ’…

libpipewire-module-example-source


✨ MODULE OPTIONS ✨

these are the options that belong to this module specifically:

  • node.name β€” a unique name for the stream, no duplicates allowed bestie 🫢
  • node.description β€” a human readable name for the stream, the cute one people actually see
  • stream.props = {} β€” properties to be passed to the stream πŸ’«

🌈 GENERAL OPTIONS 🌈

these ones are options with well-known behavior β€” the classics, the icons:

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

here's what it looks like fr fr, copy it, love it, make it yours:

# ~/.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 ]
        }
    }
}
]

πŸ’‘ heads up bestie: that file path up there? ~/.config/pipewire/pipewire.conf.d/my-example-source.conf β€” that's exactly where this goes, don't @ me.

and that's the whole page, periodt. this was PipeWire 1.6.11 in the Miscellaneous Information Manual β€” go forth and write the most iconic custom source ever, you got this πŸ’–βœ¨πŸŽ€πŸ¦‹πŸŒΈπŸ‘‘

πŸ“¦ where this page comes from