Skip to main content

Audio Control Interface

Project description

[![PyPI Version](https://img.shields.io/pypi/v/volux.svg)](https://pypi.python.org/pypi/volux/)
[![GitHub release](https://img.shields.io/github/release-pre/drtexxofficial/volux.svg)](https://GitHub.com/DrTexxOfficial/volux/releases/)
[![GitHub license](https://img.shields.io/github/license/DrTexxOfficial/volux.svg?branch=master)](https://github.com/DrTexxOfficial/volux/blob/master/LICENSE)
[![Github all releases](https://img.shields.io/github/downloads/DrTexxOfficial/volux/total.svg)](https://GitHub.com/DrTexxOfficial/volux/releases/)
[![Platform: Windows,Mac,Linux](https://img.shields.io/badge/Platform-Windows%20%7C%20Mac%20%7C%20Linux-blue.svg)](#)

Table of contents
=================
<!--ts-->
* [Volux](#volux)
* [Purpose](#purpose)
* [What does it do?](#what-does-it-do)
* [What <em>will</em> it do?](#what-will-it-do)
* [Screenshots](#screenshots)
* [Supported platforms](#supported-platforms)
* [Installation](#installation)
* [Requirements](#requirements)
* [Install via pip](#install-via-pip)
* [Install via wheel (.whl)](#install-via-wheel-whl)
* [Build from source](#build-from-source)
* [Using Volux](#using-volux)
* [Modes](#modes)
* [Volume/brightness](#volumebrightness)
* [Exit](#exit)
* [Issues and bugs](#issues-and-bugs)
<!--te-->
_( generated by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc) )_

# Volux
| BRANCH | BUILD | COVERAGE | REQUIREMENTS | ISSUES | OPEN PRs |
| --- | --- | --- | --- | --- | --- |
| Master | [![Build Status](https://travis-ci.org/DrTexxOfficial/volux.svg?branch=master)](https://travis-ci.org/DrTexxOfficial/volux) | [![codecov](https://codecov.io/gh/DrTexxOfficial/volux/branch/master/graph/badge.svg)](https://codecov.io/gh/DrTexxOfficial/volux) | [![Requirements Status](https://requires.io/github/DrTexxOfficial/volux/requirements.svg?branch=master)](https://requires.io/github/DrTexxOfficial/volux/requirements/?branch=master) | [![GitHub issues](https://img.shields.io/github/issues/DrTexxOfficial/volux.svg?branch=master)](https://GitHub.com/DrTexxOfficial/volux/issues/) | [![GitHub pull-requests](https://img.shields.io/github/issues-pr/DrTexxOfficial/volux.svg?branch=master)](https://GitHub.com/DrTexxOfficial/volux/pull/) |
| Develop | [![Build Status](https://travis-ci.org/DrTexxOfficial/volux.svg?branch=develop)](https://travis-ci.org/DrTexxOfficial/volux) | [![codecov](https://codecov.io/gh/DrTexxOfficial/volux/branch/develop/graph/badge.svg)](https://codecov.io/gh/DrTexxOfficial/volux) | [![Requirements Status](https://requires.io/github/DrTexxOfficial/volux/requirements.svg?branch=develop)](https://requires.io/github/DrTexxOfficial/volux/requirements/?branch=develop)


## Purpose
Volux is an application written in Python 3 aimed at media powerusers.

### What does it do?
Volux allows you to perform many media operations quickly using just your mouse/touchpad.

All interactions are registered when hovering over the Volux bar on your screen.

- Increase/decrease volume using scroll
- Mute/unmute using middle-click

### What _will_ it do?
Features in development / planned for development
- Brightness control via mouse wheel
- Interface customisation

### Screenshots

| Mode | State | Image |
| :---: | :---: | :---: |
| Volume (active) | active | <img src="docs/volume-active.jpg"/> |
| Volume (inactive) | inactive | <img src="docs/volume-inactive.jpg"/> |
| Mute (active) | active | <img src="docs/mute-active.jpg"/> |
| Brightness (active) | active | <img src="docs/brightness-active.jpg"/> |

### Supported platforms

<img src="docs/Platform_Windows.svg" width="14pt"/>&nbsp;&nbsp; Windows 7 or later

<img src="docs/Platform_Mac.svg" width="14pt"/>&nbsp;&nbsp; MacOS _(WIP)_

<img src="docs/Platform_Linux.svg" width="14pt"/>&nbsp;&nbsp; Linux (most distributions)

## Installation
### Requirements
| Platform | External Requirements |
| --- | --- |
| Windows | ```> pip install https://github.com/AndreMiras/pycaw/archive/master.zip``` |
| Darwin (MacOS) | _no external requirements_ |
| Linux | ```$ sudo apt-get install python3-tk python3-xlib python3-dbus libasound2-dev``` |

### Installation
| Installation Method | Command/s | Platforms
| --- | --- | ---
| pip (as user) ***recommended!*** | ```pip install volux --user``` | Windows/Unix
| pip (as root) | ```$ sudo pip install volux``` | Unix
| wheel (.whl) (as user) | ```pip install volux-*-py3-none-any.whl --user``` | Windows/Unix
| wheel (.whl) (as root) | ```$ sudo pip install volux-*-py3-none-any.whl``` | Unix

_note: Under some linux distros all references to 'pip' must be replaced with 'pip3'. Debian is an example of this. This is often the case to prevent confusion between Python 2.7.x interpreters and Python 3.x interpreters_

### Build from source
Clone this repository:

$ git clone https://github.com/DrTexxOfficial/volux.git

Install pip requirements:

$ cd volux
$ pip3 install -r requirements.txt --user

Build:

$ python3 setup.py bdist_wheel

## Using Volux
All interactions with Volux are only valid when hovering over the bar Volux produces. This allows you to interact with Volux without loosing your ability to use your scroll bar in other applications.

### Modes
To cycle between modes in Volux, right-click the main bar. By default, a green bar signifies volume mode and a blue bar signifies brightness mode (wip).

### Volume/brightness
While in volume or brightness mode, scroll up/down to increase/decrease volume or brightness while hovering over the main bar.

### Exit
To exit Volux, double right-click the bar at any time.

## Issues and bugs
If you have any problems running Volux, please kindly post an issue to this repository. Issues can be solved much faster if you can provide:

- Your OS
- Your desktop environment (if using Linux)
- Your python version
- A Summary of issues experienced
- Any relevant screenshot/s

Volux is developed under Debian 9 Stretch (Linux) using GNOME 3.22.2 and Python 3.5. Providing you've correctly installed all dependencies, Volux is almost guranteed to work under these conditions.

Additional testing has been done under these conditions:

| Archi. | Operating System | Desktop Env | Python | Verison | Status | Notes |
| --- | --- | --- | --- | --- | --- | --- |
| 64 bit | Debian 9 Stretch | Gnome 3.22.2 | 3.5 | | Working | Development conditions |
| 64 bit | Ubuntu _ver=?_ | Gnome _ver=?_ | 3.6 | | Working | |
| 64 bit | Windows 10 | N/A | 3.7 | 0.8.15 | Working | Reimplementation successful! |
| 64 bit | Windows 10 | N/A | 3.7.2 | 0.8.15 | Working | |
| 64 bit | Mac OS | N/A | 3.x | | Broken | Dependencies missing |

<br/>

[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

volux-0.8.16.tar.gz (15.4 kB view details)

Uploaded Source

Built Distribution

volux-0.8.16-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

Details for the file volux-0.8.16.tar.gz.

File metadata

  • Download URL: volux-0.8.16.tar.gz
  • Upload date:
  • Size: 15.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.8.1 pkginfo/1.2.1 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.7.0 clint/0.5.1 CPython/3.5.3 Linux/4.9.0-8-amd64

File hashes

Hashes for volux-0.8.16.tar.gz
Algorithm Hash digest
SHA256 a196d2adea66ac2bc2cedc1dd22786dee3dbb67da97e3a32412516a11b9b6bbc
MD5 97b54e82fa693c546576a2c36227e4b1
BLAKE2b-256 63e29fe1382aae20d6fa86ce0b0b3b3a219c2e06ee4bf4b0d8801606fdc5025c

See more details on using hashes here.

File details

Details for the file volux-0.8.16-py3-none-any.whl.

File metadata

  • Download URL: volux-0.8.16-py3-none-any.whl
  • Upload date:
  • Size: 17.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.8.1 pkginfo/1.2.1 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.7.0 clint/0.5.1 CPython/3.5.3 Linux/4.9.0-8-amd64

File hashes

Hashes for volux-0.8.16-py3-none-any.whl
Algorithm Hash digest
SHA256 6afebed52ccd81684082896ec98f29e3b183353ef0f14f1314a3129798995131
MD5 0de5f3731864cff65811dc3a4b28cc70
BLAKE2b-256 07eff286144052a597ba962d8939e8f9da37e1b4e15e9b55de99fb767aa91cea

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page