@capgo/native-audio 7.3.37 → 7.5.0

package/CapgoNativeAudio.podspec

@@ -10,7 +10,7 @@ Pod::Spec.new do |s|
   s.homepage = package['repository']['url']
   s.author = package['author']
   s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
-  s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
   s.ios.deployment_target = '14.0'
   s.dependency 'Capacitor'
 end

package/Package.swift

@@ -0,0 +1,31 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "CapgoNativeAudio",
+    platforms: [
+        .iOS(.v14)
+    ],
+    products: [
+        .library(
+            name: "CapgoNativeAudio",
+            targets: ["NativeAudioPlugin"]
+        )
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "7.0.0")
+    ],
+    targets: [
+        .target(
+            name: "NativeAudioPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm")
+            ],
+            path: "ios/Sources/NativeAudioPlugin"),
+        .testTarget(
+            name: "NativeAudioPluginTests",
+            dependencies: ["NativeAudioPlugin"],
+            path: "ios/Tests/NativeAudioPluginTests")
+    ]
+)

package/README.md

@@ -75,6 +75,10 @@ npx cap sync
 
 On iOS, Android and Web, no further steps are needed.
 
+### Swift Package Manager
+
+You can also consume the iOS implementation via Swift Package Manager. In Xcode open **File → Add Package…**, point it at `https://github.com/Cap-go/capacitor-native-audio.git`, and select the `CapgoNativeAudio` library product. The package supports iOS 14 and newer alongside Capacitor 7.
+
 ## Configuration
 
 No configuration required for this plugin.
@@ -106,6 +110,21 @@ No configuration required for this plugin.
 
 [Example repository](https://github.com/bazuka5801/native-audio-example)
 
+## Example app
+
+This repository now ships with an interactive Capacitor project under `example/` that exercises the main APIs on web, iOS, and Android shells.
+
+```bash
+cd example
+npm install
+npm run dev      # start the web playground
+npm run sync     # optional: generate iOS/Android platforms
+npm run ios      # open the iOS shell app
+npm run android  # open the Android shell app
+```
+
+The UI demonstrates local asset preloading, remote streaming, playback controls, looping, live position updates, and cache clearing for remote audio.
+
 ```typescript
 import {NativeAudio} from '@capgo/native-audio'
 

package/android/src/main/java/ee/forgr/audio/StreamAudioAsset.java

@@ -352,7 +352,8 @@ public class StreamAudioAsset extends AudioAsset {
     }
 
     private void startPlaybackWithFade(Double time) {
-        if (!player.isPlayingAd()) { // Make sure we're not in an ad
+        if (!player.isPlayingAd()) {
+            // Make sure we're not in an ad
             if (time != null) {
                 player.seekTo(Math.round(time * 1000));
             } else if (player.isCurrentMediaItemLive()) {
@@ -393,7 +394,8 @@ public class StreamAudioAsset extends AudioAsset {
                 public void run() {
                     if (player.isPlaying()) {
                         fadeIn();
-                    } else if (attempts < 10) { // Try for 5 seconds (10 * 500ms)
+                    } else if (attempts < 10) {
+                        // Try for 5 seconds (10 * 500ms)
                         attempts++;
                         handler.postDelayed(this, 500);
                     }

package/ios/{Plugin → Sources/NativeAudioPlugin}/RemoteAudioAsset.swift

@@ -17,7 +17,7 @@ public class RemoteAudioAsset: AudioAsset {
 
         owner.executeOnAudioQueue { [weak self] in
             guard let self = self else { return }
-            
+
             guard let url = URL(string: path ?? "") else {
                 print("Invalid URL: \(String(describing: path))")
                 return
@@ -158,13 +158,13 @@ public class RemoteAudioAsset: AudioAsset {
                 forName: NSNotification.Name.AVPlayerItemDidPlayToEndTime,
                 object: player.currentItem,
                 queue: OperationQueue.main) { [weak self, weak player] notification in
-                    guard let strongSelf = self, let strongPlayer = player else { return }
+                guard let strongSelf = self, let strongPlayer = player else { return }
 
-                    if let currentItem = notification.object as? AVPlayerItem,
-                       strongPlayer.currentItem == currentItem {
-                        strongSelf.playerDidFinishPlaying(player: strongPlayer)
-                    }
+                if let currentItem = notification.object as? AVPlayerItem,
+                   strongPlayer.currentItem === currentItem {
+                    strongSelf.playerDidFinishPlaying(player: strongPlayer)
                 }
+            }
             notificationObservers.append(observer)
             startCurrentTimeUpdates()
         }
@@ -205,14 +205,14 @@ public class RemoteAudioAsset: AudioAsset {
                     forName: .AVPlayerItemDidPlayToEndTime,
                     object: playerItem,
                     queue: OperationQueue.main) { [weak self, weak player] notification in
-                        guard let strongPlayer = player,
-                              let strongSelf = self,
-                              let item = notification.object as? AVPlayerItem,
-                              strongPlayer.currentItem === item else { return }
+                    guard let strongPlayer = player,
+                          let strongSelf = self,
+                          let item = notification.object as? AVPlayerItem,
+                          strongPlayer.currentItem === item else { return }
 
-                        strongPlayer.seek(to: .zero)
-                        strongPlayer.play()
-                    }
+                    strongPlayer.seek(to: .zero)
+                    strongPlayer.play()
+                }
 
                 notificationObservers.append(observer)
 

package/ios/Tests/NativeAudioPluginTests/PluginTests.swift

@@ -0,0 +1,308 @@
+import XCTest
+import Capacitor
+import AVFoundation
+@testable import NativeAudio
+
+class PluginTests: XCTestCase {
+
+    var plugin: NativeAudio!
+    var tempFileURL: URL!
+    var testAssetId = "testAssetId"
+    var testRemoteAssetId = "testRemoteAssetId"
+
+    override func setUp() {
+        super.setUp()
+        plugin = NativeAudio()
+
+        // Create a temporary audio file for testing
+        let audioFilePath = NSTemporaryDirectory().appending("testAudio.wav")
+        tempFileURL = URL(fileURLWithPath: audioFilePath)
+
+        // Create a simple test audio file if needed
+        if !FileManager.default.fileExists(atPath: audioFilePath) {
+            createTestAudioFile(at: audioFilePath)
+        }
+    }
+
+    override func tearDown() {
+        // Clean up any audio assets
+        plugin.executeOnAudioQueue {
+            if let asset = self.plugin.audioList[self.testAssetId] as? AudioAsset {
+                asset.unload()
+            }
+            if let asset = self.plugin.audioList[self.testRemoteAssetId] as? RemoteAudioAsset {
+                asset.unload()
+            }
+            self.plugin.audioList.removeAll()
+        }
+
+        // Try to delete the temporary file
+        try? FileManager.default.removeItem(at: tempFileURL)
+
+        plugin = nil
+        super.tearDown()
+    }
+
+    // Helper method to create a simple test audio file
+    private func createTestAudioFile(at path: String) {
+        // This is a placeholder for a real implementation
+        // In a real scenario, you would create a small audio file for testing
+        // For now, we'll just create an empty file
+        FileManager.default.createFile(atPath: path, contents: Data(), attributes: nil)
+    }
+
+    func testAudioAssetInitialization() {
+        let expectation = XCTestExpectation(description: "Initialize AudioAsset")
+
+        plugin.executeOnAudioQueue {
+            // Create an audio asset
+            let asset = AudioAsset(
+                owner: self.plugin,
+                withAssetId: self.testAssetId,
+                withPath: self.tempFileURL.path,
+                withChannels: 1,
+                withVolume: 0.5,
+                withFadeDelay: 0.5
+            )
+
+            // Add it to the plugin's audio list
+            self.plugin.audioList[self.testAssetId] = asset
+
+            // Verify initial values
+            XCTAssertEqual(asset.assetId, self.testAssetId)
+            XCTAssertEqual(asset.initialVolume, 0.5)
+            XCTAssertEqual(asset.fadeDelay, 0.5)
+
+            expectation.fulfill()
+        }
+
+        wait(for: [expectation], timeout: 5.0)
+    }
+
+    func testAudioAssetVolumeControl() {
+        let expectation = XCTestExpectation(description: "Test volume control")
+
+        plugin.executeOnAudioQueue {
+            // Create an audio asset
+            let asset = AudioAsset(
+                owner: self.plugin,
+                withAssetId: self.testAssetId,
+                withPath: self.tempFileURL.path,
+                withChannels: 1,
+                withVolume: 1.0,
+                withFadeDelay: 0.5
+            )
+
+            // Add it to the plugin's audio list
+            self.plugin.audioList[self.testAssetId] = asset
+
+            // Test setting volume
+            let testVolume: Float = 0.7
+            asset.setVolume(volume: NSNumber(value: testVolume))
+
+            // We can't directly check player.volume as it may take time to set
+            // So we'll just verify the method doesn't crash
+
+            expectation.fulfill()
+        }
+
+        wait(for: [expectation], timeout: 5.0)
+    }
+
+    func testRemoteAudioAssetInitialization() {
+        let expectation = XCTestExpectation(description: "Initialize RemoteAudioAsset")
+
+        // Use a publicly accessible test audio URL
+        let testURL = "https://file-examples.com/storage/fe5947fd2362a2f06a86851/2017/11/file_example_MP3_700KB.mp3"
+
+        plugin.executeOnAudioQueue {
+            // Create a remote audio asset
+            let asset = RemoteAudioAsset(
+                owner: self.plugin,
+                withAssetId: self.testRemoteAssetId,
+                withPath: testURL,
+                withChannels: 1,
+                withVolume: 0.6,
+                withFadeDelay: 0.3
+            )
+
+            // Add it to the plugin's audio list
+            self.plugin.audioList[self.testRemoteAssetId] = asset
+
+            // Verify initial values
+            XCTAssertEqual(asset.assetId, self.testRemoteAssetId)
+            XCTAssertEqual(asset.initialVolume, 0.6)
+            XCTAssertEqual(asset.fadeDelay, 0.3)
+            XCTAssertNotNil(asset.asset, "AVURLAsset should be created")
+
+            expectation.fulfill()
+        }
+
+        wait(for: [expectation], timeout: 5.0)
+    }
+
+    func testPluginPreloadMethod() {
+        // Create a plugin call to test the preload method
+        let call = CAPPluginCall(callbackId: "test", options: [
+            "assetId": testAssetId,
+            "assetPath": tempFileURL.path,
+            "volume": 0.8,
+            "audioChannelNum": 2
+        ], success: { (_, _) in
+            // Success case
+        }, error: { (_) in
+            XCTFail("Preload shouldn't fail")
+        })
+
+        // Call the plugin method
+        plugin.preload(call)
+
+        // Verify the asset was loaded by checking if it exists in the audioList
+        plugin.executeOnAudioQueue {
+            XCTAssertNotNil(self.plugin.audioList[self.testAssetId])
+            if let asset = self.plugin.audioList[self.testAssetId] as? AudioAsset {
+                XCTAssertEqual(asset.assetId, self.testAssetId)
+                XCTAssertEqual(asset.initialVolume, 0.8)
+            } else {
+                XCTFail("Asset should be of type AudioAsset")
+            }
+        }
+    }
+
+    func testFadeEffects() {
+        let expectation = XCTestExpectation(description: "Test fade effects")
+
+        plugin.executeOnAudioQueue {
+            // Create an audio asset
+            let asset = AudioAsset(
+                owner: self.plugin,
+                withAssetId: self.testAssetId,
+                withPath: self.tempFileURL.path,
+                withChannels: 1,
+                withVolume: 1.0,
+                withFadeDelay: 0.2
+            )
+
+            // Test fade functionality (just make sure it doesn't crash)
+            asset.playWithFade(time: 0)
+
+            // Wait a short time for fade to start
+            DispatchQueue.main.asyncAfter(deadline: .now() + 0.3) {
+                // Then test stop with fade
+                asset.stopWithFade()
+
+                // Wait for fade to complete
+                DispatchQueue.main.asyncAfter(deadline: .now() + 0.3) {
+                    expectation.fulfill()
+                }
+            }
+        }
+
+        wait(for: [expectation], timeout: 5.0)
+    }
+
+    // Test the ClearCache functionality
+    func testClearCache() {
+        // This is mostly a method call test to ensure it doesn't crash
+        RemoteAudioAsset.clearCache()
+
+        // We can't easily verify the cache was cleared without complex setup,
+        // but we can ensure the method completes without errors
+        XCTAssertTrue(true)
+    }
+
+    // Test notification observer pattern in RemoteAudioAsset
+    func testNotificationObserverPattern() {
+        let expectation = XCTestExpectation(description: "Test notification observer")
+
+        // Use a publicly accessible test audio URL
+        let testURL = "https://file-examples.com/storage/fe5947fd2362a2f06a86851/2017/11/file_example_MP3_700KB.mp3"
+
+        plugin.executeOnAudioQueue {
+            // Create a remote audio asset
+            let asset = RemoteAudioAsset(
+                owner: self.plugin,
+                withAssetId: self.testRemoteAssetId,
+                withPath: testURL,
+                withChannels: 1,
+                withVolume: 0.6,
+                withFadeDelay: 0.3
+            )
+
+            // Add it to the plugin's audio list
+            self.plugin.audioList[self.testRemoteAssetId] = asset
+
+            // Verify initial values
+            XCTAssertEqual(asset.notificationObservers.count, 0, "Should start with zero notification observers")
+
+            // Test the resume method which sets up a notification observer
+            asset.resume()
+
+            // Check that a notification observer was added
+            XCTAssertGreaterThan(asset.notificationObservers.count, 0, "Should have added notification observers")
+
+            // Now test cleanup
+            asset.cleanupNotificationObservers()
+            XCTAssertEqual(asset.notificationObservers.count, 0, "Should have removed all notification observers")
+
+            expectation.fulfill()
+        }
+
+        wait(for: [expectation], timeout: 5.0)
+    }
+
+    // Test the fade timer functionality, which was a key part of our fixes
+    func testFadeTimerFunctionality() {
+        let expectation = XCTestExpectation(description: "Test fade timer")
+
+        plugin.executeOnAudioQueue {
+            // Create an audio asset
+            let asset = AudioAsset(
+                owner: self.plugin,
+                withAssetId: self.testAssetId,
+                withPath: self.tempFileURL.path,
+                withChannels: 1,
+                withVolume: 1.0,
+                withFadeDelay: 0.5
+            )
+
+            // Ensure the fade timer is nil initially
+            XCTAssertNil(asset.fadeTimer, "Fade timer should be nil initially")
+
+            // Access the private method using reflection
+            // (this is a test-only approach to access private methods)
+            let selector = NSSelectorFromString("startVolumeRamp:to:player:")
+            if asset.responds(to: selector) {
+                // Create a test mock for AVAudioPlayer
+                guard let player = asset.channels.first else {
+                    XCTFail("No audio player available")
+                    expectation.fulfill()
+                    return
+                }
+
+                // Set initial volume
+                player.volume = 1.0
+
+                // Invoke using performSelector
+                asset.perform(selector, with: NSNumber(value: 1.0), with: NSNumber(value: 0.0), with: player)
+
+                // Check that the fade timer was created
+                XCTAssertNotNil(asset.fadeTimer, "Fade timer should be created")
+
+                // Wait for fade to complete
+                DispatchQueue.main.asyncAfter(deadline: .now() + 1.0) {
+                    // Fade should be complete, timer should be nil again
+                    XCTAssertNil(asset.fadeTimer, "Fade timer should be nil after completion")
+                    XCTAssertEqual(player.volume, 0.0, "Volume should be 0 after fade out")
+
+                    expectation.fulfill()
+                }
+            } else {
+                XCTFail("startVolumeRamp method not available")
+                expectation.fulfill()
+            }
+        }
+
+        wait(for: [expectation], timeout: 5.0)
+    }
+}

package/ios/Tests/README.md

@@ -0,0 +1,39 @@
+# Native Audio Plugin Tests
+
+This directory contains tests for the Capacitor Native Audio Plugin.
+
+## Running Tests
+
+The easiest way to run these tests is through Xcode:
+
+1. Open the `Plugin.xcworkspace` file in Xcode
+2. Select the "Plugin" scheme
+3. Go to Product > Test (or press ⌘+U)
+
+## Test Coverage
+
+The tests cover the following functionality:
+
+- Basic initialization of `AudioAsset` and `RemoteAudioAsset` classes
+- Volume control
+- Fade effects (fade in/out)
+- Notification observer pattern
+- Cache clearing
+- Plugin preloading
+
+## Notes for Test Development
+
+- The tests use a temporary audio file created at runtime
+- For remote audio tests, a publicly accessible MP3 file is used
+- Some tests use reflection to access private methods (for testing purposes only)
+- All tests run on the plugin's audio queue to maintain thread safety
+
+## Troubleshooting
+
+If tests fail:
+
+1. Make sure the iOS simulator is available
+2. Check that the audio session is properly configured
+3. For remote tests, ensure network connectivity is available
+
+To view detailed test logs, expand the test navigator in Xcode and click on the failing test. 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/native-audio",
-  "version": "7.3.37",
+  "version": "7.5.0",
   "description": "A native plugin for native audio engine",
   "license": "MIT",
   "main": "dist/plugin.cjs.js",
@@ -11,7 +11,9 @@
     "android/src/main/",
     "android/build.gradle",
     "dist/",
-    "ios/Plugin/",
+    "ios/Sources",
+    "ios/Tests",
+    "Package.swift",
     "CapgoNativeAudio.podspec"
   ],
   "author": "Martin Donadieu",
@@ -32,7 +34,7 @@
   ],
   "scripts": {
     "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
-    "verify:ios": "cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin && cd ..",
+    "verify:ios": "xcodebuild -scheme CapgoNativeAudio -destination generic/platform=iOS",
     "verify:android": "cd android && ./gradlew clean build test && cd ..",
     "verify:web": "npm run build",
     "test": "npm run test:ios",

package/ios/Plugin/Info.plist

@@ -1,24 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>CFBundleDevelopmentRegion</key>
-	<string>$(DEVELOPMENT_LANGUAGE)</string>
-	<key>CFBundleExecutable</key>
-	<string>$(EXECUTABLE_NAME)</string>
-	<key>CFBundleIdentifier</key>
-	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
-	<key>CFBundleInfoDictionaryVersion</key>
-	<string>6.0</string>
-	<key>CFBundleName</key>
-	<string>$(PRODUCT_NAME)</string>
-	<key>CFBundlePackageType</key>
-	<string>FMWK</string>
-	<key>CFBundleShortVersionString</key>
-	<string>$(MARKETING_VERSION)</string>
-	<key>CFBundleVersion</key>
-	<string>$(CURRENT_PROJECT_VERSION)</string>
-	<key>NSPrincipalClass</key>
-	<string></string>
-</dict>
-</plist>