Releases: ampache/python3-ampache
6.1.1
6.1.0
python3-ampache 6.1.0
Ampache 6 is nearly here and this lib is done for the initial release. there are a few changes that aren't completely compatible if you've been using 6.. version of the library.
Full Changelog: 6.0.1...6.1.0
Added
- Check for a bool in get_indexes parameter
include - Added
randomto playlist_songs
Changed
- Extended user_edit parameters
fullname_publicreset_apikeyreset_streamtokenclear_statsdeletes all your play history so don't do that lightly
6.0.1
python3-ampache 6.0.1
This release fixes up some cosmetic issues and cleans up the bool parameters which should be sent as int's
Full Changelog: 6.0.0...6.0.1
Added
- Add back the exact parameter to album_songs (Allow backwards compatability with previous api versions)
Fixed
- Int parameters that were set as bool parameters
6.0.0
python3-ampache 6.0.0
This release adds in support for API6 and still includes backward compatibility to previous versions.
Added
- API6 (Based on API5)
- API6::browse: List server contents in a directory-style listing (Music, Podcast and Video catalogs)
- API6::list: Replace get_indexes with a faster lookup and similar parameters returning
id,name,prefixandbasename - API6::catalog_add: Create a catalog (Require: 75)
- API6::catalog_delete: Delete a catalog (Require: 75)
- API6::live_stream_create: Create a new live stream (radio station)
- API6::live_stream_edit: Edit a live stream
- API6::live_stream_delete: Delete a stream buy ID
- API6::register: Allow users to register an account (if enabled)
- API6::playlist_create: Return an error if the playlist name already exists for that user
- API6::user_edit (previously user_create):
- Add
groupparameter to pick a catalog filter group - Add
fullname_publicto enable/disable using fullname in public display - Add
reset_apikeyto reset a user Api Key - Add
reset_streamtokento reset a user Stream Token - Add
clear_statsreset all stats for this user be very sure about this one!
- Add
- Add
prefix(Prefix for Full Name) to album & artist responses - Add
basename(Name without prefix) to album & artist responses - Add
bitrateto Democratic objects - Add
formatto Song and Democratic objects - Add
stream_format,stream_bitrate,stream_mimeto Song objects (This is the transcoded output for a stream)
- JSON responses
- Cast bool fields to
trueandfalseinstead of "1" & "0" - Add
total_countto resonses to give clients an idea of the total possible objects
- Cast bool fields to
- advanced_search
- Add
album_diskas a search type (uses album rules) - Add
song_genreto album and artist searches - Add
possible_duplicate_albumto song search - Add
mbid_artistto album search - Add
barcodeto album search - Add
catalog_numberto album search - Add
smartplaylistto album search - Add
duplicate_tracksto album and song search (MIN & MAX id for song search) - Alias
possible_duplicate_album=>possible_duplicatefor album search - Alias
album_genre=>genrefor album search - Alias
mbid_album=>mbidfor album search - Alias
mbid_artist=>mbidfor artist search - Alias
song_genre=>genrefor song search
- Add
Changed
- Renamed user_update to user_edit (user_update still works and will be depreciated in API7)
- Albums with no album_artist may now return 0 artist called 'Various'
- Don't send AlbumDisk objects to the API
- XML responses
- Api6 XML success and error response messages are put in a
messageelement (like json) - For data responses id is the only attribute and everything else is an element
- Name was not set as an attribute OR an element so now it's always an element
- Return original XML output (that may be malformed) when loadxml fails.
- Api6 XML success and error response messages are put in a
- Api6::get_indexes: This method is depreciated and will be removed in Ampache 7.0.0 (Use Api6::list instead)
Removed
- preciserating removed from all objects (use rating)
- Api6::album_songs remove
exactas a parameter - Api6::stream remove
podcastas a validtypevalue - Warning of depreciated methods from API5 have been removed from API6
- Api6::tag
- Api6::tags
- Api6::tag_albums
- Api6::tag_artists
- Api6::tag_songs
Fixed
- advanced_search methods were breaking with various offset and limits
- JSON responses
- Share and Bookmark object id's were not strings
5.5.0
This release allows you to access any supported API version using the same library
Added
- Fully support API3, API4 and API5 responses based on version string sent.
- set_debug_path function to allow generating docs in different places
4.4.2
Fixed an issue with share_edit's stream parameter
5.1.1
Minor update for a misspelled parameter value in localplay and some missing new parameters in API5
- playlists: add parameter
show_dupesif true ignore 'api_hide_dupe_searches' setting - get_art: add parameter
fallbackif true return default art ('blankalbum.png') instead of an error
Check out the official docs on ampache.org for more information. https://ampache.org/api/
4.4.1
Minor update to fix up some missing parameters.
Visit the official docs for more info about parameters and functions available.
4.4.0
Bugfixes that weren't caught before api5 was released.
- get_indexes
- localplay
- playlist_edit
- ping
- democratic
5.1.0
Ready for Ampache 5
A python3 library for interaction with your Ampache 5.x.x server using the XML & JSON API
- Additional methods in this release match up with the Ampache 5.1.0
- The structural changes to the lib do not support Ampache 4 and do not support old versions of the lib.
- Version 4 will be maintained along with Ampache 4 until the end of PHP 7.4 support.
Changes in this release
- Fixed scrobble parameters
- Added live_streams method
- Added live_stream method