supershush

command module
v0.0.0-...-a45f01a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 11, 2024 License: MIT Imports: 5 Imported by: 0

README

Logo

SuperShush

Stop audio from playing when the audio output changes
Report Bug · Request Feature

What is SuperShush?

SuperShush is a daemon that is designed to prevent audio from continuing to play when the output device is changed, such as when switching from headphones to speakers.

Installation

To stop audio playback when the output device is changed, SuperShush requires the playerctl package if the option in the config is enabled.

From Source

To compile SuperShush from source, you'll need to have Go installed on your system. You can download the Go installer from the official Go website.

Once you have Go installed, run the following command to install SuperShush:

go install codeberg.org/tomkoid/supershush@0.2.1

Running

To run supershush, simply execute the supershush command:

supershush

This will start the SuperShush daemon, which will monitor audio output changes and stop audio playback when necessary.

Configuring

To configure SuperShush, you can edit the configuration file located at ~/.config/supershush/config.toml. Here is an example configuration file:

# Resume audio after you change output back
# WARNING: This feature is not stable yet. The current implementation has big issues.
# Example: audio is playing on audio 1 and then you switch to
#          audio 2, the audio gets paused. after you switch
#          back to audio 1, the audio gets unmuted.
resume = false

# Enable MPC pausing 
mpc = false

# Enable playerctl stopping 
playerctl = true

License

SuperShush is licensed under the MIT License. See the LICENSE file for more information.

Contributing

If you'd like to contribute to SuperShush, please fork the repository and submit a pull request with your changes. You can also report issues or suggest new features on the issue tracker.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL