JSON-RPC API v5 (pre Frodo)

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

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

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

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

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

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

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

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

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

{
  "returns": {
    "type": "object", 
    "properties": {
      "limits": {
        "required": true, 
        "$ref": "List.LimitsReturned"
      }, 
      "artists": {
        "items": {
          "$ref": "Audio.Details.Artist"
        }, 
        "type": "array"
      }
    }
  }, 
  "params": [
    {
      "default": null, 
      "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", 
      "$ref": "Optional.Boolean"
    }, 
    {
      "default": -1, 
      "name": "genreid", 
      "$ref": "Library.Id"
    }, 
    {
      "name": "properties", 
      "$ref": "Audio.Fields.Artist"
    }, 
    {
      "name": "limits", 
      "$ref": "List.Limits"
    }, 
    {
      "name": "sort", 
      "$ref": "List.Sort"
    }
  ], 
  "description": "Retrieve all artists"
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{
  "returns": {
    "$ref": "System.Property.Value"
  }, 
  "params": [
    {
      "required": true, 
      "type": "string", 
      "name": "title"
    }, 
    {
      "required": true, 
      "type": "string", 
      "name": "message"
    }, 
    {
      "default": "", 
      "type": [
        {
          "enums": [
            "info", 
            "warning", 
            "error"
          ], 
          "type": "string"
        }, 
        {
          "type": "string"
        }
      ], 
      "name": "image"
    }, 
    {
      "default": 5000, 
      "minimum": 1500, 
      "type": "integer", 
      "description": "The time in milliseconds the notification will be visible", 
      "name": "displaytime"
    }
  ], 
  "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": [], 
  "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": "Navigate up in GUI"
}

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

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

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

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

{
  "returns": {
    "type": "string"
  }, 
  "params": [], 
  "description": "Retrieve the jsonrpc protocol version"
}

{
  "returns": {
    "uniqueItems": true, 
    "items": {
      "type": "object", 
      "properties": {
        "playerid": {
          "required": true, 
          "$ref": "Player.Id"
        }, 
        "type": {
          "required": true, 
          "$ref": "Player.Type"
        }
      }
    }, 
    "type": "array"
  }, 
  "params": [], 
  "description": "Returns all active players"
}

{
  "returns": {
    "type": "object", 
    "properties": {
      "item": {
        "required": true, 
        "$ref": "List.Item.All"
      }
    }
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }, 
    {
      "name": "properties", 
      "$ref": "List.Fields.All"
    }
  ], 
  "description": "Retrieves the currently played item"
}

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

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }
  ], 
  "description": "Go to next item on the playlist"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }
  ], 
  "description": "Go to previous item on the playlist"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }, 
    {
      "required": true, 
      "name": "position", 
      "$ref": "Playlist.Position"
    }
  ], 
  "description": "Go to item at the given position in the playlist"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }
  ], 
  "description": "If picture is zoomed move viewport down"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }
  ], 
  "description": "If picture is zoomed move viewport left otherwise skip previous"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }
  ], 
  "description": "If picture is zoomed move viewport right otherwise skip next"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }
  ], 
  "description": "If picture is zoomed move viewport up"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "type": [
        {
          "additionalProperties": false, 
          "type": "object", 
          "properties": {
            "position": {
              "default": 0, 
              "$ref": "Playlist.Position"
            }, 
            "playlistid": {
              "required": true, 
              "$ref": "Playlist.Id"
            }
          }
        }, 
        {
          "$ref": "Playlist.Item"
        }, 
        {
          "additionalProperties": false, 
          "type": "object", 
          "properties": {
            "path": {
              "required": true, 
              "type": "string"
            }, 
            "random": {
              "default": true, 
              "type": "boolean", 
              "description": "Deprecated, use the shuffled property of the options parameter instead"
            }, 
            "recursive": {
              "default": true, 
              "type": "boolean"
            }
          }
        }
      ], 
      "name": "item"
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "name": "options", 
      "properties": {
        "repeat": {
          "default": null, 
          "type": [
            {
              "type": "null"
            }, 
            {
              "$ref": "Player.Repeat"
            }
          ]
        }, 
        "shuffled": {
          "default": null, 
          "$ref": "Optional.Boolean"
        }, 
        "resume": {
          "default": false, 
          "type": [
            {
              "type": "boolean", 
              "description": "Whether to resume from the resume point or not"
            }, 
            {
              "description": "Percentage value to start from", 
              "$ref": "Player.Position.Percentage"
            }, 
            {
              "description": "Time to start from", 
              "$ref": "Player.Position.Time"
            }
          ]
        }
      }
    }
  ], 
  "description": "Start playback of either the playlist with the given ID, a slideshow with the pictures from the given directory or a single file or an item from the database."
}

{
  "returns": {
    "$ref": "Player.Speed"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }, 
    {
      "default": "toggle", 
      "name": "play", 
      "$ref": "Global.Toggle"
    }
  ], 
  "description": "Pauses or unpause playback and returns the new state"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }, 
    {
      "required": true, 
      "name": "state", 
      "$ref": "Player.Repeat"
    }
  ], 
  "description": "Set the repeat mode of the player"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }
  ], 
  "description": "Rotates current picture"
}

{
  "returns": {
    "type": "object", 
    "properties": {
      "totaltime": {
        "$ref": "Global.Time"
      }, 
      "percentage": {
        "default": 0, 
        "$ref": "Player.Position.Percentage"
      }, 
      "time": {
        "$ref": "Global.Time"
      }
    }
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }, 
    {
      "required": true, 
      "type": [
        {
          "description": "Percentage value to seek to", 
          "$ref": "Player.Position.Percentage"
        }, 
        {
          "description": "Time to seek to", 
          "$ref": "Player.Position.Time"
        }, 
        {
          "enums": [
            "smallforward", 
            "smallbackward", 
            "bigforward", 
            "bigbackward"
          ], 
          "type": "string", 
          "description": "Seek by predefined jumps"
        }
      ], 
      "name": "value"
    }
  ], 
  "description": "Seek through the playing item"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }, 
    {
      "required": true, 
      "type": [
        {
          "enums": [
            "previous", 
            "next"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Index of the audio stream to play"
        }
      ], 
      "name": "stream"
    }
  ], 
  "description": "Set the audio stream played by the player"
}

{
  "returns": {
    "$ref": "Player.Speed"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }, 
    {
      "required": true, 
      "type": [
        {
          "enums": [
            -32, 
            -16, 
            -8, 
            -4, 
            -2, 
            -1, 
            0, 
            1, 
            2, 
            4, 
            8, 
            16, 
            32
          ], 
          "type": "integer"
        }, 
        {
          "$ref": "Global.IncrementDecrement"
        }
      ], 
      "name": "speed"
    }
  ], 
  "description": "Set the speed of the current playback"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }, 
    {
      "required": true, 
      "type": [
        {
          "enums": [
            "previous", 
            "next", 
            "off", 
            "on"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Index of the subtitle to display"
        }
      ], 
      "name": "subtitle"
    }, 
    {
      "default": false, 
      "type": "boolean", 
      "description": "Whether to enable subtitles to be displayed after setting the new subtitle", 
      "name": "enable"
    }
  ], 
  "description": "Set the subtitle displayed by the player"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }
  ], 
  "description": "Shuffle items in the player"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }
  ], 
  "description": "Stops playback"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }
  ], 
  "description": "Unshuffle items in the player"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }, 
    {
      "description": "Zoom level", 
      "required": true, 
      "maximum": 10, 
      "minimum": 1, 
      "type": "integer", 
      "name": "value"
    }
  ], 
  "description": "Zooms current picture"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }
  ], 
  "description": "Zoom in once"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playerid", 
      "$ref": "Player.Id"
    }
  ], 
  "description": "Zoom out once"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playlistid", 
      "$ref": "Playlist.Id"
    }, 
    {
      "required": true, 
      "name": "item", 
      "$ref": "Playlist.Item"
    }
  ], 
  "description": "Add item(s) to playlist"
}

{
  "returns": {
    "type": "string"
  }, 
  "params": [
    {
      "required": true, 
      "name": "playlistid", 
      "$ref": "Playlist.Id"
    }
  ], 
  "description": "Clear playlist"
}

{
  "returns": {
    "type": "object", 
    "properties": {
      "items": {
        "items": {
          "$ref": "List.Item.All"
        }, 
        "required": true, 
        "type": "array"
      }, 
      "limits": {
        "required": true, 
        "$ref": "List.LimitsReturned"
      }
    }
  }, 
  "params": [
    {
      "required": true, 
      "name": "playlistid", 
      "$ref": "Playlist.Id"
    }, 
    {
      "name": "properties", 
      "$ref": "List.Fields.All"
    }, 
    {
      "name": "limits", 
      "$ref": "List.Limits"
    }, 
    {
      "name": "sort", 
      "$ref": "List.Sort"
    }
  ], 
  "description": "Get all items from playlist"
}