search_entry

🟢 Stable

This API is stable since festivald v1.0.0.

Input a string, retrieve an array of Song's (in Entry form), sorted by how similar their titles are to the input.

Inputs

Field	Type	Description
input	string	The string to match against, to use as input
kind	string, one of `all`, `sim60`, `sim70`, `sim80`, `top25`, `top5`, `top1`	See `Search/Kind`

Outputs

Field	Type	Description
entries	`Entry` object	See `Entry`

Example Request

festival-cli search_entry --input time --kind top1

curl http://localhost:18425 -d '{"jsonrpc":"2.0","id":0,"method":"search_entry","params":{"input":"time","kind":"top1"}}'

Example Response

{
  "jsonrpc": "2.0",
  "result": {
    "entries": [
      {
        "path": "/home/hinto/Music/Kero Kero Bonito/Time 'n' Place/Time Today.flac",
        "key_artist": 148,
        "key_album": 665,
        "key_song": 6768,
        "artist": "Kero Kero Bonito",
        "album": "Time 'n' Place",
        "song": "Time Today"
      }
    ]
  },
  "id": 0
}