capacitor-plugin-playlist 0.8.7 → 0.9.1

package/ios/Plugin/RmxAudioPlayer.swift

@@ -19,6 +19,7 @@ final class RmxAudioPlayer: NSObject {
     var statusUpdater: StatusUpdater? = nil
 
     private var playbackTimeObserver: Any?
+    private var kvoObserversRegistered = false
     private var wasPlayingInterrupted = false
     private var commandCenterRegistered = false
     private var resetStreamOnPause = false
@@ -27,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: [])
 
@@ -52,21 +54,38 @@ final class RmxAudioPlayer: NSObject {
         print("RmxAudioPlayer.execute=initialize")
 
         avQueuePlayer.actionAtItemEnd = .advance
-        avQueuePlayer.addObserver(self, forKeyPath: "currentItem", options: .new, context: nil)
-        avQueuePlayer.addObserver(self, forKeyPath: "rate", options: .new, context: nil)
-        avQueuePlayer.addObserver(self, forKeyPath: "timeControlStatus", options: .new, context: nil)
+        // Guard against duplicate KVO registration (e.g. called more than once without a
+        // matching releaseResources() between calls — would otherwise crash with an
+        // "Cannot remove observer" or duplicate-key exception).
+        if !kvoObserversRegistered {
+            avQueuePlayer.addObserver(self, forKeyPath: "currentItem", options: .new, context: nil)
+            avQueuePlayer.addObserver(self, forKeyPath: "rate", options: .new, context: nil)
+            avQueuePlayer.addObserver(self, forKeyPath: "timeControlStatus", options: .new, context: nil)
+            kvoObserversRegistered = true
+        }
+
+        installPlaybackTimeObserverIfNeeded()
+
+        onStatus(.rmxstatus_REGISTER, trackId: "INIT", param: nil)
+    }
 
+    /// Re-arms the periodic time observer if it is not already installed.
+    /// Safe to call multiple times; no-ops when an observer is already active.
+    /// Must be called on the main thread.
+    private func installPlaybackTimeObserverIfNeeded() {
+        guard playbackTimeObserver == nil else { return }
         let interval = CMTimeMakeWithSeconds(Float64(1.0), preferredTimescale: Int32(Double(NSEC_PER_SEC)))
         playbackTimeObserver = avQueuePlayer.addPeriodicTimeObserver(forInterval: interval, queue: .main, using: { [weak self] time in
             self?.executePeriodicUpdate(time)
         })
-
-        onStatus(.rmxstatus_REGISTER, trackId: "INIT", param: nil)
     }
 
     func setPlaylistItems(_ items: [AudioTrack], options: [String:Any]) {
         print("RmxAudioPlayer.execute=setPlaylistItems, \(options), \(items.count)")
 
+        // Re-arm the periodic observer in case it was removed by a prior releaseResources() call.
+        installPlaybackTimeObserverIfNeeded()
+
         var seekToPosition: Float = 0.0
         let retainPosition = options["retainPosition"] != nil ? (options["retainPosition"] as? Bool) ?? false : false
         let playFromPosition = options["playFromPosition"] != nil ? (options["playFromPosition"] as? Float) ?? 0.0 : 0.0
@@ -202,7 +221,7 @@ final class RmxAudioPlayer: NSObject {
     ///
     /// These functions don't really do anything interesting by themselves.
     func selectTrack(index: Int) throws {
-        guard index >= 0 || index < avQueuePlayer.queuedAudioTracks.count else {
+        guard index >= 0 && index < avQueuePlayer.queuedAudioTracks.count else {
             throw "Index out of Playlist bounds"
         }
         avQueuePlayer.setCurrentIndex(index)
@@ -256,6 +275,8 @@ final class RmxAudioPlayer: NSObject {
     func playCommand(_ isCommand: Bool) {
         wasPlayingInterrupted = false
         initializeMPCommandCenter()
+        // Re-arm the periodic observer if it was removed by a prior releaseResources() call.
+        installPlaybackTimeObserverIfNeeded()
         
         // Ensure audio session is active before playing
         // This is critical when resuming after video player has deactivated the session
@@ -590,7 +611,13 @@ final class RmxAudioPlayer: NSObject {
             let trackStatus = getStatusItem(playerItem)
             print("Playback rate changed: \(String(describing: change[.newKey])), is playing: \(player?.isPlaying ?? false)")
 
-            if player?.isPlaying ?? false {
+            // Use the new rate value to determine playing/paused state.
+            // player?.isPlaying (= timeControlStatus == .playing) is false during the
+            // .waitingToPlayAtSpecifiedRate transition right after play() is called, which
+            // would emit a spurious PAUSE event and leave JS stuck in PAUSED state until the
+            // periodic PLAYBACK_POSITION event corrects it ~1 second later.
+            let newRate = change[.newKey] as? Float ?? 0
+            if newRate != 0 {
                 onStatus(.rmxstatus_PLAYING, trackId: playerItem.trackId, param: trackStatus)
             } else {
                 onStatus(.rmxstatus_PAUSE, trackId: playerItem.trackId, param: trackStatus)
@@ -1101,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
@@ -1139,11 +1170,73 @@ final class RmxAudioPlayer: NSObject {
         if let playbackTimeObserver = playbackTimeObserver {
             avQueuePlayer.removeTimeObserver(playbackTimeObserver)
         }
+        playbackTimeObserver = nil
+
+        // Remove the queue-level KVO observers added in initialize() so that a subsequent
+        // initialize() call does not crash with a duplicate-observer exception.
+        if kvoObserversRegistered {
+            avQueuePlayer.removeObserver(self, forKeyPath: "currentItem")
+            avQueuePlayer.removeObserver(self, forKeyPath: "rate")
+            avQueuePlayer.removeObserver(self, forKeyPath: "timeControlStatus")
+            kvoObserversRegistered = false
+        }
+
         deregisterMusicControlsEventListener()
+        // commandCenterRegistered is already reset inside deregisterMusicControlsEventListener()
 
         removeAllTracks()
 
-        playbackTimeObserver = nil
         isWaitingToStartPlayback = false
     }
+
+    // MARK: - Epic 45 video handoff
+
+    private var lastKnownHandoffPosition: Float = 0
+
+    func prepareForVideoHandoff() {
+        pauseCommand(false)
+        // Capture position after pausing so lastKnownHandoffPosition reflects the
+        // true stopped head, not a value that may have ticked during the pause call.
+        if let track = avQueuePlayer.currentAudioTrack {
+            lastKnownHandoffPosition = getTrackCurrentTime(track)
+        } else {
+            lastKnownHandoffPosition = 0
+        }
+        do {
+            try AVAudioSession.sharedInstance().setActive(false, options: [.notifyOthersOnDeactivation])
+        } catch {
+            print("prepareForVideoHandoff: setActive(false) failed: \(error.localizedDescription)")
+        }
+    }
+
+    func resumeAfterVideoHandoff(position: Float) {
+        lastKnownHandoffPosition = position
+        activateAudioSession()
+        // Reset lastTrackId so the timeControlStatus KVO guard does not suppress the PLAYING
+        // event on same-track non-index-0 resume. The guard `lastTrackId != trackId || isAtBeginning`
+        // (where isAtBeginning = currentIndex() == 0) would silently drop the PLAYING transition
+        // for any audio track at playlist index > 0, leaving JS stuck in PAUSED.
+        lastTrackId = nil
+    }
+
+    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.8.7",
+  "version": "0.9.1",
   "description": "Playlist ",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",