yned / mpris-ctrl

Command-line utility for controlling media players that support MPRIS (vlc, audacity, bmp, xmms2, spotify (partial), etc.)

mpris-ctrl

Command-line utility for controlling media players supporting MPRIS (vlc, audacity, bmp, xmms2, spotify (partial), etc.)

About

mpris-ctrl simplifies common D-Bus message commands that are supported by the MPRIS D-Bus interface specification

Installing

mpris-ctrl is a standalone script, and is installed by placing it (or symlinking to) somewhere in the PATH variable.

A suggested way to download and install for all users:

sudo git clone https://github.com/swarminglogic/mpris-ctrl.git /opt/mpris-ctrl
sudo ln -s /opt/mpris-ctrl/mpris-ctrl.sh /usr/local/bin/mpris-ctrl

Usage / Supported Commands

USAGE:
mpris-ctrl [OPTIONS]
mpris-ctrl PLAYER COMMAND [ARGUMENTS]

OPTIONS:
-h, --help              Show help
-v, --version           Print version information
-l, --list              Lists available NAME targets

COMMANDS (ROOT):
raise                   Raises player window
quit                    Quits player

COMMANDS (PLAYER):
play                    Issues play command
pause                   Issues pause command
stop                    Issues stop command
play-pause              Toggles between playing and pausing
next                    Plays next item in playlist
prev[ious]              Plays previous item in playlist
status                  Displays the status of the player
volume                  Get volume level.
volume [LEVEL]          Set volume level.
                        LEVEL should be in range [0.0, 1.0]

COMMANDS (PLAYLIST):
tracks                  Displays tracks
add-track PATH [PLAY]   Appends file PATH to playlist.
                        PLAY should be one of {true, false(default)}
                        If true: append and skip to this item in the playlist.
                        If false, append the item to the playlist.

Examples

Listing active and supported MPRIS player targets:

$ mpris-ctrl -l

Toggling spotify play-pause:

$ mpris-ctrl spotify play-pause

Jump to next spotify track:

$ mpris-ctrl spotify next

Append video to vlc playlist:

$ mpris-ctrl vlc add-track video.mp4

License

The mpris-ctrl utility is licensed under the MIT License.

See LICENSE