queue_add_rand_artist

🟡 Incomplete

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

Add a random Artist 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
artistArtist objectThe Artist that was added to the queue

Example Request 1

Add to back of the queue.

festival-cli queue_add_rand_artist --append back

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

Example Request 2

Insert at queue index 4.

festival-cli queue_add_rand_artist --append index --index 4

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

Example Request 3

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

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

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

Example Response

{
  "jsonrpc": "2.0",
  "result": {
    "artist": {
      "name": "Rex Orange County",
      "key": 65,
      "runtime": 7583,
      "albums": [
        237
      ],
      "songs": [
        2800,
        2803,
        2809
      ]
    }
  },
  "id": 0
}