#18 Added a stop button to the playback notification and made it dismissible when paused

README.md

@@ -76,4 +76,4 @@ Interested in seeing a particular feature implemented in this app? Please open a
 
 Contributing
 ------------
-Checkout [CONTRIBUTING.md](https://github.com/SoftwareEngineeringDaily/software-engineering-daily-android/CONTRIBUTING.md) for details.
+Checkout [CONTRIBUTING.md](https://github.com/SoftwareEngineeringDaily/software-engineering-daily-android/blob/master/CONTRIBUTING.md) for details.

app/src/main/java/com/koalatea/sedaily/feature/episodedetail/EpisodeDetailFragment.kt

@@ -323,6 +323,7 @@ class EpisodeDetailFragment : BaseFragment() {
                     is PlayerStatus.Playing -> showStopViews()
                     is PlayerStatus.Paused -> showPlayViews()
                     is PlayerStatus.Ended -> showPlayViews()
+                    is PlayerStatus.Cancelled -> showPlayViews()
                     is PlayerStatus.Error -> acknowledgeGenericError()
                 }
             }

app/src/main/java/com/koalatea/sedaily/feature/player/AudioService.kt

@@ -88,6 +88,7 @@ class AudioService : LifecycleService() {
 
     var episodeId: String? = null
         private set
+    private var episodeTitle: String? = null
 
     private lateinit var exoPlayer: SimpleExoPlayer
 
@@ -117,75 +118,18 @@ class AudioService : LifecycleService() {
                 .build()
         exoPlayer.setAudioAttributes(audioAttributes, true)
 
+        // Monitor ExoPlayer events.
         exoPlayer.addListener(PlayerEventListener())
-    }
-
-    override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int {
-        handleIntent(intent)
-
-        return super.onStartCommand(intent, flags, startId)
-    }
-
-    override fun onDestroy() {
-        cancelPlaybackMonitor()
-
-        mediaSession?.release()
-        mediaSessionConnector?.setPlayer(null)
-        playerNotificationManager?.setPlayer(null)
-
-        exoPlayer.release()
-
-        super.onDestroy()
-    }
-
-    @MainThread
-    fun play(uri: Uri, startPosition: Long, playbackSpeed: Float? = null) {
-        val userAgent = Util.getUserAgent(applicationContext, BuildConfig.APPLICATION_ID)
-        val mediaSource = ExtractorMediaSource(
-                uri,
-                DefaultDataSourceFactory(applicationContext, userAgent),
-                DefaultExtractorsFactory(),
-                null,
-                null)
-
-        val haveStartPosition = startPosition != C.POSITION_UNSET.toLong()
-        if (haveStartPosition) {
-            exoPlayer.seekTo(startPosition)
-        }
-
-        playbackSpeed?.let { changePlaybackSpeed(playbackSpeed) }
-
-        exoPlayer.prepare(mediaSource, !haveStartPosition, false)
-        exoPlayer.playWhenReady = true
-    }
-
-    @MainThread
-    fun resume() {
-        exoPlayer.playWhenReady = true
-    }
-
-    @MainThread
-    fun pause() {
-        exoPlayer.playWhenReady = false
-    }
-
-    @MainThread
-    fun changePlaybackSpeed(playbackSpeed: Float) {
-        exoPlayer.playbackParameters = PlaybackParameters(playbackSpeed)
-    }
-
-    @MainThread
-    private fun handleIntent(intent: Intent?) {
-        episodeId = intent?.getStringExtra(ARG_EPISODE_ID)
 
+        // Setup notification and media session.
         playerNotificationManager = PlayerNotificationManager.createWithNotificationChannel(
                 applicationContext,
                 PLAYBACK_CHANNEL_ID,
                 R.string.playback_channel_name,
                 PLAYBACK_NOTIFICATION_ID,
                 object : PlayerNotificationManager.MediaDescriptionAdapter {
                     override fun getCurrentContentTitle(player: Player): String {
-                        return intent?.getStringExtra(ARG_TITLE) ?: getString(R.string.loading_dots)
+                        return episodeTitle ?: getString(R.string.loading_dots)
                     }
 
                     @Nullable
@@ -211,13 +155,28 @@ class AudioService : LifecycleService() {
                     }
 
                     override fun onNotificationCancelled(notificationId: Int) {
+                        _playerStatusLiveData.value = PlayerStatus.Cancelled(episodeId)
+
                         stopSelf()
                     }
+
+                    override fun onNotificationPosted(notificationId: Int, notification: Notification?, ongoing: Boolean) {
+                        if (ongoing) {
+                            // Make sure the service will not get destroyed while playing media.
+                            startForeground(notificationId, notification)
+                        } else {
+                            // Make notification cancellable.
+                            stopForeground(false)
+                        }
+                    }
                 }
         ).apply {
-            // omit skip previous and next actions
+            // Omit skip previous and next actions.
             setUseNavigationActions(false)
 
+            // Add stop action.
+            setUseStopAction(true)
+
             val incrementMs = resources.getInteger(R.integer.increment_ms).toLong()
             setFastForwardIncrementMs(incrementMs)
             setRewindIncrementMs(incrementMs)
@@ -240,7 +199,7 @@ class AudioService : LifecycleService() {
                         putParcelable(MediaMetadataCompat.METADATA_KEY_DISPLAY_ICON, bitmap)
                     }
 
-                    val title = intent?.getStringExtra(ARG_TITLE) ?: getString(R.string.loading_dots)
+                    val title = episodeTitle ?: getString(R.string.loading_dots)
 
                     return MediaDescriptionCompat.Builder()
                             .setIconBitmap(bitmap)
@@ -252,6 +211,30 @@ class AudioService : LifecycleService() {
 
             setPlayer(exoPlayer)
         }
+    }
+
+    override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int {
+        handleIntent(intent)
+
+        return super.onStartCommand(intent, flags, startId)
+    }
+
+    override fun onDestroy() {
+        cancelPlaybackMonitor()
+
+        mediaSession?.release()
+        mediaSessionConnector?.setPlayer(null)
+        playerNotificationManager?.setPlayer(null)
+
+        exoPlayer.release()
+
+        super.onDestroy()
+    }
+
+    @MainThread
+    private fun handleIntent(intent: Intent?) {
+        episodeId = intent?.getStringExtra(ARG_EPISODE_ID)
+        episodeTitle = intent?.getStringExtra(ARG_TITLE)
 
         // Play
         intent?.let {
@@ -264,6 +247,42 @@ class AudioService : LifecycleService() {
         }
     }
 
+    @MainThread
+    fun play(uri: Uri, startPosition: Long, playbackSpeed: Float? = null) {
+        val userAgent = Util.getUserAgent(applicationContext, BuildConfig.APPLICATION_ID)
+        val mediaSource = ExtractorMediaSource(
+                uri,
+                DefaultDataSourceFactory(applicationContext, userAgent),
+                DefaultExtractorsFactory(),
+                null,
+                null)
+
+        val haveStartPosition = startPosition != C.POSITION_UNSET.toLong()
+        if (haveStartPosition) {
+            exoPlayer.seekTo(startPosition)
+        }
+
+        playbackSpeed?.let { changePlaybackSpeed(playbackSpeed) }
+
+        exoPlayer.prepare(mediaSource, !haveStartPosition, false)
+        exoPlayer.playWhenReady = true
+    }
+
+    @MainThread
+    fun resume() {
+        exoPlayer.playWhenReady = true
+    }
+
+    @MainThread
+    fun pause() {
+        exoPlayer.playWhenReady = false
+    }
+
+    @MainThread
+    fun changePlaybackSpeed(playbackSpeed: Float) {
+        exoPlayer.playbackParameters = PlaybackParameters(playbackSpeed)
+    }
+
     @MainThread
     private fun saveLastListeningPosition() = lifecycleScope.launch {
         episodeId?.let { appDatabase.listenedDao().insert(Listened(it, exoPlayer.contentPosition, exoPlayer.duration)) }
@@ -321,18 +340,21 @@ class AudioService : LifecycleService() {
             if (playbackState == Player.STATE_READY) {
                 if (exoPlayer.playWhenReady) {
                     episodeId?.let { _playerStatusLiveData.value = PlayerStatus.Playing(it) }
-
-                    monitorPlaybackProgress()
                 } else {// Paused
                     episodeId?.let { _playerStatusLiveData.value = PlayerStatus.Paused(it) }
-
-                    cancelPlaybackMonitor()
                 }
             } else if (playbackState == Player.STATE_ENDED) {
                 episodeId?.let { _playerStatusLiveData.value = PlayerStatus.Ended(it) }
             } else {
                 episodeId?.let { _playerStatusLiveData.value = PlayerStatus.Other(it) }
             }
+
+            // Only monitor playback to record progress when playing.
+            if (playbackState == Player.STATE_READY && exoPlayer.playWhenReady) {
+                monitorPlaybackProgress()
+            } else {
+                cancelPlaybackMonitor()
+            }
         }
 
         override fun onPlayerError(e: ExoPlaybackException?) {

app/src/main/java/com/koalatea/sedaily/feature/player/BasePlayerActivity.kt

@@ -66,6 +66,12 @@ abstract class BasePlayerActivity : AppCompatActivity(), PlayerCallback, Playbac
                 _playerStatusLiveData.value = it
 
                 playerOverlayPlayMaterialButton.isSelected = it is PlayerStatus.Playing
+
+                if (it is PlayerStatus.Cancelled) {
+                    dismissPlayerOverlay()
+
+                    stopAudioService()
+                }
             })
 
             // Show player after config change.
@@ -93,11 +99,6 @@ abstract class BasePlayerActivity : AppCompatActivity(), PlayerCallback, Playbac
 
         setupPlayerBottomSheet()
 
-        // Show the player, if the audio service is already running.
-        if (applicationContext.isServiceRunning(AudioService::class.java.name)) {
-            bindToAudioService()
-        }
-
         playerOverlayPlayMaterialButton.setOnClickListener {
             if (playerOverlayPlayMaterialButton.isSelected) {
                 audioService?.pause()
@@ -139,6 +140,17 @@ abstract class BasePlayerActivity : AppCompatActivity(), PlayerCallback, Playbac
         playerView.showController()
     }
 
+    override fun onStart() {
+        super.onStart()
+
+        // Show the player, if the audio service is already running.
+        if (applicationContext.isServiceRunning(AudioService::class.java.name)) {
+            bindToAudioService()
+        } else {
+            dismissPlayerOverlay()
+        }
+    }
+
     override fun onStop() {
         unbindAudioService()
 
@@ -160,8 +172,12 @@ abstract class BasePlayerActivity : AppCompatActivity(), PlayerCallback, Playbac
     override fun stop() {
         dismissPlayerOverlay()
 
+        audioService?.episodeId?.let { episodeId ->
+            _playerStatusLiveData.value = PlayerStatus.Paused(episodeId)
+        } ?: run {
+            _playerStatusLiveData.value = PlayerStatus.Other()
+        }
         stopAudioService()
-        _playerStatusLiveData.value = PlayerStatus.Other()
     }
 
     private fun bindToAudioService() {

app/src/main/java/com/koalatea/sedaily/feature/player/PlayerStatus.kt

@@ -4,6 +4,7 @@ sealed class PlayerStatus(open val episodeId: String?) {
     data class Other(override val episodeId: String? = null) : PlayerStatus(episodeId)
     data class Playing(override val episodeId: String) : PlayerStatus(episodeId)
     data class Paused(override val episodeId: String) : PlayerStatus(episodeId)
+    data class Cancelled(override val episodeId: String? = null) : PlayerStatus(episodeId)
     data class Ended(override val episodeId: String) : PlayerStatus(episodeId)
     data class Error(override val episodeId: String, val exception: Exception?) : PlayerStatus(episodeId)
 }