@capgo/native-audio 6.0.20 → 6.1.0

package/README.md

@@ -1,14 +1,23 @@
-<a href="https://capgo.app/"><img src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/></a>
+<a href="https://capgo.app/">
+  <img
+    src="https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png"
+    alt="Capgo - Instant updates for capacitor"
+  />
+</a>
 
 <div align="center">
-<h2><a href="https://capgo.app/">Check out: Capgo — Instant updates for capacitor</a></h2>
+  <h2>
+    <a href="https://capgo.app/">Check out: Capgo — Instant updates for capacitor</a>
+  </h2>
 </div>
 
 <h3 align="center">Native Audio</h3>
-<p align="center"><strong><code>@capgo/native-audio</code></strong></p>
 <p align="center">
-  Capacitor plugin for playing sounds.
+  <strong>
+    <code>@capgo/native-audio</code>
+  </strong>
 </p>
+<p align="center">Capacitor plugin for playing sounds.</p>
 
 <p align="center">
   <img src="https://img.shields.io/maintenance/yes/2023?style=flat-square" />
@@ -239,12 +248,12 @@ preload(options: PreloadOptions) => Promise<void>
 ### play(...)
 
 ```typescript
-play(options: { assetId: string; time?: number; }) => Promise<void>
+play(options: { assetId: string; time?: number; delay?: number; }) => Promise<void>
 ```
 
-| Param         | Type                                             |
-| ------------- | ------------------------------------------------ |
-| **`options`** | <code>{ assetId: string; time?: number; }</code> |
+| Param         | Type                                                             |
+| ------------- | ---------------------------------------------------------------- |
+| **`options`** | <code>{ assetId: string; time?: number; delay?: number; }</code> |
 
 --------------------
 
@@ -410,10 +419,11 @@ Listen for complete event
 
 #### ConfigureOptions
 
-| Prop        | Type                 |
-| ----------- | -------------------- |
-| **`fade`**  | <code>boolean</code> |
-| **`focus`** | <code>boolean</code> |
+| Prop             | Type                 |
+| ---------------- | -------------------- |
+| **`fade`**       | <code>boolean</code> |
+| **`focus`**      | <code>boolean</code> |
+| **`background`** | <code>boolean</code> |
 
 
 #### PreloadOptions

package/dist/docs.json

@@ -43,12 +43,12 @@
       },
       {
         "name": "play",
-        "signature": "(options: { assetId: string; time?: number; }) => Promise<void>",
+        "signature": "(options: { assetId: string; time?: number; delay?: number; }) => Promise<void>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "{ assetId: string; time?: number | undefined; }"
+            "type": "{ assetId: string; time?: number | undefined; delay?: number | undefined; }"
           }
         ],
         "returns": "Promise<void>",
@@ -270,6 +270,13 @@
           "docs": "",
           "complexTypes": [],
           "type": "boolean | undefined"
+        },
+        {
+          "name": "background",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean | undefined"
         }
       ]
     },

package/dist/esm/definitions.d.ts

@@ -14,6 +14,7 @@ export interface NativeAudio {
     play(options: {
         assetId: string;
         time?: number;
+        delay?: number;
     }): Promise<void>;
     pause(options: {
         assetId: string;
@@ -63,6 +64,7 @@ export interface NativeAudio {
 export interface ConfigureOptions {
     fade?: boolean;
     focus?: boolean;
+    background?: boolean;
 }
 export interface PreloadOptions {
     assetPath: string;

package/ios/Plugin/AudioAsset.swift

@@ -68,14 +68,14 @@ public class AudioAsset: NSObject, AVAudioPlayerDelegate {
         return player.duration
     }
 
-    func play(time: TimeInterval) {
+    func play(time: TimeInterval, delay: TimeInterval) {
         let player: AVAudioPlayer
 
         if channels.count > 0 {
             player = channels[playIndex]
             player.currentTime = time
             player.numberOfLoops = 0
-            player.play()
+            player.play(atTime: player.deviceCurrentTime + delay)
             playIndex += 1
             playIndex = playIndex % channels.count
         }

package/ios/Plugin/Constant.swift

@@ -14,6 +14,8 @@ public class Constant {
     public static let Volume = "volume"
     public static let Rate = "rate"
     public static let Loop = "loop"
+    public static let Background = "background"
+    public static let IgnoreSilent = "ignoreSilent"
 
     public static let ErrorAssetId = "Asset Id is missing"
     public static let ErrorAssetPath = "Asset Path is missing"

package/ios/Plugin/Plugin.swift

@@ -1,16 +1,14 @@
 import AVFoundation
-import Foundation
 import Capacitor
 import CoreAudio
+import Foundation
 
 enum MyError: Error {
     case runtimeError(String)
 }
 
-/**
- * Please read the Capacitor iOS Plugin Development Guide
- * here: https://capacitor.ionicframework.com/docs/plugins/ios
- */
+/// Please read the Capacitor iOS Plugin Development Guide
+/// here: https://capacitor.ionicframework.com/docs/plugins/ios
 @objc(NativeAudio)
 public class NativeAudio: CAPPlugin {
 
@@ -24,7 +22,7 @@ public class NativeAudio: CAPPlugin {
         self.fadeMusic = false
 
         do {
-            try self.session.setCategory(AVAudioSession.Category.playback)
+            try self.session.setCategory(AVAudioSession.Category.playback, options: .mixWithOthers)
             try self.session.setActive(false)
         } catch {
             print("Failed to set session category")
@@ -35,15 +33,68 @@ public class NativeAudio: CAPPlugin {
         if let fade = call.getBool(Constant.FadeKey) {
             self.fadeMusic = fade
         }
-        if let focus = call.getBool(Constant.FocusAudio) {
-            do {
-                if focus {
-                    try self.session.setCategory(AVAudioSession.Category.playback)
-                } else {
-                    try self.session.setCategory(AVAudioSession.Category.ambient)
+
+        let focus = call.getBool(Constant.FocusAudio) ?? false
+
+        do {
+
+            if focus {
+
+                try self.session.setCategory(AVAudioSession.Category.playback)
+
+            }
+
+        } catch {
+
+            print("Failed to set setCategory audio")
+
+        }
+
+        let background = call.getBool(Constant.Background) ?? false
+
+        do {
+
+            if background {
+
+                try self.session.setActive(true)
+
+            }
+
+        } catch {
+
+            print("Failed to set setSession true")
+
+        }
+
+        let ignoreSilent = call.getBool(Constant.IgnoreSilent) ?? true
+
+        do {
+
+            if ignoreSilent == false {
+
+                if let focus = call.getBool(Constant.FocusAudio) {
+
+                    do {
+
+                        if focus {
+
+                            try self.session.setCategory(AVAudioSession.Category.ambient)
+
+                        } else {
+
+                            try self.session.setCategory(
+                                AVAudioSession.Category.ambient, options: .mixWithOthers)
+
+                        }
+
+                    } catch {
+
+                        print("Failed to set setCategory audio")
+
+                    }
+
                 }
-            } catch {
-                print("Failed to set setCategory audio")
+
             }
         }
         call.resolve()
@@ -56,6 +107,7 @@ public class NativeAudio: CAPPlugin {
     @objc func play(_ call: CAPPluginCall) {
         let audioId = call.getString(Constant.AssetIdKey) ?? ""
         let time = call.getDouble("time") ?? 0
+        let delay = call.getDouble("delay") ?? 0
         if audioId != "" {
             let queue = DispatchQueue(label: "ee.forgr.audio.complex.queue", qos: .userInitiated)
 
@@ -70,12 +122,12 @@ public class NativeAudio: CAPPlugin {
                             if self.fadeMusic {
                                 audioAsset?.playWithFade(time: time)
                             } else {
-                                audioAsset?.play(time: time)
+                                audioAsset?.play(time: time, delay: delay)
                             }
                             call.resolve()
                         } else if asset is Int32 {
                             let audioAsset = asset as? NSNumber ?? 0
-                            AudioServicesPlaySystemSound(SystemSoundID(audioAsset.intValue ))
+                            AudioServicesPlaySystemSound(SystemSoundID(audioAsset.intValue))
                             call.resolve()
                         } else {
                             call.reject(Constant.ErrorAssetNotFound)
@@ -164,7 +216,7 @@ public class NativeAudio: CAPPlugin {
         if self.audioList.count > 0 {
             let asset = self.audioList[audioId]
             if asset != nil && asset is AudioAsset {
-                guard let audioAsset=asset as? AudioAsset else {
+                guard let audioAsset = asset as? AudioAsset else {
                     call.reject("Cannot cast to AudioAsset")
                     return
                 }
@@ -256,8 +308,10 @@ public class NativeAudio: CAPPlugin {
                             self.audioList[audioId] = NSNumber(value: Int32(soundId))
                             call.resolve()
                         } else {
-                            let audioAsset: AudioAsset = AudioAsset(owner: self,
-                                                                    withAssetId: audioId, withPath: basePath, withChannels: channels, withVolume: volume, withFadeDelay: delay)
+                            let audioAsset: AudioAsset = AudioAsset(
+                                owner: self,
+                                withAssetId: audioId, withPath: basePath, withChannels: channels,
+                                withVolume: volume, withFadeDelay: delay)
                             self.audioList[audioId] = audioAsset
                             call.resolve()
                         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/native-audio",
-  "version": "6.0.20",
+  "version": "6.1.0",
   "description": "A native plugin for native audio engine",
   "main": "dist/plugin.js",
   "module": "dist/esm/index.js",