Add new optional cacheKeyResolver

audio_service/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.18.10
+
+* Add optional `cacheKeyResolver` for MediaItem art (@austinried).
+
 ## 0.18.9
 
 * Fix cache bug in AudioServiceFragmentActivity (@Mordtimer).

audio_service/lib/audio_service.dart

@@ -880,6 +880,13 @@ class AudioService {
   static BaseCacheManager get cacheManager => _cacheManager!;
   static BaseCacheManager? _cacheManager;
 
+  /// The method used to generate the cache key for interacting with a
+  /// MedieItem's artwork in the cache manager.
+  /// Defaults to using [MediaItem.artUri.toString] as the cache key.
+  static FutureOr<String> Function(MediaItem mediaItem) get cacheKeyResolver =>
+      _cacheKeyResolver!;
+  static FutureOr<String> Function(MediaItem mediaItem)? _cacheKeyResolver;
+
   static late AudioServiceConfig _config;
   static late AudioHandler _handler;
 
@@ -919,13 +926,16 @@ class AudioService {
     required T Function() builder,
     AudioServiceConfig? config,
     BaseCacheManager? cacheManager,
+    FutureOr<String> Function(MediaItem mediaItem)? cacheKeyResolver,
   }) async {
     assert(_cacheManager == null);
     config ??= const AudioServiceConfig();
     assert(config.fastForwardInterval > Duration.zero);
     assert(config.rewindInterval > Duration.zero);
     WidgetsFlutterBinding.ensureInitialized();
     _cacheManager = (cacheManager ??= DefaultCacheManager());
+    _cacheKeyResolver = (cacheKeyResolver ??=
+        (MediaItem mediaItem) => mediaItem.artUri.toString());
     final callbacks = _HandlerCallbacks();
     _platform.setHandlerCallbacks(callbacks);
     await _platform.configure(ConfigureRequest(config: config._toMessage()));
@@ -973,8 +983,8 @@ class AudioService {
           _sendToPlatform(artUri.toFilePath());
         } else {
           // Try to load a cached file from memory.
-          final fileInfo =
-              await cacheManager.getFileFromMemory(artUri.toString());
+          final fileInfo = await cacheManager
+              .getFileFromMemory(await cacheKeyResolver(mediaItem));
           final filePath = fileInfo?.file.path;
           if (operationId != _artFetchOperationId) {
             return;
@@ -1147,8 +1157,9 @@ class AudioService {
           final headers = mediaItem.artHeaders;
           final file = headers != null
               ? await cacheManager.getSingleFile(mediaItem.artUri!.toString(),
-                  headers: headers)
-              : await cacheManager.getSingleFile(mediaItem.artUri!.toString());
+                  key: await cacheKeyResolver(mediaItem), headers: headers)
+              : await cacheManager.getSingleFile(mediaItem.artUri!.toString(),
+                  key: await cacheKeyResolver(mediaItem));
           return file.path;
         }
       }

audio_service/pubspec.yaml

@@ -1,6 +1,6 @@
 name: audio_service
 description: Flutter plugin to play audio in the background while the screen is off.
-version: 0.18.9
+version: 0.18.10
 homepage: https://github.com/ryanheise/audio_service/tree/master/audio_service
 
 environment: