JSON-RPC API v6 (Frodo)

{
  "params": [
    {
      "name": "addonid", 
      "required": true, 
      "type": "string"
    }, 
    {
      "name": "params", 
      "type": [
        {
          "additionalProperties": {
            "type": "string", 
            "default": ""
          }, 
          "type": "object"
        }, 
        {
          "items": {
            "type": "string"
          }, 
          "type": "array"
        }
      ], 
      "default": null
    }, 
    {
      "name": "wait", 
      "type": "boolean", 
      "default": false
    }
  ], 
  "description": "Executes the given addon with the given parameters (if possible)", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [
    {
      "name": "addonid", 
      "required": true, 
      "type": "string"
    }, 
    {
      "$ref": "Addon.Fields", 
      "name": "properties"
    }
  ], 
  "description": "Gets the details of a specific addon", 
  "returns": {
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned", 
        "required": true
      }, 
      "addon": {
        "$ref": "Addon.Details", 
        "required": true
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "$ref": "Addon.Types", 
      "name": "type", 
      "default": "unknown"
    }, 
    {
      "$ref": "Addon.Content", 
      "description": "Content provided by the addon. Only considered for plugins and scripts.", 
      "name": "content", 
      "default": "unknown"
    }, 
    {
      "name": "enabled", 
      "type": [
        {
          "type": "boolean"
        }, 
        {
          "enums": [
            "all"
          ], 
          "type": "string"
        }
      ], 
      "default": "all"
    }, 
    {
      "$ref": "Addon.Fields", 
      "name": "properties"
    }, 
    {
      "$ref": "List.Limits", 
      "name": "limits"
    }
  ], 
  "description": "Gets all available addons", 
  "returns": {
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned", 
        "required": true
      }, 
      "addons": {
        "items": {
          "$ref": "Addon.Details"
        }, 
        "type": "array"
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "name": "addonid", 
      "required": true, 
      "type": "string"
    }, 
    {
      "$ref": "Global.Toggle", 
      "name": "enabled", 
      "required": true
    }
  ], 
  "description": "Enables/Disables a specific addon", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [
    {
      "uniqueItems": true, 
      "items": {
        "$ref": "Application.Property.Name"
      }, 
      "name": "properties", 
      "type": "array", 
      "required": true
    }
  ], 
  "description": "Retrieves the values of the given properties", 
  "returns": {
    "$ref": "Application.Property.Value"
  }
}

{
  "params": [], 
  "description": "Quit application", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [
    {
      "$ref": "Global.Toggle", 
      "name": "mute", 
      "required": true
    }
  ], 
  "description": "Toggle mute/unmute", 
  "returns": {
    "description": "Mute state", 
    "type": "boolean"
  }
}

{
  "params": [
    {
      "name": "volume", 
      "required": true, 
      "type": [
        {
          "minimum": 0, 
          "type": "integer", 
          "maximum": 100
        }, 
        {
          "$ref": "Global.IncrementDecrement"
        }
      ]
    }
  ], 
  "description": "Set the current volume", 
  "returns": {
    "type": "integer"
  }
}

{
  "params": [], 
  "description": "Cleans the audio library from non-existent items", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [
    {
      "name": "options", 
      "type": [
        {
          "additionalProperties": false, 
          "properties": {
            "path": {
              "description": "Path to the directory to where the data should be exported", 
              "minLength": 1, 
              "required": true, 
              "type": "string"
            }
          }, 
          "type": "object"
        }, 
        {
          "additionalProperties": false, 
          "properties": {
            "overwrite": {
              "description": "Whether to overwrite existing exported files", 
              "type": "boolean", 
              "default": false
            }, 
            "images": {
              "description": "Whether to export thumbnails and fanart images", 
              "type": "boolean", 
              "default": false
            }
          }, 
          "type": "object"
        }
      ]
    }
  ], 
  "description": "Exports all items from the audio library", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [
    {
      "$ref": "Library.Id", 
      "name": "albumid", 
      "required": true
    }, 
    {
      "$ref": "Audio.Fields.Album", 
      "name": "properties"
    }
  ], 
  "description": "Retrieve details about a specific album", 
  "returns": {
    "properties": {
      "albumdetails": {
        "$ref": "Audio.Details.Album"
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "$ref": "Audio.Fields.Album", 
      "name": "properties"
    }, 
    {
      "$ref": "List.Limits", 
      "name": "limits"
    }, 
    {
      "$ref": "List.Sort", 
      "name": "sort"
    }, 
    {
      "name": "filter", 
      "type": [
        {
          "additionalProperties": false, 
          "properties": {
            "genreid": {
              "$ref": "Library.Id", 
              "required": true
            }
          }, 
          "type": "object"
        }, 
        {
          "additionalProperties": false, 
          "properties": {
            "genre": {
              "minLength": 1, 
              "required": true, 
              "type": "string"
            }
          }, 
          "type": "object"
        }, 
        {
          "additionalProperties": false, 
          "properties": {
            "artistid": {
              "$ref": "Library.Id", 
              "required": true
            }
          }, 
          "type": "object"
        }, 
        {
          "additionalProperties": false, 
          "properties": {
            "artist": {
              "minLength": 1, 
              "required": true, 
              "type": "string"
            }
          }, 
          "type": "object"
        }, 
        {
          "$ref": "List.Filter.Albums"
        }
      ]
    }
  ], 
  "description": "Retrieve all albums from specified artist or genre", 
  "returns": {
    "properties": {
      "albums": {
        "items": {
          "$ref": "Audio.Details.Album"
        }, 
        "type": "array"
      }, 
      "limits": {
        "$ref": "List.LimitsReturned", 
        "required": true
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "$ref": "Library.Id", 
      "name": "artistid", 
      "required": true
    }, 
    {
      "$ref": "Audio.Fields.Artist", 
      "name": "properties"
    }
  ], 
  "description": "Retrieve details about a specific artist", 
  "returns": {
    "properties": {
      "artistdetails": {
        "$ref": "Audio.Details.Artist"
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "$ref": "Optional.Boolean", 
      "description": "Whether or not to include artists only appearing in compilations. If the parameter is not passed or is passed as null the GUI setting will be used", 
      "name": "albumartistsonly", 
      "default": null
    }, 
    {
      "$ref": "Audio.Fields.Artist", 
      "name": "properties"
    }, 
    {
      "$ref": "List.Limits", 
      "name": "limits"
    }, 
    {
      "$ref": "List.Sort", 
      "name": "sort"
    }, 
    {
      "name": "filter", 
      "type": [
        {
          "additionalProperties": false, 
          "properties": {
            "genreid": {
              "$ref": "Library.Id", 
              "required": true
            }
          }, 
          "type": "object"
        }, 
        {
          "additionalProperties": false, 
          "properties": {
            "genre": {
              "minLength": 1, 
              "required": true, 
              "type": "string"
            }
          }, 
          "type": "object"
        }, 
        {
          "additionalProperties": false, 
          "properties": {
            "albumid": {
              "$ref": "Library.Id", 
              "required": true
            }
          }, 
          "type": "object"
        }, 
        {
          "additionalProperties": false, 
          "properties": {
            "album": {
              "minLength": 1, 
              "required": true, 
              "type": "string"
            }
          }, 
          "type": "object"
        }, 
        {
          "additionalProperties": false, 
          "properties": {
            "songid": {
              "$ref": "Library.Id", 
              "required": true
            }
          }, 
          "type": "object"
        }, 
        {
          "$ref": "List.Filter.Artists"
        }
      ]
    }
  ], 
  "description": "Retrieve all artists", 
  "returns": {
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned", 
        "required": true
      }, 
      "artists": {
        "items": {
          "$ref": "Audio.Details.Artist"
        }, 
        "type": "array"
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "$ref": "Library.Fields.Genre", 
      "name": "properties"
    }, 
    {
      "$ref": "List.Limits", 
      "name": "limits"
    }, 
    {
      "$ref": "List.Sort", 
      "name": "sort"
    }
  ], 
  "description": "Retrieve all genres", 
  "returns": {
    "properties": {
      "genres": {
        "items": {
          "$ref": "Library.Details.Genre"
        }, 
        "required": true, 
        "type": "array"
      }, 
      "limits": {
        "$ref": "List.LimitsReturned", 
        "required": true
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "$ref": "Audio.Fields.Album", 
      "name": "properties"
    }, 
    {
      "$ref": "List.Limits", 
      "name": "limits"
    }, 
    {
      "$ref": "List.Sort", 
      "name": "sort"
    }
  ], 
  "description": "Retrieve recently added albums", 
  "returns": {
    "properties": {
      "albums": {
        "items": {
          "$ref": "Audio.Details.Album"
        }, 
        "type": "array"
      }, 
      "limits": {
        "$ref": "List.LimitsReturned", 
        "required": true
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "$ref": "List.Amount", 
      "description": "The amount of recently added albums from which to return the songs", 
      "name": "albumlimit", 
      "default": -1
    }, 
    {
      "$ref": "Audio.Fields.Song", 
      "name": "properties"
    }, 
    {
      "$ref": "List.Limits", 
      "name": "limits"
    }, 
    {
      "$ref": "List.Sort", 
      "name": "sort"
    }
  ], 
  "description": "Retrieve recently added songs", 
  "returns": {
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned", 
        "required": true
      }, 
      "songs": {
        "items": {
          "$ref": "Audio.Details.Song"
        }, 
        "type": "array"
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "$ref": "Audio.Fields.Album", 
      "name": "properties"
    }, 
    {
      "$ref": "List.Limits", 
      "name": "limits"
    }, 
    {
      "$ref": "List.Sort", 
      "name": "sort"
    }
  ], 
  "description": "Retrieve recently played albums", 
  "returns": {
    "properties": {
      "albums": {
        "items": {
          "$ref": "Audio.Details.Album"
        }, 
        "type": "array"
      }, 
      "limits": {
        "$ref": "List.LimitsReturned", 
        "required": true
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "$ref": "Audio.Fields.Song", 
      "name": "properties"
    }, 
    {
      "$ref": "List.Limits", 
      "name": "limits"
    }, 
    {
      "$ref": "List.Sort", 
      "name": "sort"
    }
  ], 
  "description": "Retrieve recently played songs", 
  "returns": {
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned", 
        "required": true
      }, 
      "songs": {
        "items": {
          "$ref": "Audio.Details.Song"
        }, 
        "type": "array"
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "$ref": "Library.Id", 
      "name": "songid", 
      "required": true
    }, 
    {
      "$ref": "Audio.Fields.Song", 
      "name": "properties"
    }
  ], 
  "description": "Retrieve details about a specific song", 
  "returns": {
    "properties": {
      "songdetails": {
        "$ref": "Audio.Details.Song"
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "$ref": "Audio.Fields.Song", 
      "name": "properties"
    }, 
    {
      "$ref": "List.Limits", 
      "name": "limits"
    }, 
    {
      "$ref": "List.Sort", 
      "name": "sort"
    }, 
    {
      "name": "filter", 
      "type": [
        {
          "additionalProperties": false, 
          "properties": {
            "genreid": {
              "$ref": "Library.Id", 
              "required": true
            }
          }, 
          "type": "object"
        }, 
        {
          "additionalProperties": false, 
          "properties": {
            "genre": {
              "minLength": 1, 
              "required": true, 
              "type": "string"
            }
          }, 
          "type": "object"
        }, 
        {
          "additionalProperties": false, 
          "properties": {
            "artistid": {
              "$ref": "Library.Id", 
              "required": true
            }
          }, 
          "type": "object"
        }, 
        {
          "additionalProperties": false, 
          "properties": {
            "artist": {
              "minLength": 1, 
              "required": true, 
              "type": "string"
            }
          }, 
          "type": "object"
        }, 
        {
          "additionalProperties": false, 
          "properties": {
            "albumid": {
              "$ref": "Library.Id", 
              "required": true
            }
          }, 
          "type": "object"
        }, 
        {
          "additionalProperties": false, 
          "properties": {
            "album": {
              "minLength": 1, 
              "required": true, 
              "type": "string"
            }
          }, 
          "type": "object"
        }, 
        {
          "$ref": "List.Filter.Songs"
        }
      ]
    }
  ], 
  "description": "Retrieve all songs from specified album, artist or genre", 
  "returns": {
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned", 
        "required": true
      }, 
      "songs": {
        "items": {
          "$ref": "Audio.Details.Song"
        }, 
        "type": "array"
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "name": "directory", 
      "type": "string", 
      "default": ""
    }
  ], 
  "description": "Scans the audio sources for new library items", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [
    {
      "$ref": "Library.Id", 
      "name": "albumid", 
      "required": true
    }, 
    {
      "$ref": "Optional.String", 
      "name": "title", 
      "default": null
    }, 
    {
      "name": "artist", 
      "type": [
        {
          "type": "null"
        }, 
        {
          "$ref": "Array.String"
        }
      ], 
      "default": null
    }, 
    {
      "$ref": "Optional.String", 
      "name": "description", 
      "default": null
    }, 
    {
      "name": "genre", 
      "type": [
        {
          "type": "null"
        }, 
        {
          "$ref": "Array.String"
        }
      ], 
      "default": null
    }, 
    {
      "name": "theme", 
      "type": [
        {
          "type": "null"
        }, 
        {
          "$ref": "Array.String"
        }
      ], 
      "default": null
    }, 
    {
      "name": "mood", 
      "type": [
        {
          "type": "null"
        }, 
        {
          "$ref": "Array.String"
        }
      ], 
      "default": null
    }, 
    {
      "name": "style", 
      "type": [
        {
          "type": "null"
        }, 
        {
          "$ref": "Array.String"
        }
      ], 
      "default": null
    }, 
    {
      "$ref": "Optional.String", 
      "name": "type", 
      "default": null
    }, 
    {
      "$ref": "Optional.String", 
      "name": "albumlabel", 
      "default": null
    }, 
    {
      "$ref": "Optional.Integer", 
      "name": "rating", 
      "default": null
    }, 
    {
      "$ref": "Optional.Integer", 
      "name": "year", 
      "default": null
    }
  ], 
  "description": "Update the given album with the given details", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [
    {
      "$ref": "Library.Id", 
      "name": "artistid", 
      "required": true
    }, 
    {
      "$ref": "Optional.String", 
      "name": "artist", 
      "default": null
    }, 
    {
      "name": "instrument", 
      "type": [
        {
          "type": "null"
        }, 
        {
          "$ref": "Array.String"
        }
      ], 
      "default": null
    }, 
    {
      "name": "style", 
      "type": [
        {
          "type": "null"
        }, 
        {
          "$ref": "Array.String"
        }
      ], 
      "default": null
    }, 
    {
      "name": "mood", 
      "type": [
        {
          "type": "null"
        }, 
        {
          "$ref": "Array.String"
        }
      ], 
      "default": null
    }, 
    {
      "$ref": "Optional.String", 
      "name": "born", 
      "default": null
    }, 
    {
      "$ref": "Optional.String", 
      "name": "formed", 
      "default": null
    }, 
    {
      "$ref": "Optional.String", 
      "name": "description", 
      "default": null
    }, 
    {
      "name": "genre", 
      "type": [
        {
          "type": "null"
        }, 
        {
          "$ref": "Array.String"
        }
      ], 
      "default": null
    }, 
    {
      "$ref": "Optional.String", 
      "name": "died", 
      "default": null
    }, 
    {
      "$ref": "Optional.String", 
      "name": "disbanded", 
      "default": null
    }, 
    {
      "name": "yearsactive", 
      "type": [
        {
          "type": "null"
        }, 
        {
          "$ref": "Array.String"
        }
      ], 
      "default": null
    }
  ], 
  "description": "Update the given artist with the given details", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [
    {
      "$ref": "Library.Id", 
      "name": "songid", 
      "required": true
    }, 
    {
      "$ref": "Optional.String", 
      "name": "title", 
      "default": null
    }, 
    {
      "name": "artist", 
      "type": [
        {
          "type": "null"
        }, 
        {
          "$ref": "Array.String"
        }
      ], 
      "default": null
    }, 
    {
      "name": "albumartist", 
      "type": [
        {
          "type": "null"
        }, 
        {
          "$ref": "Array.String"
        }
      ], 
      "default": null
    }, 
    {
      "name": "genre", 
      "type": [
        {
          "type": "null"
        }, 
        {
          "$ref": "Array.String"
        }
      ], 
      "default": null
    }, 
    {
      "$ref": "Optional.Integer", 
      "name": "year", 
      "default": null
    }, 
    {
      "$ref": "Optional.Integer", 
      "name": "rating", 
      "default": null
    }, 
    {
      "$ref": "Optional.String", 
      "name": "album", 
      "default": null
    }, 
    {
      "$ref": "Optional.Integer", 
      "name": "track", 
      "default": null
    }, 
    {
      "$ref": "Optional.Integer", 
      "name": "disc", 
      "default": null
    }, 
    {
      "$ref": "Optional.Integer", 
      "name": "duration", 
      "default": null
    }, 
    {
      "$ref": "Optional.String", 
      "name": "comment", 
      "default": null
    }, 
    {
      "$ref": "Optional.String", 
      "name": "musicbrainztrackid", 
      "default": null
    }, 
    {
      "$ref": "Optional.String", 
      "name": "musicbrainzartistid", 
      "default": null
    }, 
    {
      "$ref": "Optional.String", 
      "name": "musicbrainzalbumid", 
      "default": null
    }, 
    {
      "$ref": "Optional.String", 
      "name": "musicbrainzalbumartistid", 
      "default": null
    }
  ], 
  "description": "Update the given song with the given details", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [
    {
      "name": "path", 
      "required": true, 
      "type": "string"
    }
  ], 
  "description": "Downloads the given file", 
  "returns": {
    "type": "any"
  }
}

{
  "params": [
    {
      "name": "directory", 
      "required": true, 
      "type": "string"
    }, 
    {
      "$ref": "Files.Media", 
      "name": "media", 
      "default": "files"
    }, 
    {
      "$ref": "List.Fields.Files", 
      "name": "properties"
    }, 
    {
      "$ref": "List.Sort", 
      "name": "sort"
    }
  ], 
  "description": "Get the directories and files in the given directory", 
  "returns": {
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned", 
        "required": true
      }, 
      "files": {
        "items": {
          "$ref": "List.Item.File"
        }, 
        "required": true, 
        "type": "array"
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "description": "Full path to the file", 
      "name": "file", 
      "type": "string", 
      "required": true
    }, 
    {
      "$ref": "Files.Media", 
      "name": "media", 
      "default": "files"
    }, 
    {
      "$ref": "List.Fields.Files", 
      "name": "properties"
    }
  ], 
  "description": "Get details for a specific file", 
  "returns": {
    "properties": {
      "filedetails": {
        "$ref": "List.Item.File", 
        "required": true
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "$ref": "Files.Media", 
      "name": "media", 
      "required": true
    }, 
    {
      "$ref": "List.Limits", 
      "name": "limits"
    }, 
    {
      "$ref": "List.Sort", 
      "name": "sort"
    }
  ], 
  "description": "Get the sources of the media windows", 
  "returns": {
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned", 
        "required": true
      }, 
      "sources": {
        "$ref": "List.Items.Sources", 
        "required": true
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "name": "path", 
      "required": true, 
      "type": "string"
    }
  ], 
  "description": "Provides a way to download a given file (e.g. providing an URL to the real file location)", 
  "returns": {
    "properties": {
      "mode": {
        "enums": [
          "redirect", 
          "direct"
        ], 
        "description": "Direct mode allows using Files.Download whereas redirect mode requires the usage of a different protocol", 
        "required": true, 
        "type": "string"
      }, 
      "protocol": {
        "enums": [
          "http"
        ], 
        "required": true, 
        "type": "string"
      }, 
      "details": {
        "description": "Transport specific details on how/from where to download the given file", 
        "required": true, 
        "type": "any"
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "$ref": "GUI.Window", 
      "name": "window", 
      "required": true
    }, 
    {
      "minItems": 1, 
      "items": {
        "minLength": 1, 
        "type": "string"
      }, 
      "name": "parameters", 
      "type": "array"
    }
  ], 
  "description": "Activates the given window", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [
    {
      "uniqueItems": true, 
      "items": {
        "$ref": "GUI.Property.Name"
      }, 
      "name": "properties", 
      "type": "array", 
      "required": true
    }
  ], 
  "description": "Retrieves the values of the given properties", 
  "returns": {
    "$ref": "GUI.Property.Value"
  }
}

{
  "params": [
    {
      "$ref": "Global.Toggle", 
      "name": "fullscreen", 
      "required": true
    }
  ], 
  "description": "Toggle fullscreen/GUI", 
  "returns": {
    "description": "Fullscreen state", 
    "type": "boolean"
  }
}

{
  "params": [
    {
      "name": "title", 
      "required": true, 
      "type": "string"
    }, 
    {
      "name": "message", 
      "required": true, 
      "type": "string"
    }, 
    {
      "name": "image", 
      "type": [
        {
          "enums": [
            "info", 
            "warning", 
            "error"
          ], 
          "type": "string"
        }, 
        {
          "type": "string"
        }
      ], 
      "default": ""
    }, 
    {
      "minimum": 1500, 
      "description": "The time in milliseconds the notification will be visible", 
      "name": "displaytime", 
      "default": 5000, 
      "type": "integer"
    }
  ], 
  "description": "Shows a GUI notification", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [], 
  "description": "Goes back in GUI", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [], 
  "description": "Shows the context menu", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [], 
  "description": "Navigate down in GUI", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [
    {
      "$ref": "Input.Action", 
      "name": "action", 
      "required": true
    }
  ], 
  "description": "Execute a specific action", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [], 
  "description": "Goes to home window in GUI", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [], 
  "description": "Shows the information dialog", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [], 
  "description": "Navigate left in GUI", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [], 
  "description": "Navigate right in GUI", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [], 
  "description": "Select current item in GUI", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [
    {
      "description": "Unicode text", 
      "name": "text", 
      "type": "string", 
      "required": true
    }, 
    {
      "description": "Whether this is the whole input or not (closes an open input dialog if true).", 
      "name": "done", 
      "default": true, 
      "type": "boolean"
    }
  ], 
  "description": "Send a generic (unicode) text", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [], 
  "description": "Show codec information of the playing item", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [], 
  "description": "Show the on-screen display for the current player", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [], 
  "description": "Navigate up in GUI", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [], 
  "description": "Get client-specific configurations", 
  "returns": {
    "$ref": "Configuration"
  }
}

{
  "params": [
    {
      "name": "getdescriptions", 
      "type": "boolean", 
      "default": true
    }, 
    {
      "name": "getmetadata", 
      "type": "boolean", 
      "default": false
    }, 
    {
      "name": "filterbytransport", 
      "type": "boolean", 
      "default": true
    }, 
    {
      "name": "filter", 
      "properties": {
        "getreferences": {
          "description": "Whether or not to print the schema for referenced types", 
          "type": "boolean", 
          "default": true
        }, 
        "id": {
          "description": "Name of a namespace, method or type", 
          "required": true, 
          "type": "string"
        }, 
        "type": {
          "enums": [
            "method", 
            "namespace", 
            "type", 
            "notification"
          ], 
          "description": "Type of the given name", 
          "required": true, 
          "type": "string"
        }
      }, 
      "type": "object"
    }
  ], 
  "description": "Enumerates all actions and descriptions", 
  "returns": {
    "additionalProperties": false, 
    "type": "object"
  }
}

{
  "params": [
    {
      "name": "sender", 
      "required": true, 
      "type": "string"
    }, 
    {
      "name": "message", 
      "required": true, 
      "type": "string"
    }, 
    {
      "name": "data", 
      "type": "any", 
      "default": null
    }
  ], 
  "description": "Notify all other connected clients", 
  "returns": {
    "type": "any"
  }
}

{
  "params": [], 
  "description": "Retrieve the clients permissions", 
  "returns": {
    "properties": {
      "readdata": {
        "required": true, 
        "type": "boolean"
      }, 
      "writefile": {
        "required": true, 
        "type": "boolean"
      }, 
      "controlpvr": {
        "required": true, 
        "type": "boolean"
      }, 
      "controlsystem": {
        "required": true, 
        "type": "boolean"
      }, 
      "removedata": {
        "required": true, 
        "type": "boolean"
      }, 
      "controlplayback": {
        "required": true, 
        "type": "boolean"
      }, 
      "navigate": {
        "required": true, 
        "type": "boolean"
      }, 
      "controlpower": {
        "required": true, 
        "type": "boolean"
      }, 
      "executeaddon": {
        "required": true, 
        "type": "boolean"
      }, 
      "manageaddon": {
        "required": true, 
        "type": "boolean"
      }, 
      "controlgui": {
        "required": true, 
        "type": "boolean"
      }, 
      "controlnotify": {
        "required": true, 
        "type": "boolean"
      }, 
      "updatedata": {
        "required": true, 
        "type": "boolean"
      }
    }, 
    "type": "object"
  }
}

{
  "params": [], 
  "description": "Ping responder", 
  "returns": {
    "type": "string"
  }
}

{
  "params": [
    {
      "name": "notifications", 
      "properties": {
        "gui": {
          "$ref": "Optional.Boolean", 
          "default": null
        }, 
        "other": {
          "$ref": "Optional.Boolean", 
          "default": null
        }, 
        "input": {
          "$ref": "Optional.Boolean", 
          "default": null
        }, 
        "videolibrary": {
          "$ref": "Optional.Boolean", 
          "default": null
        }, 
        "audiolibrary": {
          "$ref": "Optional.Boolean", 
          "default": null
        }, 
        "playlist": {
          "$ref": "Optional.Boolean", 
          "default": null
        }, 
        "system": {
          "$ref": "Optional.Boolean", 
          "default": null
        }, 
        "player": {
          "$ref": "Optional.Boolean", 
          "default": null
        }, 
        "application": {
          "$ref": "Optional.Boolean", 
          "default": null
        }
      }, 
      "type": "object"
    }
  ], 
  "description": "Change the client-specific configuration", 
  "returns": {
    "$ref": "Configuration"
  }
}

{
  "params": [], 
  "description": "Retrieve the JSON-RPC protocol version.", 
  "returns": {
    "properties": {
      "minor": {
        "minimum": 0, 
        "description": "Bumped on backwards compatible additions/changes to the API definition", 
        "required": true, 
        "type": "integer"
      }, 
      "patch": {
        "minimum": 0, 
        "description": "Bumped on any changes to the internal implementation but not to the API definition", 
        "required": true, 
        "type": "integer"
      }, 
      "major": {
        "minimum": 0, 
        "description": "Bumped on backwards incompatible changes to the API definition", 
        "required": true, 
        "type": "integer"
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "$ref": "Library.Id", 
      "name": "channelid", 
      "required": true
    }, 
    {
      "$ref": "PVR.Fields.Channel", 
      "name": "properties"
    }
  ], 
  "description": "Retrieves the details of a specific channel", 
  "returns": {
    "properties": {
      "channeldetails": {
        "$ref": "PVR.Details.Channel"
      }
    }, 
    "type": "object"
  }
}

{
  "params": [
    {
      "$ref": "PVR.ChannelGroup.Id", 
      "name": "channelgroupid", 
      "required": true
    }, 
    {
      "name": "channels", 
      "properties": {
        "limits": {
          "$ref": "List.Limits"
        }, 
        "properties": {
          "$ref": "PVR.Fields.Channel"
        }
      }, 
      "type": "object"
    }
  ], 
  "description": "Retrieves the details of a specific channel group", 
  "returns": {
    "properties": {
      "channelgroupdetails": {
        "$ref": "PVR.Details.ChannelGroup.Extended"
      }
    }, 
    "type": "object"
  }
}