queue_add_key_album
🟡 Incomplete
This API's output may have additions in the future.
Add an Album to the queue with an Album key.
Inputs
| Field | Type | Description |
|---|---|---|
| key | Album key (unsigned integer) | See Key |
| append | string, one of front, back or index | See Queue/Append |
| clear | boolean | Should the queue be cleared before adding? |
| play | boolean | Should we start playing? |
| index | optional (maybe-null) unsigned integer | If the index append is chosen, this will be the index used |
| offset | optional (maybe-null) unsigned integer | See Queue/offset |
Outputs
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_key_album --key 123 --append back
curl http://localhost:18425 -d '{"jsonrpc":"2.0","id":0,"method":"queue_add_key_album","params":{"key":123,"append":"back","clear":false,"play":false}}'
Example Request 2
Insert at queue index 4.
festival-cli queue_add_key_album --key 123 --append index --index 4
curl http://localhost:18425 -d '{"jsonrpc":"2.0","id":0,"method":"queue_add_key_album","params":{"key":123,"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_key_album --key 123 --append front --clear --play --offset 4
curl http://localhost:18425 -d '{"jsonrpc":"2.0","id":0,"method":"queue_add_key_album","params":{"key":123,"append":"front","clear":true,"play":true,"offset":4}}'
Example Response
{
"jsonrpc": "2.0",
"result": null, // <--- everything went ok.
"id": 0
}