playlist_remove_index

🟢 Stable

This API is stable since festivald v1.0.0.


Remove a single Playlist Entry from a Playlist, using its index number.

This method errors if the playlist does not exist or if index is out-of-bounds.

Inputs

FieldTypeDescription
playliststringThe name of the Playlist
indexunsigned integerThe index of the entry in the playlist

Outputs

FieldTypeDescription
entryPlaylist Entry objectThe Playlist Entry that was removed

Example Request

Remove the 1st entry in playlist "Hello"

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

Example Response

{
  "jsonrpc": "2.0",
  "result": {
    "entry": {
      "valid": {
        "key_artist": 65,
        "key_album": 237,
        "key_song": 2539,
        "artist": "Rex Orange County",
        "album": "RAINBOW",
        "song": "SUNFLOWER"
      }
    }
  },
  "id": 0
}