media-controller 0.3.0

A setup agnostic media controller
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

# Media Controller

<div>
  <img alt="Crates.io Version" src="https://img.shields.io/crates/v/media-controller?style=flat-square">
</div>
<br/>

`media-controller` provides a GTK 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
content of the existing one providing a smooth experience.

![Demo](https://raw.githubusercontent.com/ndavd/media-controller/main/.github/demo.gif)

[Options used in the demo:
`--color=#000000aa --font-description="BigBlueTerm437 Nerd Font Mono"`]

In order to build the binary or the library you must pick a Cargo feature:

- `regular`: For X11 and other systems, uses GTK3
- `wayland`: For Wayland systems, uses GTK4 and GTK4 Layer Shell (make sure to
  have [`gtk-layer-shell`](https://github.com/wmww/gtk-layer-shell) installed)

```
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 specific system, simply create a new cargo
project and add the library with the respective feature enabled:

```
cargo add media-controller --features wayland
```

Then all it takes is implementing some functions. Your `main.rs` should look
something like this:

```rust
/// 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](https://github.com/ndavd/media-controller/blob/main/src/main.rs).

It is particularly useful to map `media-controller` to your media keys. E.g.
using `sxhkd`:

```
# 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
```