capacitor-plugin-playlist 0.9.0 → 0.9.1

package/android/src/main/java/org/dwbn/plugins/playlist/OnStatusCallback.kt

@@ -1,21 +1,11 @@
 package org.dwbn.plugins.playlist
 
-import android.util.Log
-import com.getcapacitor.JSObject
 import org.json.JSONException
 import org.json.JSONObject
 
 class OnStatusCallback internal constructor(private val plugin: PlaylistPlugin) {
     fun onStatus(what: RmxAudioStatusMessage, trackId: String?, param: JSONObject?) {
-        val data = JSObject()
-        val detail = JSObject()
-        detail.put("msgType", what.value)
-        detail.put("trackId", trackId)
-        detail.put("value", param)
-        data.put("action", "status")
-        data.put("status", detail)
-        Log.v(TAG, "statusChanged:$data")
-        plugin.emit("status", data)
+        plugin.emitStatus(what, trackId, param)
     }
 
     companion object {
@@ -26,9 +16,9 @@ class OnStatusCallback internal constructor(private val plugin: PlaylistPlugin)
                 error.put("code", code)
                 error.put("message", message ?: "")
             } catch (e: JSONException) {
-                Log.e(TAG, "Exception while raising onStatus: ", e)
+                android.util.Log.e(TAG, "Exception while raising onStatus: ", e)
             }
             return error
         }
     }
-}
+}

package/android/src/main/java/org/dwbn/plugins/playlist/PlaylistPlugin.kt

@@ -17,6 +17,7 @@ public class PlaylistPlugin : Plugin(), OnStatusReportListener {
     private var statusCallback: OnStatusCallback? = null
     private var audioPlayerImpl: RmxAudioPlayer? = null
     private var resetStreamOnPause = true
+    private var isWebViewActive = true
 
     override fun load() {
         audioPlayerImpl = RmxAudioPlayer(this, (this.context.applicationContext as App))
@@ -422,6 +423,19 @@ public class PlaylistPlugin : Plugin(), OnStatusReportListener {
         }
     }
 
+    override fun handleOnPause() {
+        super.handleOnPause()
+        isWebViewActive = false
+    }
+
+    override fun handleOnResume() {
+        super.handleOnResume()
+        isWebViewActive = true
+        Handler(Looper.getMainLooper()).post {
+            audioPlayerImpl?.emitPlaybackSnapshot()
+        }
+    }
+
     override fun handleOnDestroy() {
         Log.d(TAG, "Plugin destroy")
         super.handleOnDestroy()
@@ -474,7 +488,41 @@ public class PlaylistPlugin : Plugin(), OnStatusReportListener {
         return trackItems
     }
 
+    fun emitStatus(what: RmxAudioStatusMessage, trackId: String?, param: JSONObject?) {
+        if (!shouldEmitStatusToBridge(what, isWebViewActive)) {
+            return
+        }
+        val data = JSObject()
+        val detail = JSObject()
+        detail.put("msgType", what.value)
+        detail.put("trackId", trackId)
+        detail.put("value", param)
+        data.put("action", "status")
+        data.put("status", detail)
+        Log.v(TAG, "statusChanged:$data")
+        notifyListeners("status", data, shouldRetainStatusEvent(what))
+    }
+
+    /** @deprecated Use [emitStatus] so retain/gating policy is applied consistently. */
     fun emit(name: String, data: JSObject) {
         this.notifyListeners(name, data, true)
     }
+
+    companion object {
+        @JvmStatic
+        internal fun shouldEmitStatusToBridge(
+            what: RmxAudioStatusMessage,
+            isWebViewActive: Boolean
+        ): Boolean {
+            if (what == RmxAudioStatusMessage.RMXSTATUS_PLAYBACK_POSITION && !isWebViewActive) {
+                return false
+            }
+            return true
+        }
+
+        @JvmStatic
+        internal fun shouldRetainStatusEvent(what: RmxAudioStatusMessage): Boolean {
+            return what != RmxAudioStatusMessage.RMXSTATUS_PLAYBACK_POSITION
+        }
+    }
 }

package/android/src/main/java/org/dwbn/plugins/playlist/RmxAudioPlayer.java

@@ -482,4 +482,13 @@ public class RmxAudioPlayer implements PlaybackStatusListener<AudioTrack>,
     public float getLastKnownPositionSec() {
         return lastKnownHandoffPositionSec;
     }
+
+    public void emitPlaybackSnapshot() {
+        AudioTrack currentItem = playlistManager.getCurrentItem();
+        if (currentItem == null) {
+            return;
+        }
+        JSONObject trackStatus = getPlayerStatus(currentItem);
+        onStatus(RmxAudioStatusMessage.RMXSTATUS_PLAYBACK_POSITION, currentItem.getTrackId(), trackStatus);
+    }
 }

package/android/src/test/java/org/dwbn/plugins/playlist/StatusBridgePolicyTest.kt

@@ -0,0 +1,56 @@
+package org.dwbn.plugins.playlist
+
+import org.junit.Assert.assertFalse
+import org.junit.Assert.assertTrue
+import org.junit.Test
+
+class StatusBridgePolicyTest {
+
+    @Test
+    fun playbackPosition_isSuppressedWhenWebViewInactive() {
+        assertFalse(
+            PlaylistPlugin.shouldEmitStatusToBridge(
+                RmxAudioStatusMessage.RMXSTATUS_PLAYBACK_POSITION,
+                isWebViewActive = false
+            )
+        )
+    }
+
+    @Test
+    fun playbackPosition_isEmittedWhenWebViewActive() {
+        assertTrue(
+            PlaylistPlugin.shouldEmitStatusToBridge(
+                RmxAudioStatusMessage.RMXSTATUS_PLAYBACK_POSITION,
+                isWebViewActive = true
+            )
+        )
+    }
+
+    @Test
+    fun playing_isEmittedWhenWebViewInactive() {
+        assertTrue(
+            PlaylistPlugin.shouldEmitStatusToBridge(
+                RmxAudioStatusMessage.RMXSTATUS_PLAYING,
+                isWebViewActive = false
+            )
+        )
+    }
+
+    @Test
+    fun playbackPosition_isNotRetained() {
+        assertFalse(
+            PlaylistPlugin.shouldRetainStatusEvent(
+                RmxAudioStatusMessage.RMXSTATUS_PLAYBACK_POSITION
+            )
+        )
+    }
+
+    @Test
+    fun playing_isRetained() {
+        assertTrue(
+            PlaylistPlugin.shouldRetainStatusEvent(
+                RmxAudioStatusMessage.RMXSTATUS_PLAYING
+            )
+        )
+    }
+}

package/ios/Plugin/Plugin.swift

@@ -198,8 +198,16 @@ public class PlaylistPlugin: CAPPlugin, StatusUpdater {
         call.resolve(["position": position])
     }
 
+    public override func handleApplicationWillResignActive(_ notification: Notification) {
+        audioPlayerImpl.setWebViewActive(false)
+    }
+
+    public override func handleApplicationDidBecomeActive(_ notification: Notification) {
+        audioPlayerImpl.setWebViewActive(true)
+        audioPlayerImpl.emitPlaybackSnapshot()
+    }
+
     // MARK: - StatusUpdater delegate
-    // todo: calls to notifyListeners should be throttled
     func onStatus(_ data: [String: Any]) {
         notifyListeners("status", data: data)
     }

package/ios/Plugin/RmxAudioPlayer.swift

@@ -28,6 +28,7 @@ final class RmxAudioPlayer: NSObject {
     private var isReplacingItems = false
     private var isWaitingToStartPlayback = false
     private var loop = false
+    private var isWebViewActive = true
 
     let avQueuePlayer = AVBidirectionalQueuePlayer(items: [])
 
@@ -1127,6 +1128,10 @@ final class RmxAudioPlayer: NSObject {
     }
 
     func onStatus(_ what: RmxAudioStatusMessage, trackId: String?, param: [String:Any]?) {
+        if what == .rmxstatus_PLAYBACK_POSITION && !isWebViewActive {
+            return
+        }
+
         var status: [String : Any] = [:]
         status["msgType"] = NSNumber(value: what.rawValue)
         // in the error case contains a dict with "code" and "message", otherwise a NSNumber
@@ -1217,4 +1222,21 @@ final class RmxAudioPlayer: NSObject {
     func getLastKnownPosition() -> Float {
         lastKnownHandoffPosition
     }
+
+    func setWebViewActive(_ active: Bool) {
+        isWebViewActive = active
+    }
+
+    func shouldEmitStatusToBridge(_ what: RmxAudioStatusMessage) -> Bool {
+        if what == .rmxstatus_PLAYBACK_POSITION && !isWebViewActive {
+            return false
+        }
+        return true
+    }
+
+    func emitPlaybackSnapshot() {
+        guard let playerItem = avQueuePlayer.currentAudioTrack else { return }
+        let trackStatus = getStatusItem(playerItem)
+        onStatus(.rmxstatus_PLAYBACK_POSITION, trackId: playerItem.trackId, param: trackStatus)
+    }
 }

package/ios/PluginTests/PluginTests.swift

@@ -1,35 +1,23 @@
 import XCTest
-import Capacitor
 @testable import Plugin
 
 class PluginTests: XCTestCase {
 
-    override func setUp() {
-        super.setUp()
-        // Put setup code here. This method is called before the invocation of each test method in the class.
+    func testPlaybackPositionSuppressedWhenWebViewInactive() {
+        let player = RmxAudioPlayer()
+        player.setWebViewActive(false)
+        XCTAssertFalse(player.shouldEmitStatusToBridge(.rmxstatus_PLAYBACK_POSITION))
     }
 
-    override func tearDown() {
-        // Put teardown code here. This method is called after the invocation of each test method in the class.
-        super.tearDown()
+    func testPlaybackPositionEmittedWhenWebViewActive() {
+        let player = RmxAudioPlayer()
+        player.setWebViewActive(true)
+        XCTAssertTrue(player.shouldEmitStatusToBridge(.rmxstatus_PLAYBACK_POSITION))
     }
 
-    func testEcho() {
-        // This is an example of a functional test case for a plugin.
-        // Use XCTAssert and related functions to verify your tests produce the correct results.
-
-        let value = "Hello, World!"
-        let plugin = MyPlugin()
-
-        let call = CAPPluginCall(callbackId: "test", options: [
-            "value": value
-        ], success: { (result, _) in
-            let resultValue = result!.data["value"] as? String
-            XCTAssertEqual(value, resultValue)
-        }, error: { (_) in
-            XCTFail("Error shouldn't have been called")
-        })
-
-        plugin.echo(call!)
+    func testPlayingEmittedWhenWebViewInactive() {
+        let player = RmxAudioPlayer()
+        player.setWebViewActive(false)
+        XCTAssertTrue(player.shouldEmitStatusToBridge(.rmxstatus_PLAYING))
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "capacitor-plugin-playlist",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "Playlist ",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",