🟢 Stable

This API is stable since festivald v1.0.0.

Add a Song to a Playlist with a Key.

If the specified playlist does not already exist, it will be created.

This method errors if there was an index error.


keySong key (unsigned integer)Song key of the Song to add
playliststringThe name of the Playlist
appendstring, one of front, back or indexSee Playlist/Append
indexoptional (maybe-null) unsigned integerIf the index append is chosen, this will be the index used


existedbooleanIf playlist already existed or not
old_lenunsigned integerThe old length of playlist
new_lenunsigned integerThe new length of playlist

Example Request 1

Add to back of the playlist "Hello".

festival-cli playlist_add_key_song --playlist Hello --key 0 --append back
curl http://localhost:18425 -d '{"jsonrpc":"2.0","id":0,"method":"playlist_add_key_song","params":{"playlist":"Hello","key":0,"append":"back"}}'

Example Request 2

Append at playlist index 4.

festival-cli playlist_add_key_song --playlist Hello --key 0 --append index --index 4
curl http://localhost:18425 -d '{"jsonrpc":"2.0","id":0,"method":"playlist_add_key_song","params":{"playlist":"Hello","key":0,"append":"index","index":4}}'

Example Response

  "jsonrpc": "2.0",
  "result": {
    "existed": false,
    "old_len": 0,
    "new_len": 187
  "id": 0