Crates.io | media-controller |
lib.rs | media-controller |
version | 0.2.1 |
source | src |
created_at | 2024-01-02 22:41:05.35317 |
updated_at | 2024-01-03 18:42:44.380258 |
description | A setup agnostic media controller |
homepage | |
repository | https://github.com/ndavd/media-controller |
max_upload_size | |
id | 1086736 |
size | 548,171 |
media-controller
provides a GTK-3 always-on-top window with transparency
support that displays the current volume/brightness right after changing it
accordingly.
It makes use of UNIX sockets so that if another instance is created while the first one is running, it doesn't create another window and simply updates the value of the other providing a smooth experience.
[Options used in the demo: --color=#000000aa --font-description="BigBlueTerm437 Nerd Font Mono"
]
media-controller v0.2.1
Nuno David <email@ndavd.com>
USAGE:
media-controller [OPTIONS] v up|down|mute {number}
media-controller [OPTIONS] b up|down {number}
OPTIONS:
Format --{option}={value}
duration Lifespan of the window in seconds. Default: 2
width Width of the window in px. Default: 300
height Height of the window in px. Default: 20
bottom Offset from the bottom of the screen in px. Default: 100
color Color of the window in hex (#RRGGBB or #RRGGBBAA). Default: "#000000FF"
font-description Font used. Default: "Monospace 13"
filled Filled character used in the progress bar. Default: "█"
half-filled Half filled character used in the progress bar. Default: "▌"
empty Empty character used in the progress bar. Default: " "
In order to make it work in your system simply create a new cargo project. Add the library:
cargo add media-controller
And then all it takes is implementing some functions. Your main.rs
should look
something like this:
/// Should toggle mute.
fn toggle_mute() {
todo!();
}
/// Should return whether it's muted.
fn get_mute() -> bool {
todo!();
}
/// Should return the volume (0-100).
fn get_volume() -> u8 {
todo!();
}
/// Should return the brightness (0-100).
fn get_brightness() -> u8 {
todo!();
}
/// Should increment the volume. To decrement use a negative value.
fn inc_volume(value: i8) {
todo!();
}
/// Should increment the brightness. To decrement use a negative value.
fn inc_brightness(value: i8) {
todo!();
}
fn main() {
/// Pass `Some` to use custom options.
/// Pass `None` to manage them through command line arguments.
let custom_controller = None;
controller::MediaControllerApp {
toggle_mute,
get_mute,
get_volume,
get_brightness,
inc_volume,
inc_brightness,
custom_controller,
}
.run();
}
A concrete example for a Linux system that uses wpctl
and brightnessctl
can
be found at
src/main.rs.
It is then particularly useful to map media-controller
to your media keys.
Using sxhkd
it should look something like this:
# Volume Control
XF86AudioLowerVolume
media-controller v down 5
XF86AudioRaiseVolume
media-controller v up 5
XF86AudioMute
media-controller v mute
# Brightness Control
XF86MonBrightnessDown
media-controller b down 5
XF86MonBrightnessUp
media-controller b up 5