Update audiobookshelf.md for beta 28

music-assistant · Feb 14, 2025 · 9d3f51d · 9d3f51d
1 parent c55128a
commit 9d3f51d
Showing 1 changed file with 57 additions and 11 deletions.
diff --git a/docs/music-providers/audiobookshelf.md b/docs/music-providers/audiobookshelf.md
@@ -6,25 +6,71 @@ Music Assistant has support for [audiobookshelf](https://www.audiobookshelf.org/
 
 - Populates Audiobooks from all libraries accessible by the supplied user
 - Populates Podcasts from all libraries accessible by the supplied user
-- Browse Feature shows the library names and podcasts/ books within
-- Progress reporting both ways
+- Browse Feature has the following structure:
+
+```
+        Library_Name_A (Audiobooks)
+            Authors
+                Author_1
+                    Series_1
+                    Audiobook_1
+                    Audiobook_2
+                Author_2
+                    Audiobook_3
+            Narrators
+                Narrator_1
+                    Audiobook_1
+                    Audiobook_2
+            Series
+                Series_1
+                    Audiobook_1
+                    Audiobook_2
+                Series_2
+                    Audiobook_3
+                    Audiobook_4
+            Collections
+                Collection_1
+                    Audiobook_1
+                    Audiobook_2
+                Collection_2
+                    Audiobook_3
+                    Audiobook_4
+            Audiobooks
+                Audiobook_1
+                Audiobook_2
+        Library_Name_B (Podcasts)
+            Podcast_1
+            Podcast_2
+```
+
+- The Audiobook search function supports searching for Authors and Narrators
+- Progress is synced both ways and obtained just ahead of playing
+- Event driven updates of podcast/ audiobook metadata in **known** libraries:
+    - A change is immediately reflected to the MA database if MA is running
+    - Newly added and just deleted items are immediately reflected as well
+    - BUT: if MA was down while changes in the ABS database occured, those will only be synced if a normal provider sync is triggered
+- Single and multi-file audiobooks are supported
 
 ## Configuration
 
-- The following is needed to setup this provider:
-  - the URL of an Audiobookshelf instance
-  - the username of an Audiobookshelf user
-  - the password of this user
+The following is needed to setup this provider:
+
+- the URL of an Audiobookshelf instance
+- the username of an Audiobookshelf user
+- the password of this user
+- Optionally podcasts with no episodes yet downloaded may be skipped when syncing
 - Optionally, SSL verification may be disabled
 
+The user must be of type user, admin or root. Guest users are neither tested nor supported. 
+
 ## Known Issues / Notes
 
-- Restarting Audiobookshelf terminates all open sessions. Music Assistant has no way to know this, so you must reload the provider. Otherwise the stream of your audiobook will be not available
+- Multi-file Audiobooks: The UI will show PCM as the source file format (as that is what is used internally) instead of the actual file format of the audiobook
+- Tested currently against ABS >= 2.19.0
 - In the first instance of any problems ensure the server is running the [latest version of the audiobookshelf software](https://github.com/advplyr/audiobookshelf/releases)
 
 ## Not Yet Supported
 
-- Browsing by author
-- Browsing by collection
-- Browsing by series
-- Browsing by playlists
+- Playlists
+- Edit provider feature
+- Creation/deletion of a new library (i.e. not media items in a known library) is not reflected in an event driven way. Instead, use a normal sync