diff --git a/.gitignore b/.gitignore index 54c43436..74e29c78 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,7 @@ *.db-journal *.ini logs/* +cache/* # OS generated files # ###################### diff --git a/apireference b/API_REFERENCE similarity index 70% rename from apireference rename to API_REFERENCE index bc2793ca..c20d32cb 100644 --- a/apireference +++ b/API_REFERENCE @@ -12,9 +12,11 @@ $commands¶meters[&optionalparameters]: getIndex (fetch data from index page. Returns: ArtistName, ArtistSortName, ArtistID, Status, DateAdded, [LatestAlbum, ReleaseDate, AlbumID], HaveTracks, TotalTracks, - IncludeExtras) + IncludeExtras, LastUpdated, [ArtworkURL, ThumbURL]: a remote url to the artwork/thumbnail. To get the cached image path, see getArtistArt command. + ThumbURL is added/updated when an artist is added/updated. If your using the database method to get the artwork, + it's more reliable to use the ThumbURL than the ArtworkURL) -getArtist&id=$artistid (fetch artist data. returns the artist object (see above) and album info: Status, AlbumASIN, DateAdded, AlbumTitle, ArtistName, ReleaseDate, AlbumID, ArtistID, Type) +getArtist&id=$artistid (fetch artist data. returns the artist object (see above) and album info: Status, AlbumASIN, DateAdded, AlbumTitle, ArtistName, ReleaseDate, AlbumID, ArtistID, Type, ArtworkURL: hosted image path. For cached image, see getAlbumArt command) getAlbum&id=$albumid (fetch data from album page. Returns the album object, a description object and a tracks object. Tracks contain: AlbumASIN, AlbumTitle, TrackID, Format, TrackDuration (ms), ArtistName, TrackTitle, AlbumID, ArtistID, Location, TrackNumber, CleanName (stripped of punctuation /styling), BitRate) @@ -52,4 +54,13 @@ checkGithub (updates the version information above and returns getVersion data) shutdown (shut down headphones) restart (restart headphones) -update (update headphones - you may want to check the install type in get version and not allow this if type==exe) \ No newline at end of file +update (update headphones - you may want to check the install type in get version and not allow this if type==exe) + +getArtistArt&id=$artistid (Returns either a relative path to the cached image, or a remote url if the image can't be saved to the cache dir) +getAlbumArt&id=$albumid (see above) + +getArtistInfo&id=$artistid (Returns Summary and Content, both formatted in html) +getAlbumInfo&id=$albumid (See above, returns Summary and Content) + +getArtistThumb&id=$artistid (Returns either a relative path to the cached thumbnail artist image, or an http:// address if the cache dir can't be written to) +getAlbumThumb&id=$albumid (see above) diff --git a/data/interfaces/default/album.html b/data/interfaces/default/album.html index c76a520b..d5b1b54a 100644 --- a/data/interfaces/default/album.html +++ b/data/interfaces/default/album.html @@ -26,7 +26,7 @@
+ ${description['Summary']}
- %endif +



| t |