-
Notifications
You must be signed in to change notification settings - Fork 20
/
config_schema.json
240 lines (240 loc) · 7.4 KB
/
config_schema.json
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
{
"$schema": "http://json-schema.org/draft-06/schema#",
"$ref": "#/definitions/config",
"definitions": {
"config": {
"type": "object",
"additionalProperties": false,
"properties": {
"log_level": {
"type": "string",
"description": "Logging level for the application",
"enum": [
"panic",
"fatal",
"error",
"warn",
"warning",
"info",
"debug",
"trace"
],
"default": "info"
},
"device_id": {
"type": "string",
"description": "The device ID in hex",
"minLength": 40,
"maxLength": 40
},
"device_name": {
"type": "string",
"description": "The device name showed in the Spotify UI",
"default": "go-librespot"
},
"device_type": {
"type": "string",
"description": "The device type showed in the Spotify UI",
"enum": [
"computer",
"tablet",
"smartphone",
"speaker",
"tv",
"avr",
"stb",
"audio_dongle",
"game_console",
"cast_video",
"cast_audio",
"automobile",
"smartwatch",
"chromebook",
"car_thing",
"observer",
"home_thing"
],
"default": "computer"
},
"client_token": {
"type": "string",
"description": "The Spotify client token"
},
"audio_backend": {
"type": "string",
"description": "Which audio backend (API) should be used for playback, leave empty for default",
"enum": [
"alsa",
"pulseaudio"
],
"default": "alsa"
},
"audio_device": {
"type": "string",
"description": "Which audio device should be used for playback, leave empty for default",
"default": "default"
},
"mixer_device": {
"type": "string",
"description": "Which audio mixer should be used for volume control, leave empty to disable mixer control",
"default": ""
},
"mixer_control_name": {
"type": "string",
"description": "Which control should be used, leave empty for default. Only useful in combination with 'mixer_device'",
"default": "Master"
},
"audio_buffer_time": {
"type": "integer",
"description": "The audio buffer time in microseconds. Available for ALSA backend only, leave empty for default",
"default": 0
},
"audio_period_count": {
"type": "integer",
"description": "The number of audio periods to request. Available for ALSA backend only, leave empty for default",
"default": 0
},
"server": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether to enable the API server",
"default": false
},
"address": {
"type": "string",
"description": "Which address to bind for the API server",
"default": "localhost"
},
"port": {
"type": "integer",
"description": "Which port to bind for the API server",
"default": 0
},
"allow_origin": {
"type": "string",
"description": "The value for the Access-Control-Allow-Origin header",
"default": ""
},
"cert_file": {
"type": "string",
"description": "File path of the certificate file to use for TLS",
"default": ""
},
"key_file": {
"type": "string",
"description": "File path of the private key file to use for TLS",
"default": ""
}
}
},
"zeroconf_enabled": {
"type": "boolean",
"description": "Whether Zeroconf discovery should always be enabled (even when logging in with credentials)",
"default": false
},
"zeroconf_port": {
"type": "integer",
"description": "The port to use for the Zeroconf service (empty for random)",
"default": 0
},
"credentials": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The authentication method",
"enum": [
"interactive",
"spotify_token",
"zeroconf"
],
"default": "zeroconf"
},
"interactive": {
"type": "object",
"description": "Authenticate with the interactive browser UI",
"properties": {
"callback_port": {
"type": "integer",
"default": 0
}
}
},
"spotify_token": {
"type": "object",
"description": "Authentication with username and access token",
"properties": {
"username": {
"type": "string",
"default": ""
},
"access_token": {
"type": "string",
"default": ""
}
}
},
"zeroconf": {
"type": "object",
"description": "Authenticate with Zeroconf (auto discovery)",
"properties": {
"persist_credentials": {
"type": "boolean",
"description": "Whether credentials from the Zeroconf session should be persisted",
"default": false
}
}
}
}
},
"bitrate": {
"type": "integer",
"description": "The preferred bitrate for audio playback, default is 160kbps",
"enum": [
96,
160,
320
],
"default": 160
},
"volume_steps": {
"type": "integer",
"description": "The number of volume steps",
"min": 1,
"default": 100
},
"initial_volume": {
"type": "integer",
"description": "Initial volume in steps (not applied to the mixer device)",
"min": 0,
"default": 100
},
"normalisation_disabled": {
"type": "boolean",
"description": "Whether track/album normalisation should be disabled",
"default": false
},
"normalisation_pregain": {
"type": "number",
"description": "The normalisation pregain to apply to track/album normalisation factors",
"default": 0
},
"external_volume": {
"type": "boolean",
"description": "Whether volume is controlled externally, if true the app will not pre-multiply samples",
"default": false
},
"disable_autoplay": {
"type": "boolean",
"description": "Whether autoplay of more songs should be disabled",
"default": false
}
},
"required": [
],
"title": "config"
}
}
}