chore: improve metadata handling (#85)

kotlin-audio/src/main/java/com/doublesymmetry/kotlinaudio/models/PlayerConfig.kt

@@ -30,13 +30,4 @@ data class PlayerConfig(
      * The audio content type.
      */
     val audioContentType: AudioContentType = AudioContentType.MUSIC,
-
-    /**
-     * Throttle interval for updating notification UI
-     *
-     * Android applies a rate limit when updating a notification (Default is 5 times per second)
-     *
-     * This flag will reduce the update rate when user interact with the notification consecutively
-     */
-    val androidNotificationThrottleInterval: Long = BaseAudioPlayer.ANDROID_NOTIFICATION_UPDATE_THROTTLE_INTERVAL
 )

kotlin-audio/src/main/java/com/doublesymmetry/kotlinaudio/players/BaseAudioPlayer.kt

@@ -8,6 +8,7 @@ import android.os.Bundle
 import android.os.ResultReceiver
 import android.support.v4.media.RatingCompat
 import android.support.v4.media.session.MediaSessionCompat
+import android.support.v4.media.MediaMetadataCompat
 import androidx.annotation.CallSuper
 import androidx.core.content.ContextCompat
 import androidx.media.AudioAttributesCompat
@@ -38,6 +39,7 @@ import com.doublesymmetry.kotlinaudio.models.PlayerOptions
 import com.doublesymmetry.kotlinaudio.models.PositionChangedReason
 import com.doublesymmetry.kotlinaudio.notification.NotificationManager
 import com.doublesymmetry.kotlinaudio.players.components.PlayerCache
+import com.doublesymmetry.kotlinaudio.players.components.getAudioItemHolder
 import com.doublesymmetry.kotlinaudio.utils.isUriLocal
 import com.google.android.exoplayer2.C
 import com.google.android.exoplayer2.DefaultLoadControl
@@ -95,7 +97,7 @@ abstract class BaseAudioPlayer internal constructor(
     open val playerOptions: PlayerOptions = DefaultPlayerOptions()
 
     open val currentItem: AudioItem?
-        get() = exoPlayer.currentMediaItem?.localConfiguration?.tag as AudioItem?
+        get() = exoPlayer.currentMediaItem?.getAudioItemHolder()?.audioItem
 
     var playbackError: PlaybackError? = null
     var playerState: AudioPlayerState = AudioPlayerState.IDLE
@@ -233,8 +235,7 @@ abstract class BaseAudioPlayer internal constructor(
             mediaSession,
             mediaSessionConnector,
             notificationEventHolder,
-            playerEventHolder,
-            playerConfig.androidNotificationThrottleInterval
+            playerEventHolder
         )
 
         exoPlayer.addListener(PlayerListener())
@@ -256,6 +257,9 @@ abstract class BaseAudioPlayer internal constructor(
                 .build();
             exoPlayer.setAudioAttributes(audioAttributes, playerConfig.handleAudioFocus);
             mediaSessionConnector.setPlayer(playerToUse)
+            mediaSessionConnector.setMediaMetadataProvider {
+                notificationManager.getMediaMetadataCompat()
+            }
         }
 
         playerEventHolder.updateAudioPlayerState(AudioPlayerState.IDLE)
@@ -313,13 +317,9 @@ abstract class BaseAudioPlayer internal constructor(
         }
     }
 
-    internal fun updateNotificationMetadataIfAutomatic() {
+    internal fun resetNotificationMetadataIfAutomatic() {
         if (automaticallyUpdateNotificationMetadata) {
-            notificationManager.notificationMetadata = NotificationMetadata(
-                currentItem?.title,
-                currentItem?.artist,
-                currentItem?.artwork
-            )
+            notificationManager.notificationMetadata = null
         }
     }
 
@@ -440,14 +440,12 @@ abstract class BaseAudioPlayer internal constructor(
         exoPlayer.seekTo(positionMs)
     }
 
-    private fun getMediaItemFromAudioItem(audioItem: AudioItem): MediaItem {
-        return MediaItem.Builder().setUri(audioItem.audioUrl).setTag(AudioItemHolder(audioItem)).build()
-    }
-
     protected fun getMediaSourceFromAudioItem(audioItem: AudioItem): MediaSource {
-        val factory: DataSource.Factory
         val uri = Uri.parse(audioItem.audioUrl)
-        val mediaItem = getMediaItemFromAudioItem(audioItem)
+        val mediaItem = MediaItem.Builder()
+            .setUri(audioItem.audioUrl)
+            .setTag(AudioItemHolder(audioItem))
+            .build()
 
         val userAgent =
             if (audioItem.options == null || audioItem.options!!.userAgent.isNullOrBlank()) {
@@ -456,7 +454,7 @@ abstract class BaseAudioPlayer internal constructor(
                 audioItem.options!!.userAgent
             }
 
-        factory = when {
+        val factory: DataSource.Factory = when {
             audioItem.options?.resourceId != null -> {
                 val raw = RawResourceDataSource(context)
                 raw.open(DataSpec(uri))
@@ -676,7 +674,7 @@ abstract class BaseAudioPlayer internal constructor(
                 )
             }
 
-            updateNotificationMetadataIfAutomatic()
+            resetNotificationMetadataIfAutomatic()
         }
 
         /**

kotlin-audio/src/main/java/com/doublesymmetry/kotlinaudio/players/QueuedAudioPlayer.kt

@@ -2,6 +2,7 @@ package com.doublesymmetry.kotlinaudio.players
 
 import android.content.Context
 import com.doublesymmetry.kotlinaudio.models.*
+import com.doublesymmetry.kotlinaudio.players.components.getAudioItemHolder
 import com.google.android.exoplayer2.C
 import com.google.android.exoplayer2.IllegalSeekPositionException
 import com.google.android.exoplayer2.source.MediaSource
@@ -22,7 +23,7 @@ class QueuedAudioPlayer(
         get() = exoPlayer.currentMediaItemIndex
 
     override val currentItem: AudioItem?
-        get() = (queue.getOrNull(currentIndex)?.mediaItem?.localConfiguration?.tag as AudioItemHolder?)?.audioItem
+        get() = queue.getOrNull(currentIndex)?.mediaItem?.getAudioItemHolder()?.audioItem
 
     val nextIndex: Int?
         get() {
@@ -37,22 +38,22 @@ class QueuedAudioPlayer(
         }
 
     val items: List<AudioItem>
-        get() = queue.map { (it.mediaItem.localConfiguration?.tag as AudioItemHolder).audioItem }
+        get() = queue.map { it.mediaItem.getAudioItemHolder().audioItem }
 
     val previousItems: List<AudioItem>
         get() {
             return if (queue.isEmpty()) emptyList()
             else queue
                 .subList(0, exoPlayer.currentMediaItemIndex)
-                .map { (it.mediaItem.localConfiguration?.tag as AudioItemHolder).audioItem }
+                .map { it.mediaItem.getAudioItemHolder().audioItem }
         }
 
     val nextItems: List<AudioItem>
         get() {
             return if (queue.isEmpty()) emptyList()
             else queue
                 .subList(exoPlayer.currentMediaItemIndex, queue.lastIndex)
-                .map { (it.mediaItem.localConfiguration?.tag as AudioItemHolder).audioItem }
+                .map { it.mediaItem.getAudioItemHolder().audioItem }
         }
 
     val nextItem: AudioItem?
@@ -217,7 +218,7 @@ class QueuedAudioPlayer(
         val mediaSource = getMediaSourceFromAudioItem(item)
         queue[index] = mediaSource
         if (index == currentIndex) {
-            updateNotificationMetadataIfAutomatic()
+            resetNotificationMetadataIfAutomatic()
         }
     }
 

kotlin-audio/src/main/java/com/doublesymmetry/kotlinaudio/players/components/MediaItemExt.kt

@@ -0,0 +1,8 @@
+package com.doublesymmetry.kotlinaudio.players.components
+
+import com.doublesymmetry.kotlinaudio.models.AudioItemHolder
+import com.google.android.exoplayer2.MediaItem
+
+fun MediaItem.getAudioItemHolder(): AudioItemHolder {
+    return localConfiguration!!.tag as AudioItemHolder
+}