SFWBAR-PULSE(1)

πŸ“¦ version 1.0~beta13, in ubuntu noble, ubuntu questing

πŸ’– SFWBAR-PULSE(1) πŸ’–

okay bestie, sit DOWN, because this is the sfwbar-pulse page and it's literally the Sfwbar PulseAudio module and she is serving audio control realness 🎧✨

  • Filename: pulsectl.so
  • Requires: libpulse

no cap, that's the whole vibe. now let's get into it 🫢


✨ SYNOPSIS ✨

the PulseAudio module gives you an interface to query and adjust the settings of the PulseAudio server. that's it, that's the job, and she does it flawlessly πŸ’…


🌸 EXPRESSION FUNCTIONS 🌸

πŸ’œ Pulse(Query[,Interface])

so the Pulse function queries the state of the Pulse server. the Query parameter tells it what info you want, and the optional Interface parameter tells it which interface that query is about. if you don't hand over an Interface, the query just gets applied to the current sink or the current source β€” default behaviour, she's flexible like that 😌

the supported query types are, in order, and yes you need all of them:

  • "sink-volume" β€” the volume of a sink πŸ”Š
  • "sink-mute" β€” muted state of the sink πŸ”‡
  • "sink-icon" β€” sink icon πŸŽ€
  • "sink-form" β€” the form of the sink
  • "sink-port" β€” the port name of the sink
  • "sink-monitor" β€” name of the source monitor for the sink πŸ‘€
  • "source-volume" β€” the volume of a source πŸ”Š
  • "source-mute" β€” muted state of the source πŸ”‡
  • "source-icon" β€” source icon 🌟
  • "source-form" β€” the form of the source
  • "source-port" β€” the port name of the source
  • "source-monitor" β€” name of the sink monitor for the source πŸ‘€

like, sink girlies and source girlies both get full treatment, as they should πŸ’–


πŸ”₯ ACTIONS πŸ”₯

πŸ’… PulseCmd [Interface,],Command

this one manipulates the state of the interface β€” she's not just reading, she's doing. and if you don't specify the interface? the Command just gets applied to the current interface. effortless. main character energy fr fr ✨

the commands:

  • "sink-volume +/-X" β€” adjust the volume of the sink by X%. that +/- is doing the heavy lifting, you either go up or you go down, pick a lane bestie πŸ“ˆπŸ“‰
  • "sink-mute State" β€” change the state of the sink. State can be On, Off or Toggle πŸ”‡
  • "source-volume +/-X" β€” adjust the volume of the source by X%. same deal, +/-, up or down, iconic behaviour 🎚️
  • "source-mute State" β€” change the state of the source. State can be On, Off or Toggle πŸ”ˆ

⭐ TRIGGERS ⭐

the module defines exactly one trigger, and it's called "Pulse". it gets emitted whenever the state of the pulse server changes. so like, any time anything shifts, she's tapping you on the shoulder like "bestie. something happened." πŸ“£πŸ¦‹


GPLv3+


and that's the whole page, no notes πŸ’€

okay so that's sfwbar-pulse(1) from the General Commands Manual, section 1, all wrapped up πŸŽ€ go forth and control your audio, you absolute legend, mwah πŸ’–βœ¨πŸŒˆπŸ«Ά

πŸ“¦ where this page comes from