Rockbox open source high quality audio player as a Music Player Daemon
mpris
rockbox
mpd
libadwaita
audio
rust
zig
deno
Add example responses to OpenAPI spec
+588
-18
+588
-18
mintlify/api-reference/openapi.json
+588
-18
mintlify/api-reference/openapi.json
···
47
47
"description": "Array of albums",
48
48
"content": {
49
49
"application/json": {
50
-
"schema": { "type": "array", "items": { "$ref": "#/components/schemas/Album" } }
50
+
"schema": { "type": "array", "items": { "$ref": "#/components/schemas/Album" } },
51
+
"example": [
52
+
{
53
+
"id": "cmodxew8w0053pdmdmro8vx0w",
54
+
"title": "2014 Forest Hills Drive",
55
+
"artist": "J. Cole",
56
+
"year": 2014,
57
+
"year_string": "2014-12-09",
58
+
"album_art": "216ccc791352fbbffc11268b984db19a.jpg",
59
+
"md5": "7efed3c16a2ea54a2c090e40f03107d4",
60
+
"artist_id": "cmodw19po0005pdmd6k9mwauv",
61
+
"label": null,
62
+
"copyright_message": "℗ 2014 Cole World/Interscope Records"
63
+
},
64
+
{
65
+
"id": "cmjodpk0r00j8pdoc5r5eko46",
66
+
"title": "21 Reasons (feat. Ella Henderson)",
67
+
"artist": "Nathan Dawe",
68
+
"year": 2019,
69
+
"year_string": "2019-05-31",
70
+
"album_art": "53682046896b8c9c6118c169cfd03ff8.jpg",
71
+
"md5": "3997d22d81a895c867827ef6f4f83477",
72
+
"artist_id": "cmjodpk0r00j7pdocuh1vu2vx",
73
+
"label": null,
74
+
"copyright_message": "under exclusive licence to Warner Music UK Limited, ℗ 2020 Nathan Dawe"
75
+
}
76
+
]
51
77
}
52
78
}
53
79
}
···
94
120
"responses": {
95
121
"200": {
96
122
"description": "Tracks belonging to the album",
97
-
"content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Track" } } } }
123
+
"content": {
124
+
"application/json": {
125
+
"schema": { "type": "array", "items": { "$ref": "#/components/schemas/Track" } },
126
+
"example": [
127
+
{
128
+
"id": "cmodxew97005epdmdvt8ar73r",
129
+
"path": "/Users/tsirysandratraina/Music/J. Cole - 2014 Forest Hills Drive (Explicit)/01. J. Cole - Intro (Explicit).m4a",
130
+
"title": "Intro",
131
+
"artist": "J. Cole",
132
+
"album": "2014 Forest Hills Drive",
133
+
"album_artist": "J. Cole",
134
+
"bitrate": 320,
135
+
"composer": "",
136
+
"disc_number": 1,
137
+
"filesize": 5168762,
138
+
"frequency": 44100,
139
+
"length": 129199,
140
+
"track_number": 1,
141
+
"year": 2014,
142
+
"year_string": "2014-12-09",
143
+
"md5": "07576ce8ea7906aa36bf05ae93cb1643",
144
+
"album_art": "216ccc791352fbbffc11268b984db19a.jpg",
145
+
"artist_id": "cmodw19po0005pdmd6k9mwauv",
146
+
"album_id": "cmodxew8w0053pdmdmro8vx0w",
147
+
"genre_id": "",
148
+
"is_remote": false,
149
+
"created_at": 1777096568,
150
+
"updated_at": 1777096568
151
+
},
152
+
{
153
+
"id": "cmodxew9a005opdmddc5l9y63",
154
+
"path": "/Users/tsirysandratraina/Music/J. Cole - 2014 Forest Hills Drive (Explicit)/02. J. Cole - January 28th (Explicit).m4a",
155
+
"title": "January 28th",
156
+
"artist": "J. Cole",
157
+
"album": "2014 Forest Hills Drive",
158
+
"album_artist": "J. Cole",
159
+
"bitrate": 320,
160
+
"composer": "",
161
+
"disc_number": 1,
162
+
"filesize": 9710586,
163
+
"frequency": 44100,
164
+
"length": 242744,
165
+
"track_number": 2,
166
+
"year": 2014,
167
+
"year_string": "2014-12-09",
168
+
"md5": "e6914133fcbcf8771fbf156c485b8459",
169
+
"album_art": "216ccc791352fbbffc11268b984db19a.jpg",
170
+
"artist_id": "cmodw19po0005pdmd6k9mwauv",
171
+
"album_id": "cmodxew8w0053pdmdmro8vx0w",
172
+
"genre_id": "",
173
+
"is_remote": false,
174
+
"created_at": 1777096568,
175
+
"updated_at": 1777096568
176
+
}
177
+
]
178
+
}
179
+
}
98
180
}
99
181
}
100
182
}
···
105
187
"tags": ["Artists"],
106
188
"summary": "List all artists",
107
189
"responses": {
108
-
"200": { "description": "Array of artists", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Artist" } } } } }
190
+
"200": {
191
+
"description": "Array of artists",
192
+
"content": {
193
+
"application/json": {
194
+
"schema": { "type": "array", "items": { "$ref": "#/components/schemas/Artist" } },
195
+
"example": [
196
+
{
197
+
"id": "cmjftbrug03ipsl3jo6fggigk",
198
+
"name": "A Perfect Circle",
199
+
"image": "https://i.scdn.co/image/ab6761610000e5eb41472573351dfea479a4ffba",
200
+
"genres": "alternative metal"
201
+
},
202
+
{
203
+
"id": "cmo7132f7006epdouye8onwe7",
204
+
"name": "Ab-Soul, Anderson .Paak, James Blake"
205
+
}
206
+
]
207
+
}
208
+
}
209
+
}
109
210
}
110
211
}
111
212
},
···
141
242
"summary": "List albums by an artist",
142
243
"parameters": [{ "$ref": "#/components/parameters/IdPath" }],
143
244
"responses": {
144
-
"200": { "description": "Albums by the artist", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Album" } } } } }
245
+
"200": {
246
+
"description": "Albums by the artist",
247
+
"content": {
248
+
"application/json": {
249
+
"schema": { "type": "array", "items": { "$ref": "#/components/schemas/Album" } },
250
+
"example": [
251
+
{
252
+
"id": "cmodxew8w0053pdmdmro8vx0w",
253
+
"title": "2014 Forest Hills Drive",
254
+
"artist": "J. Cole",
255
+
"year": 2014,
256
+
"year_string": "2014-12-09",
257
+
"album_art": "216ccc791352fbbffc11268b984db19a.jpg",
258
+
"md5": "7efed3c16a2ea54a2c090e40f03107d4",
259
+
"artist_id": "cmodw19po0005pdmd6k9mwauv",
260
+
"label": null,
261
+
"copyright_message": "℗ 2014 Cole World/Interscope Records"
262
+
},
263
+
{
264
+
"id": "cmodw1a5l003dpdmd39obvgay",
265
+
"title": "Might Delete Later",
266
+
"artist": "J. Cole",
267
+
"year": 2024,
268
+
"year_string": "2024-04-05",
269
+
"album_art": "85b108fff8d0cabd396a2e79885f2752.jpg",
270
+
"md5": "ddbdd86c1fc7e7f1b5b901d83c83aaf2",
271
+
"artist_id": "cmodw19po0005pdmd6k9mwauv",
272
+
"label": null,
273
+
"copyright_message": "℗ 2024 Cole World, Inc., under exclusive license to Interscope Records"
274
+
}
275
+
]
276
+
}
277
+
}
278
+
}
145
279
}
146
280
}
147
281
},
···
152
286
"summary": "List tracks by an artist",
153
287
"parameters": [{ "$ref": "#/components/parameters/IdPath" }],
154
288
"responses": {
155
-
"200": { "description": "Tracks by the artist", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Track" } } } } }
289
+
"200": {
290
+
"description": "Tracks by the artist",
291
+
"content": {
292
+
"application/json": {
293
+
"schema": { "type": "array", "items": { "$ref": "#/components/schemas/Track" } },
294
+
"example": [
295
+
{
296
+
"id": "cmodxew9o006spdmdnhqjh8ab",
297
+
"path": "/Users/tsirysandratraina/Music/J. Cole - 2014 Forest Hills Drive (Explicit)/04. J. Cole - 03’ Adolescence (Explicit).m4a",
298
+
"title": "03’ Adolescence",
299
+
"artist": "J. Cole",
300
+
"album": "2014 Forest Hills Drive",
301
+
"album_artist": "J. Cole",
302
+
"bitrate": 320,
303
+
"composer": "",
304
+
"disc_number": 1,
305
+
"filesize": 10570653,
306
+
"frequency": 44100,
307
+
"length": 264259,
308
+
"track_number": 4,
309
+
"year": 2014,
310
+
"year_string": "2014-12-09",
311
+
"md5": "0edf984c5a9cb95e6d9003b47f10e991",
312
+
"album_art": "216ccc791352fbbffc11268b984db19a.jpg",
313
+
"artist_id": "cmodw19po0005pdmd6k9mwauv",
314
+
"album_id": "cmodxew8w0053pdmdmro8vx0w",
315
+
"genre_id": "",
316
+
"is_remote": false,
317
+
"created_at": 1777096568,
318
+
"updated_at": 1777096568
319
+
},
320
+
{
321
+
"id": "cmodw19qb002apdmd476zdpfv",
322
+
"path": "/Users/tsirysandratraina/Music/J. Cole - The Fall-Off (Explicit)/101. J. Cole - 29 Intro (Explicit).m4a",
323
+
"title": "29 Intro",
324
+
"artist": "J. Cole",
325
+
"album": "The Fall-Off",
326
+
"album_artist": "J. Cole",
327
+
"bitrate": 320,
328
+
"composer": "",
329
+
"disc_number": 1,
330
+
"filesize": 2311779,
331
+
"frequency": 44100,
332
+
"length": 57779,
333
+
"track_number": 1,
334
+
"year": 2026,
335
+
"year_string": "2026-02-06",
336
+
"md5": "72ee494cab9aba116e2fe724e347dc59",
337
+
"album_art": "20a95234ea29a20884f5c6a1ef5ad592.jpg",
338
+
"artist_id": "cmodw19po0005pdmd6k9mwauv",
339
+
"album_id": "cmodw19pi0001pdmdv76spfpp",
340
+
"genre_id": "",
341
+
"is_remote": false,
342
+
"created_at": 1777094253,
343
+
"updated_at": 1777094253
344
+
}
345
+
]
346
+
}
347
+
}
348
+
}
156
349
}
157
350
}
158
351
},
···
162
355
"tags": ["Tracks"],
163
356
"summary": "List all tracks in the library",
164
357
"responses": {
165
-
"200": { "description": "All tracks", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Track" } } } } }
358
+
"200": {
359
+
"description": "All tracks",
360
+
"content": {
361
+
"application/json": {
362
+
"schema": { "type": "array", "items": { "$ref": "#/components/schemas/Track" } },
363
+
"example": [
364
+
{
365
+
"id": "cmnvrqv4k002zpdwax7lrsbhh",
366
+
"path": "/Users/tsirysandratraina/Music/Juicy J - The Trippy Tapes Vol. 1 (Explicit)/26. Juicy J, DJ Scream, Babyfxce E - Scotty (feat. Babyfxce E ) (Explicit).m4a",
367
+
"title": " Scotty (feat. Babyfxce E )",
368
+
"artist": "Juicy J, DJ Scream, Babyfxce E",
369
+
"album": "The Trippy Tapes Vol. 1",
370
+
"album_artist": "Juicy J, DJ Scream",
371
+
"bitrate": 320,
372
+
"composer": "",
373
+
"disc_number": 1,
374
+
"filesize": 6746791,
375
+
"frequency": 44100,
376
+
"length": 168664,
377
+
"track_number": 26,
378
+
"year": 2026,
379
+
"year_string": "2026-04-03",
380
+
"md5": "b418a0d44e61ef179005ff9a13d5c8bd",
381
+
"album_art": "8c8b3a145776af32d29ea293691ecaa8.jpg",
382
+
"artist_id": "cmnvrqv3b0000pdwaux8uj1d2",
383
+
"album_id": "cmnvrqv3b0001pdwatmcq1aqt",
384
+
"genre_id": "",
385
+
"is_remote": false,
386
+
"created_at": 1775998658,
387
+
"updated_at": 1775998658
388
+
}
389
+
]
390
+
}
391
+
}
392
+
}
166
393
}
167
394
}
168
395
},
···
302
529
{ "name": "show_hidden", "in": "query", "schema": { "type": "string", "enum": ["true", "false"] }, "description": "Show dotfiles (default false)" }
303
530
],
304
531
"responses": {
305
-
"200": { "description": "Directory entries", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TreeEntry" } } } } },
532
+
"200": {
533
+
"description": "Directory entries",
534
+
"content": {
535
+
"application/json": {
536
+
"schema": { "type": "array", "items": { "$ref": "#/components/schemas/TreeEntry" } },
537
+
"example": [
538
+
{
539
+
"name": "/Users/tsirysandratraina/Music/Union Of Sound - Acoustic - A Quiet Night In (Explicit)",
540
+
"attr": 16,
541
+
"time_write": 1768805953,
542
+
"customaction": 0
543
+
},
544
+
{
545
+
"name": "/Users/tsirysandratraina/Music/Media.localized",
546
+
"attr": 16,
547
+
"time_write": 1766757435,
548
+
"customaction": 0
549
+
},
550
+
{
551
+
"name": "/Users/tsirysandratraina/Music/Cannons - Up All Night EP",
552
+
"attr": 16,
553
+
"time_write": 1766430051,
554
+
"customaction": 0
555
+
}
556
+
]
557
+
}
558
+
}
559
+
},
306
560
"500": { "description": "Path is not a directory or other I/O error" }
307
561
}
308
562
}
···
541
795
"tags": ["Playlist (queue)"],
542
796
"summary": "List tracks currently in the queue",
543
797
"responses": {
544
-
"200": { "description": "Mp3Entry list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Mp3Entry" } } } } }
798
+
"200": {
799
+
"description": "Mp3Entry list",
800
+
"content": {
801
+
"application/json": {
802
+
"schema": { "type": "array", "items": { "$ref": "#/components/schemas/Mp3Entry" } },
803
+
"example": [
804
+
{
805
+
"path": "/Users/tsirysandratraina/Music/Cannons - All I Need/1. Cannons - All I Need.m4a",
806
+
"title": "All I Need",
807
+
"artist": "Cannons",
808
+
"album": "All I Need",
809
+
"albumartist": "Cannons",
810
+
"composer": "",
811
+
"genre_string": "",
812
+
"tracknum": 1,
813
+
"discnum": 1,
814
+
"year": 2025,
815
+
"year_string": "2025-10-17",
816
+
"length": 227073,
817
+
"elapsed": 0,
818
+
"filesize": 9083647,
819
+
"bitrate": 320,
820
+
"frequency": 44100,
821
+
"id": null,
822
+
"album_id": null,
823
+
"artist_id": null,
824
+
"genre_id": null,
825
+
"album_art": null
826
+
}
827
+
]
828
+
}
829
+
}
830
+
}
545
831
}
546
832
},
547
833
"post": {
···
576
862
"summary": "Get the live queue and its metadata",
577
863
"parameters": [{ "$ref": "#/components/parameters/IdPath" }],
578
864
"responses": {
579
-
"200": { "description": "PlaylistInfo", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaylistInfo" } } } }
865
+
"200": {
866
+
"description": "PlaylistInfo",
867
+
"content": {
868
+
"application/json": {
869
+
"schema": { "$ref": "#/components/schemas/PlaylistInfo" },
870
+
"example": {
871
+
"amount": 1,
872
+
"index": 0,
873
+
"first_index": 0,
874
+
"last_insert_pos": 0,
875
+
"max_playlist_size": 10000,
876
+
"seed": 0,
877
+
"last_shuffled_start": 0,
878
+
"entries": [
879
+
{
880
+
"path": "/Users/tsirysandratraina/Music/Cannons - All I Need/1. Cannons - All I Need.m4a",
881
+
"title": "All I Need",
882
+
"artist": "Cannons",
883
+
"album": "All I Need",
884
+
"albumartist": "Cannons",
885
+
"composer": "",
886
+
"genre_string": "",
887
+
"tracknum": 1,
888
+
"discnum": 1,
889
+
"year": 2025,
890
+
"year_string": "2025-10-17",
891
+
"length": 227073,
892
+
"elapsed": 0,
893
+
"filesize": 9083647,
894
+
"bitrate": 320,
895
+
"frequency": 44100,
896
+
"id": "cmjhiwtrq002vslny83sh3cpc",
897
+
"album_id": "cmjhiwtr6002fslnyzl17c1rn",
898
+
"artist_id": "cmjhiwtqz0003slnyk5x8akqo",
899
+
"genre_id": "",
900
+
"album_art": "b0cf2a54ef92afc1796c506f641f8b68.jpg"
901
+
}
902
+
]
903
+
}
904
+
}
905
+
}
906
+
}
580
907
}
581
908
}
582
909
},
···
589
916
{ "name": "folder_id", "in": "query", "schema": { "type": "string" } }
590
917
],
591
918
"responses": {
592
-
"200": { "description": "Saved playlists", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SavedPlaylist" } } } } }
919
+
"200": {
920
+
"description": "Saved playlists",
921
+
"content": {
922
+
"application/json": {
923
+
"schema": { "type": "array", "items": { "$ref": "#/components/schemas/SavedPlaylist" } },
924
+
"example": [
925
+
{
926
+
"id": "68920507-2d77-4a89-afae-79626f570ad0",
927
+
"name": "rap",
928
+
"description": null,
929
+
"image": null,
930
+
"folder_id": null,
931
+
"track_count": 1,
932
+
"created_at": 1777133688,
933
+
"updated_at": 1777135103
934
+
}
935
+
]
936
+
}
937
+
}
938
+
}
593
939
}
594
940
},
595
941
"post": {
···
660
1006
"tags": ["Saved playlists"],
661
1007
"summary": "List tracks in a saved playlist",
662
1008
"responses": {
663
-
"200": { "description": "Tracks", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Track" } } } } }
1009
+
"200": {
1010
+
"description": "Tracks",
1011
+
"content": {
1012
+
"application/json": {
1013
+
"schema": { "type": "array", "items": { "$ref": "#/components/schemas/Track" } },
1014
+
"example": [
1015
+
{
1016
+
"id": "cmodxew9c005tpdmde8b4v7jn",
1017
+
"path": "/Users/tsirysandratraina/Music/J. Cole - 2014 Forest Hills Drive (Explicit)/06. J. Cole - Fire Squad (Explicit).m4a",
1018
+
"title": "Fire Squad",
1019
+
"artist": "J. Cole",
1020
+
"album": "2014 Forest Hills Drive",
1021
+
"album_artist": "J. Cole",
1022
+
"bitrate": 320,
1023
+
"composer": "",
1024
+
"disc_number": 1,
1025
+
"filesize": 11527315,
1026
+
"frequency": 44100,
1027
+
"length": 288169,
1028
+
"track_number": 6,
1029
+
"year": 2014,
1030
+
"year_string": "2014-12-09",
1031
+
"md5": "cffdfee6f1cccb4f25581f9f4f4820d3",
1032
+
"album_art": "216ccc791352fbbffc11268b984db19a.jpg",
1033
+
"artist_id": "cmodw19po0005pdmd6k9mwauv",
1034
+
"album_id": "cmodxew8w0053pdmdmro8vx0w",
1035
+
"genre_id": "",
1036
+
"is_remote": false,
1037
+
"created_at": 1777096568,
1038
+
"updated_at": 1777096568
1039
+
}
1040
+
]
1041
+
}
1042
+
}
1043
+
}
664
1044
}
665
1045
},
666
1046
"post": {
···
925
1305
"tags": ["Devices"],
926
1306
"summary": "List all known output devices (discovered + virtual)",
927
1307
"responses": {
928
-
"200": { "description": "Devices", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Device" } } } } }
1308
+
"200": {
1309
+
"description": "Devices",
1310
+
"content": {
1311
+
"application/json": {
1312
+
"schema": { "type": "array", "items": { "$ref": "#/components/schemas/Device" } },
1313
+
"example": [
1314
+
{
1315
+
"id": "builtin",
1316
+
"name": "Rockbox (Built-in)",
1317
+
"host": "localhost",
1318
+
"ip": "127.0.0.1",
1319
+
"port": 0,
1320
+
"service": "builtin",
1321
+
"app": "builtin",
1322
+
"is_connected": false,
1323
+
"base_url": null,
1324
+
"is_cast_device": false,
1325
+
"is_source_device": false,
1326
+
"is_current_device": true
1327
+
},
1328
+
{
1329
+
"id": "fifo",
1330
+
"name": "Snapcast (FIFO)",
1331
+
"host": "localhost",
1332
+
"ip": "127.0.0.1",
1333
+
"port": 0,
1334
+
"service": "fifo",
1335
+
"app": "fifo",
1336
+
"is_connected": false,
1337
+
"base_url": null,
1338
+
"is_cast_device": false,
1339
+
"is_source_device": false,
1340
+
"is_current_device": false
1341
+
},
1342
+
{
1343
+
"id": "squeezelite",
1344
+
"name": "Squeezelite",
1345
+
"host": "localhost",
1346
+
"ip": "127.0.0.1",
1347
+
"port": 3483,
1348
+
"service": "squeezelite",
1349
+
"app": "squeezelite",
1350
+
"is_connected": false,
1351
+
"base_url": null,
1352
+
"is_cast_device": false,
1353
+
"is_source_device": false,
1354
+
"is_current_device": false
1355
+
},
1356
+
{
1357
+
"id": "158759fe25f1a23ac2e12721b038e860",
1358
+
"name": "Salon TV",
1359
+
"host": "158759fe-25f1-a23a-c2e1-2721b038e860.local",
1360
+
"ip": "192.168.1.60",
1361
+
"port": 8009,
1362
+
"service": "chromecast",
1363
+
"app": "chromecast",
1364
+
"is_connected": false,
1365
+
"base_url": null,
1366
+
"is_cast_device": true,
1367
+
"is_source_device": false,
1368
+
"is_current_device": false
1369
+
},
1370
+
{
1371
+
"id": "snapcast-192.168.1.220",
1372
+
"name": "Snapcast",
1373
+
"host": "pi4-2.local",
1374
+
"ip": "192.168.1.220",
1375
+
"port": 4953,
1376
+
"service": "snapcast",
1377
+
"app": "Snapcast",
1378
+
"is_connected": false,
1379
+
"base_url": null,
1380
+
"is_cast_device": true,
1381
+
"is_source_device": false,
1382
+
"is_current_device": false
1383
+
},
1384
+
{
1385
+
"id": "92736CF1CD65@Pi4._raop._tcp.local.",
1386
+
"name": "Pi4",
1387
+
"host": "pi4-2.local",
1388
+
"ip": "192.168.1.220",
1389
+
"port": 5000,
1390
+
"service": "airplay",
1391
+
"app": "AirPlay",
1392
+
"is_connected": false,
1393
+
"base_url": null,
1394
+
"is_cast_device": true,
1395
+
"is_source_device": false,
1396
+
"is_current_device": false
1397
+
}
1398
+
]
1399
+
}
1400
+
}
1401
+
}
929
1402
}
930
1403
}
931
1404
},
···
936
1409
"summary": "Get a device by id (use 'current' for the active sink)",
937
1410
"parameters": [{ "$ref": "#/components/parameters/IdPath" }],
938
1411
"responses": {
939
-
"200": { "description": "Device", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device" } } } },
1412
+
"200": {
1413
+
"description": "Device",
1414
+
"content": {
1415
+
"application/json": {
1416
+
"schema": { "$ref": "#/components/schemas/Device" },
1417
+
"example": {
1418
+
"id": "builtin",
1419
+
"name": "Rockbox (Built-in)",
1420
+
"host": "localhost",
1421
+
"ip": "127.0.0.1",
1422
+
"port": 0,
1423
+
"service": "builtin",
1424
+
"app": "builtin",
1425
+
"is_connected": false,
1426
+
"base_url": null,
1427
+
"is_cast_device": false,
1428
+
"is_source_device": false,
1429
+
"is_current_device": true
1430
+
}
1431
+
}
1432
+
}
1433
+
},
940
1434
"404": { "$ref": "#/components/responses/NotFound" }
941
1435
}
942
1436
}
···
969
1463
"tags": ["Settings"],
970
1464
"summary": "Get the global settings (in-memory snapshot)",
971
1465
"responses": {
972
-
"200": { "description": "Settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalSettings" } } } }
1466
+
"200": {
1467
+
"description": "Settings",
1468
+
"content": {
1469
+
"application/json": {
1470
+
"schema": { "$ref": "#/components/schemas/GlobalSettings" },
1471
+
"example": {
1472
+
"music_dir": "/Users/tsirysandratraina/Music",
1473
+
"volume_limit": 320,
1474
+
"balance": 0,
1475
+
"bass": 1,
1476
+
"treble": 0,
1477
+
"channel_config": 0,
1478
+
"stereo_width": 100,
1479
+
"crossfade": 5,
1480
+
"crossfade_fade_in_delay": 7,
1481
+
"crossfade_fade_out_delay": 7,
1482
+
"crossfade_fade_in_duration": 1,
1483
+
"crossfade_fade_out_duration": 1,
1484
+
"playlist_shuffle": false,
1485
+
"repeat_mode": 846620009,
1486
+
"eq_enabled": true,
1487
+
"eq_precut": 7,
1488
+
"eq_band_settings": [
1489
+
{ "cutoff": -16, "q": 64, "gain": 10 },
1490
+
{ "cutoff": 9, "q": 125, "gain": 10 },
1491
+
{ "cutoff": 21, "q": 250, "gain": 10 },
1492
+
{ "cutoff": 9, "q": 500, "gain": 10 },
1493
+
{ "cutoff": -35, "q": 1000, "gain": 10 },
1494
+
{ "cutoff": -81, "q": 2000, "gain": 10 },
1495
+
{ "cutoff": -41, "q": 4000, "gain": 10 },
1496
+
{ "cutoff": 1, "q": 8000, "gain": 10 },
1497
+
{ "cutoff": 15, "q": 16000, "gain": 7 },
1498
+
{ "cutoff": 24, "q": 0, "gain": 0 }
1499
+
],
1500
+
"replaygain_settings": {
1501
+
"noclip": true,
1502
+
"type": 0,
1503
+
"preamp": 0
1504
+
},
1505
+
"compressor_settings": {
1506
+
"threshold": -24,
1507
+
"makeup_gain": 0,
1508
+
"ratio": 4,
1509
+
"knee": 1,
1510
+
"release_time": 300,
1511
+
"attack_time": 5
1512
+
},
1513
+
"dithering_enabled": true,
1514
+
"timestretch_enabled": false,
1515
+
"play_frequency": 3400,
1516
+
"surround_enabled": 0,
1517
+
"surround_balance": -25
1518
+
}
1519
+
}
1520
+
}
1521
+
}
973
1522
}
974
1523
},
975
1524
"put": {
···
999
1548
"tags": ["System"],
1000
1549
"summary": "Get global runtime status",
1001
1550
"responses": {
1002
-
"200": { "description": "Global status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalStatus" } } } }
1551
+
"200": {
1552
+
"description": "Global status",
1553
+
"content": {
1554
+
"application/json": {
1555
+
"schema": { "$ref": "#/components/schemas/GlobalStatus" },
1556
+
"example": {
1557
+
"volume": 0,
1558
+
"resume_index": 0,
1559
+
"resume_crc32": 3654789000,
1560
+
"resume_elapsed": 0,
1561
+
"resume_offset": 0,
1562
+
"runtime": 10000,
1563
+
"topruntime": 10000,
1564
+
"dircache_size": 1016,
1565
+
"last_screen": -8,
1566
+
"viewer_icon_count": -1,
1567
+
"last_volume_change": 0
1568
+
}
1569
+
}
1570
+
}
1571
+
}
1003
1572
}
1004
1573
}
1005
1574
},
···
1168
1737
"TreeEntry": {
1169
1738
"type": "object",
1170
1739
"properties": {
1171
-
"name": { "type": "string", "description": "Absolute path" },
1172
-
"time_write": { "type": "integer", "format": "int64", "description": "Unix timestamp of last modification" },
1173
-
"attr": { "type": "integer", "format": "int32", "description": "0x10 = directory" }
1740
+
"name": { "type": "string", "description": "Absolute path" },
1741
+
"time_write": { "type": "integer", "format": "int64", "description": "Unix timestamp of last modification" },
1742
+
"attr": { "type": "integer", "format": "int32", "description": "0x10 = directory" },
1743
+
"customaction": { "type": "integer", "format": "int32" }
1174
1744
}
1175
1745
},
1176
1746
"Mp3Entry": {