mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2026-05-30 23:40:40 +02:00
[PR #3690] [MERGED] Improved Metadata Handling and PlaybackSession Metadata Robustness #4055
Assignees
adam (Adam Melkus)
Clear assignees
adam (Adam Melkus)
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: starred/audiobookshelf#4055
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
📋 Pull Request Information
Original PR: https://github.com/advplyr/audiobookshelf/pull/3690
Author: @Vito0912
Created: 12/7/2024
Status: ✅ Merged
Merged: 4/19/2025
Merged by: @advplyr
Base:
master← Head:feat/metadataForPlaybackSessions📝 Commits (8)
33e0987Added mediaMetadata to playbackSessions8916754added author for podcasts2fbb31eadded null saftey and added displayTitle and displayAuthorf9bbd71added type to be saved. Should support podcasts121805bMerge branch 'master' into feat/metadataForPlaybackSessionse6ab05eupdate so also populates data if mediaMetadata is not nulld7f0815Merge branch 'master' into feat/metadataForPlaybackSessions2caa861Update local session mediaMetadata with current item mediaMetadata for undefined values📊 Changes
1 file changed (+19 additions, -0 deletions)
View changed files
📝
server/managers/PlaybackSessionManager.js(+19 -0)📄 Description
Brief summary
This appends the server's existing
mediaMetadatato theplaybackSessionif the client does not supply it.Which issue is fixed?
This resolves server crashes caused by missing
mediaMetadata(even though they are addressed separately) and corrects inaccurate stats when the client does not providemediaMetadata. Additionally, it slightly reduces bandwidth usage during local session syncing.In-depth Description
If
mediaMetadatais absent in the payload sent by the client, the server will use the metadata it already has (libraryitem.media.metadata).Only essential attributes are included in the
playbackSessionto avoid unnecessary data, such as descriptions, which are often lengthy and typically unneeded.Additionally,
displayTitleanddisplayAuthorwill fall back to the correspondingmediaMetadatavalues when not provided, ensuring they are displayed even if the client does not sends them.How have you tested this?
This has been tested with both my own client and the web client.
Copilot summary
This pull request includes changes to the
PlaybackSessionManagerclass to ensure that client-provided metadata is preferred over library metadata when available. This change aims to make the system more robust and user-friendly by prioritizing user-specific information.Improvements to metadata handling:
server/managers/PlaybackSessionManager.js: Added logic to prefer client-provided metadata (such as title, subtitle, narrators, authors, series, genres, and author) over library metadata if available. This ensures that important metadata is synchronized and displayed correctly.🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.