clear

🟡 Incomplete

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

Clear the queue.

Inputs

FieldTypeDescription
playbackbooleanIf there is a Song currently set and playing, should we continue playback?

Outputs

FieldTypeDescription
lenunsigned integerAmount of Song's cleared from the queue

Example Request

festival-cli clear

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

Example Response

{
  "jsonrpc": "2.0",
  "result": {
    "len": 207
  },
  "id": 0
}