🟡 Incomplete

This API's output may have additions in the future.

Add a Song to the queue with an Artist name Album title, and Song title.


artiststringArtist name
albumstringAlbum title
songstringSong title
appendstring, one of front, back or indexSee Queue/Append
clearbooleanShould the queue be cleared before adding?
playbooleanShould we start playing?
indexoptional (maybe-null) unsigned integerIf the index append is chosen, this will be the index used


result: null if everything went ok.

error: ... if there was an index/offset error.

Example Request 1

Add to back of the queue.

festival-cli queue_add_map_song --artist TWICE --album "PAGE TWO" --song "CHEER UP" --append back
curl http://localhost:18425 -d '{"jsonrpc":"2.0","id":0,"method":"queue_add_map_song","params":{"artist":"TWICE","album":"PAGE TWO","song":"CHEER UP","append":"back","clear":false,"play":false}}'

Example Request 2

Insert at queue index 4, start from Song 3 (offset 2).

festival-cli queue_add_map_song --artist TWICE --album "PAGE TWO"  --song "CHEER UP" --append index --index 4 
curl http://localhost:18425 -d '{"jsonrpc":"2.0","id":0,"method":"queue_add_map_song","params":{"artist":"TWICE","album":"PAGE TWO","song":"CHEER UP","append":"index","clear":false,"play":false,"index":4}}'

Example Request 3

Clear the queue, add the Song "CHEER UP".

festival-cli queue_add_map_song --artist TWICE --album "PAGE TWO" --song "CHEER UP" --append front --clear --play
curl http://localhost:18425 -d '{"jsonrpc":"2.0","id":0,"method":"queue_add_map_song","params":{"artist":"TWICE","album":"PAGE TWO","song":"CHEER UP","append":"front","clear":true,"play":true}}'

Example Response

  "jsonrpc": "2.0",
  "result": null, // <--- everything went ok.
  "id": 0