Skip to main content

Headless music player server for the Raphson music player

Project description

Headless playback server for Raphson Music

Client for the Raphson Music server that can be controlled remotely via a simple web interface or Home Assistant.

Installation

Using pipx (recommended)

pipx install raphson-music-headless

Run: raphson-music-headless

Using distribution packages

  • Debian: apt install python3-aiohttp python3-vlc
  • Fedora: dnf install python3-aiohttp python3-vlc

Then install the rest from PyPi: pip install --user raphson-music-headless

From Git

git clone https://codeberg.org/raphson/music-headless
cd music-headless
python3 -m raphson_music_headless

To install:

pip install --user .

Usage

  1. Create a config.json file with credentials (see config.json.example).
  2. Run raphson-music-headless --config config.json

By default, the program looks for a configuration file at /etc/raphson-music-headless.json.

API

See API.md

Temporary files

The server writes music to temporary files so VLC can access them. On Linux, the /tmp directory is used for this purpose. It is strongly recommended to mount tmpfs on /tmp to avoid unnecessary writes to your disk, especially when using a Raspberry Pi with sd card.

Check if it is the case by running mount | grep /tmp. It should show something like: tmpfs on /tmp type tmpfs ...

Cache size

The cache_size setting determines the number of cached tracks for each playlist. These tracks are kept in memory, consuming roughly 3 - 6MB per track including cover image. Say cache_size is set to 4 and you use a maximum of 10 playlists, you will need around 200MiB of memory.

Bugs

When playing mono audio (like news), sound may only be played on the left channel. This appears to be an issue with PipeWire.

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

raphson_music_headless-1.1.0.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

raphson_music_headless-1.1.0-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

Details for the file raphson_music_headless-1.1.0.tar.gz.

File metadata

  • Download URL: raphson_music_headless-1.1.0.tar.gz
  • Upload date:
  • Size: 11.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.13.0

File hashes

Hashes for raphson_music_headless-1.1.0.tar.gz
Algorithm Hash digest
SHA256 e87a2c9949e57b0b527f9ed088d6dd9cd260bdbd7c6006403e7c2bbf39407ee6
MD5 9ed19c7fa8eff6f5cc0258f8b16f5359
BLAKE2b-256 8263bc3ff805626c27c9271e7a726eeb32ad09733cfcc7507d25a302e2555609

See more details on using hashes here.

File details

Details for the file raphson_music_headless-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for raphson_music_headless-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3812d7fb071e67b60d408c3899a44240f45889d0bb1744266914dae4ec2b3f51
MD5 d3833ce2447d2f07743b50c7de7d83c1
BLAKE2b-256 a68c4bb4bd1311346e01ffae784fdaef14cf5568362714751e7cda0cc2bd7158

See more details on using hashes here.

Supported by

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