music-assistant-server

1.5 KBMD
README.md
1.5 KB32 lines • markdown
1# AriaCast Server (Go Implementation)
2
3This binary is a high-performance, lightweight receiver implementation for the AriaCast protocol, written in Go. It allows your Music Assistant instance to discover, connect to, and stream audio from AriaCast sources effortlessly.
4
5[AriaCast Server Go](https://github.com/AirPlr/AriaCast-Server-GO)
6
7## Features
8
9-   **UDP Discovery**: Automatically announces itself to AriaCast clients on the network.
10-   **Low Latency Streaming**: Receives audio via WebSocket and forwards it directly to a named pipe or local playback.
11-   **Metadata Sync**: Real-time updates for Track Title, Artist, Album, and Artwork.
12-   **Control API**: Supports playback controls (Play/Pause/Next/Previous) via HTTP/WebSocket.
13-   **Web Dashboard**: Optional built-in web interface for testing and playback monitoring.
14-   **Pipe Bridge**: Seamless integration with players (like `mpv` or `sox`) via named pipes.
15
16## Endpoints
17
18The server runs primarily on **port 12889**, alongside a UDP listener on **port 12888**.
19
20-   **UDP 12888**: Service Discovery (Responds to `DISCOVER_AUDIOCAST`).
21-   **WS `ws://IP:12889/audio`**: Binary audio stream receiver.
22-   **WS `ws://IP:12889/metadata`**: Metadata updates.
23-   **WS `ws://IP:12889/control`**: Remote control commands.
24-   **POST `http://IP:12889/api/command`**: Send commands like `play`, `pause`, `next`.
25
26## Audio Format
27
28The server defaults to the following audio configuration:
29-   **Sample Rate**: 48000 Hz
30-   **Channels**: 2 (Stereo)
31-   **Bit Depth**: 16-bit
32