Formato JSON

Per facilitare l'analisi dei risultati da kid3-cli, è possibile ottenere l'output in formato JSON. Quando la richiesta è in formato JSON, la risposta sarà anche JSON. Un formato compatto della richiesta fornirà anche una rappresentazione compatta della risposta. Se la richiesta contiene un campo «id», si presume che sia una richiesta JSON-RPC e la risposta conterrà un campo «jsonrpc» e «id» della richiesta. Il formato della richiesta utilizza gli stessi comandi della CLI standard, il campo «method» contiene il comando e i parametri (se presenti) sono indicati nell'elenco «params». La risposta contiene un oggetto «result», che può anche essere nullo se il comando kid3-cli non restituisce un risultato. In caso di errore, viene restituito un oggetto «error» con i campi «code» e «message» come usato in JSON-RPC.

kid3-cli> {"method":"set","params":["artist","Un artista"]}
{"result":null}
kid3-cli> {"method":"get","params":["artist",2]}
{"result":"An Artist"}
kid3-cli> {"method": "get", "params": ["artist"]}
{
    "result": "Un artista"
}

kid3-cli> {"jsonrpc":"2.0","id":"123","method":"get","params":["artist"]}
{"id":"123","jsonrpc":"2.0","result":"Un artista"}