summaryrefslogtreecommitdiff
path: root/README.md
blob: 53a3c81a648b9c71690456c848b662f7755ce27e (plain)
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
# soundbox-app

This is a graphical application to use [soundbox][1] devices. It is able to
stream from a web radio URL to one or multiple soundbox devices simultaneously.

## Usage

A configuration file like this has to be placed at
`~/.config/soundbox/config.json` for the application to work:

```
{
	"soundboxes": [
		{
			"name": "sb1",
			"mac": "00:00:5e:00:53:01",
			"enabled": true
		},
		{
			"name": "sb2",
			"mac": "00:00:5e:00:53:02",
			"enabled": false
		}
	],
	"urls": [
		{
			"name": "Radio One",
			"url": "https://example.org/radio/one.mp3"
		},
		{
			"name": "Radio Two",
			"url": "https://example.org/radio/two.mp3"
		}
	]
}
```

The [Go][2] and the [ffmpeg][3] tools are required to use the app. It can be
build and started like this:

```
go run ./...
```

[1]: https://xengineering.eu/git/soundbox
[2]: https://go.dev
[3]: https://ffmpeg.org