volume_down

🟢 Stable

This API is stable since festivald v1.0.0.

Lower the playback volume.

Inputs

FieldTypeDescription
downunsigned integerThe number to lower the volume by. Must be in-between 0..100. Volume cannot go lower than 0.

Outputs

FieldTypeDescription
previousunsigned integerWhat the volume was set to previously
currentunsigned integerWhat the volume is now set at

Example Request

festival-cli volume_down --down 15

curl http://localhost:18425 -d '{"jsonrpc":"2.0","id":0,"method":"volume_down","params":{"down":15}}'

Example Response

{
  "jsonrpc": "2.0",
  "result": {
    "previous": 15,
    "current": 0
  },
  "id": "festival-cli"
}