queue_add_rand_album

🟡 Incomplete

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

Add a random Album to the queue.

Inputs

FieldTypeDescription
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
offsetoptional (maybe-null) unsigned integerSee Queue/offset

Outputs

FieldTypeDescription
albumAlbum objectThe Album that was added to the queue

Example Request 1

Add to back of the queue.

festival-cli queue_add_rand_album --append back

curl http://localhost:18425 -d '{"jsonrpc":"2.0","id":0,"method":"queue_add_rand_album","params":{"append":"back","clear":false,"play":false}}'

Example Request 2

Insert at queue index 4.

festival-cli queue_add_rand_album --append index --index 4

curl http://localhost:18425 -d '{"jsonrpc":"2.0","id":0,"method":"queue_add_rand_album","params":{"append":"index","clear":false,"play":false,"index":4}}'

Example Request 3

Clear the queue, add all the Song's in this Album, but start at the 5th Song (offset 4).

festival-cli queue_add_rand_album --append front --clear --play --offset 4

curl http://localhost:18425 -d '{"jsonrpc":"2.0","id":0,"method":"queue_add_rand_album","params":{"append":"front","clear":true,"play":true,"offset":4}}'

Example Response

{
  "jsonrpc": "2.0",
  "result": {
    "album": {
      "title": "RAINBOW",
      "key": 237,
      "artist": 65,
      "release": "????-??-??",
      "runtime": 1090,
      "song_count": 6,
      "songs": [
        2594,
        2540,
        2600,
        2496,
        2557,
        2500
      ],
      "discs": 0,
      "art": 7753,
      "genre": null
    }
  },
  "id": 0
}