volume

🟢 Stable

This API is stable since festivald v1.0.0.

Set the playback volume.

Inputs

FieldTypeDescription
volumeunsigned integerThe volume % to set. Must be in-between 0..100. If greater than 100, it will set the volume to 100.

Outputs

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

Example Request

festival-cli volume --volume 15

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

Example Response

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