playlist_get_index

🟢 Stable

This API is stable since festivald v1.0.0.

Retrieve 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

Field	Type	Description
playlist	string	The name of the `Playlist`
index	unsigned integer	The index of the entry in the playlist

Outputs

Field	Type	Description
entry	`Playlist Entry` object	The `Playlist Entry` that was at `index`

Example Request

Retrieve the 1st entry in playlist "Hello"

festival-cli playlist_get_index --playlist Hello --index 0

curl http://localhost:18425 -d '{"jsonrpc":"2.0","id":0,"method":"playlist_get_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
}