state_queue_key

🟢 Stable

This API is stable since festivald v1.0.0.

Retrieve state about the queue.

This returns the queue as Song key's.

Returned key's are in order of what will be played next.

Inputs

None

Outputs

FieldTypeDescription
lenunsigned integerLength of the queue
keysarray of Song keys (unsigned integers)Array of the queue's Song's as keys

Example Request

festival-cli state_queue_key

curl http://localhost:18425 -d '{"jsonrpc":"2.0","id":0,"method":"state_queue_key"}'

Example Response

{
  "jsonrpc": "2.0",
  "result": {
    "len": 5,
    "keys": [
      2896,
      2899,
      2904,
      2906,
      2911
    ]
  },
  "id": 0
}