@capgo/native-audio 5.0.7 → 5.0.12

package/README.md

@@ -25,7 +25,7 @@
 # Capacitor Native Audio Plugin
 
 Capacitor plugin for native audio engine.
-Capacitor v3/v4 - ✅ Support!
+Capacitor v4 - ✅ Support!
 
 Click on video to see example 💥
 
@@ -41,8 +41,12 @@ Click on video to see example 💥
 Mainteinance Status: Actively Maintained
 
 ## Preparation
+
 All audio files must be with the rest of your source files.
 
+First make your sound file end up in your builded code folder, example in folder `BUILDFOLDER/assets/sounds/FILENAME.mp3`
+Then use it in preload like that `assets/sounds/FILENAME.mp3`
+
 ## Installation
 
 To use npm
@@ -110,7 +114,7 @@ import {NativeAudio} from '@capgo/native-audio'
  */
 NativeAudio.preload({
     assetId: "fire",
-    assetPath: "fire.mp3",
+    assetPath: "assets/sounds/fire.mp3",
     audioChannelNum: 1,
     isUrl: false
 });
@@ -210,131 +214,149 @@ NativeAudio.isPlaying({
 ### configure(...)
 
 ```typescript
-configure(options: ConfigureOptions) => Promise<void>
+configure(options: ConfigureOptions) => any
 ```
 
 | Param         | Type                                                          |
 | ------------- | ------------------------------------------------------------- |
 | **`options`** | <code><a href="#configureoptions">ConfigureOptions</a></code> |
 
+**Returns:** <code>any</code>
+
 --------------------
 
 
 ### preload(...)
 
 ```typescript
-preload(options: PreloadOptions) => Promise<void>
+preload(options: PreloadOptions) => any
 ```
 
 | Param         | Type                                                      |
 | ------------- | --------------------------------------------------------- |
 | **`options`** | <code><a href="#preloadoptions">PreloadOptions</a></code> |
 
+**Returns:** <code>any</code>
+
 --------------------
 
 
 ### play(...)
 
 ```typescript
-play(options: { assetId: string; time?: number; }) => Promise<void>
+play(options: { assetId: string; time?: number; }) => any
 ```
 
 | Param         | Type                                             |
 | ------------- | ------------------------------------------------ |
 | **`options`** | <code>{ assetId: string; time?: number; }</code> |
 
+**Returns:** <code>any</code>
+
 --------------------
 
 
 ### pause(...)
 
 ```typescript
-pause(options: { assetId: string; }) => Promise<void>
+pause(options: { assetId: string; }) => any
 ```
 
 | Param         | Type                              |
 | ------------- | --------------------------------- |
 | **`options`** | <code>{ assetId: string; }</code> |
 
+**Returns:** <code>any</code>
+
 --------------------
 
 
 ### resume(...)
 
 ```typescript
-resume(options: { assetId: string; }) => Promise<void>
+resume(options: { assetId: string; }) => any
 ```
 
 | Param         | Type                              |
 | ------------- | --------------------------------- |
 | **`options`** | <code>{ assetId: string; }</code> |
 
+**Returns:** <code>any</code>
+
 --------------------
 
 
 ### loop(...)
 
 ```typescript
-loop(options: { assetId: string; }) => Promise<void>
+loop(options: { assetId: string; }) => any
 ```
 
 | Param         | Type                              |
 | ------------- | --------------------------------- |
 | **`options`** | <code>{ assetId: string; }</code> |
 
+**Returns:** <code>any</code>
+
 --------------------
 
 
 ### stop(...)
 
 ```typescript
-stop(options: { assetId: string; }) => Promise<void>
+stop(options: { assetId: string; }) => any
 ```
 
 | Param         | Type                              |
 | ------------- | --------------------------------- |
 | **`options`** | <code>{ assetId: string; }</code> |
 
+**Returns:** <code>any</code>
+
 --------------------
 
 
 ### unload(...)
 
 ```typescript
-unload(options: { assetId: string; }) => Promise<void>
+unload(options: { assetId: string; }) => any
 ```
 
 | Param         | Type                              |
 | ------------- | --------------------------------- |
 | **`options`** | <code>{ assetId: string; }</code> |
 
+**Returns:** <code>any</code>
+
 --------------------
 
 
 ### setVolume(...)
 
 ```typescript
-setVolume(options: { assetId: string; volume: number; }) => Promise<void>
+setVolume(options: { assetId: string; volume: number; }) => any
 ```
 
 | Param         | Type                                              |
 | ------------- | ------------------------------------------------- |
 | **`options`** | <code>{ assetId: string; volume: number; }</code> |
 
+**Returns:** <code>any</code>
+
 --------------------
 
 
 ### getCurrentTime(...)
 
 ```typescript
-getCurrentTime(options: { assetId: string; }) => Promise<{ currentTime: number; }>
+getCurrentTime(options: { assetId: string; }) => any
 ```
 
 | Param         | Type                              |
 | ------------- | --------------------------------- |
 | **`options`** | <code>{ assetId: string; }</code> |
 
-**Returns:** <code>Promise&lt;{ currentTime: number; }&gt;</code>
+**Returns:** <code>any</code>
 
 --------------------
 
@@ -342,14 +364,14 @@ getCurrentTime(options: { assetId: string; }) => Promise<{ currentTime: number;
 ### getDuration(...)
 
 ```typescript
-getDuration(options: { assetId: string; }) => Promise<{ duration: number; }>
+getDuration(options: { assetId: string; }) => any
 ```
 
 | Param         | Type                              |
 | ------------- | --------------------------------- |
 | **`options`** | <code>{ assetId: string; }</code> |
 
-**Returns:** <code>Promise&lt;{ duration: number; }&gt;</code>
+**Returns:** <code>any</code>
 
 --------------------
 
@@ -357,14 +379,14 @@ getDuration(options: { assetId: string; }) => Promise<{ duration: number; }>
 ### isPlaying(...)
 
 ```typescript
-isPlaying(options: { assetId: string; }) => Promise<{ isPlaying: boolean; }>
+isPlaying(options: { assetId: string; }) => any
 ```
 
 | Param         | Type                              |
 | ------------- | --------------------------------- |
 | **`options`** | <code>{ assetId: string; }</code> |
 
-**Returns:** <code>Promise&lt;{ isPlaying: boolean; }&gt;</code>
+**Returns:** <code>any</code>
 
 --------------------
 

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

@@ -407,6 +407,10 @@ public class NativeAudio extends Plugin implements AudioManager.OnAudioFocusChan
                     ParcelFileDescriptor p = ParcelFileDescriptor.open(f, ParcelFileDescriptor.MODE_READ_ONLY);
                     assetFileDescriptor = new AssetFileDescriptor(p, 0, -1);
                 } else {
+                    // if fullPath dont start with public/ add it
+                    if (!fullPath.startsWith("public/")) {
+                        fullPath = "public/".concat(fullPath);
+                    }
                     Context ctx = getBridge().getActivity().getApplicationContext();
                     AssetManager am = ctx.getResources().getAssets();
                     assetFileDescriptor = am.openFd(fullPath);

package/dist/docs.json

@@ -7,7 +7,7 @@
     "methods": [
       {
         "name": "configure",
-        "signature": "(options: ConfigureOptions) => Promise<void>",
+        "signature": "(options: ConfigureOptions) => any",
         "parameters": [
           {
             "name": "options",
@@ -15,7 +15,7 @@
             "type": "ConfigureOptions"
           }
         ],
-        "returns": "Promise<void>",
+        "returns": "any",
         "tags": [],
         "docs": "",
         "complexTypes": [
@@ -25,7 +25,7 @@
       },
       {
         "name": "preload",
-        "signature": "(options: PreloadOptions) => Promise<void>",
+        "signature": "(options: PreloadOptions) => any",
         "parameters": [
           {
             "name": "options",
@@ -33,7 +33,7 @@
             "type": "PreloadOptions"
           }
         ],
-        "returns": "Promise<void>",
+        "returns": "any",
         "tags": [],
         "docs": "",
         "complexTypes": [
@@ -43,7 +43,7 @@
       },
       {
         "name": "play",
-        "signature": "(options: { assetId: string; time?: number; }) => Promise<void>",
+        "signature": "(options: { assetId: string; time?: number; }) => any",
         "parameters": [
           {
             "name": "options",
@@ -51,7 +51,7 @@
             "type": "{ assetId: string; time?: number | undefined; }"
           }
         ],
-        "returns": "Promise<void>",
+        "returns": "any",
         "tags": [],
         "docs": "",
         "complexTypes": [],
@@ -59,7 +59,7 @@
       },
       {
         "name": "pause",
-        "signature": "(options: { assetId: string; }) => Promise<void>",
+        "signature": "(options: { assetId: string; }) => any",
         "parameters": [
           {
             "name": "options",
@@ -67,7 +67,7 @@
             "type": "{ assetId: string; }"
           }
         ],
-        "returns": "Promise<void>",
+        "returns": "any",
         "tags": [],
         "docs": "",
         "complexTypes": [],
@@ -75,7 +75,7 @@
       },
       {
         "name": "resume",
-        "signature": "(options: { assetId: string; }) => Promise<void>",
+        "signature": "(options: { assetId: string; }) => any",
         "parameters": [
           {
             "name": "options",
@@ -83,7 +83,7 @@
             "type": "{ assetId: string; }"
           }
         ],
-        "returns": "Promise<void>",
+        "returns": "any",
         "tags": [],
         "docs": "",
         "complexTypes": [],
@@ -91,7 +91,7 @@
       },
       {
         "name": "loop",
-        "signature": "(options: { assetId: string; }) => Promise<void>",
+        "signature": "(options: { assetId: string; }) => any",
         "parameters": [
           {
             "name": "options",
@@ -99,7 +99,7 @@
             "type": "{ assetId: string; }"
           }
         ],
-        "returns": "Promise<void>",
+        "returns": "any",
         "tags": [],
         "docs": "",
         "complexTypes": [],
@@ -107,7 +107,7 @@
       },
       {
         "name": "stop",
-        "signature": "(options: { assetId: string; }) => Promise<void>",
+        "signature": "(options: { assetId: string; }) => any",
         "parameters": [
           {
             "name": "options",
@@ -115,7 +115,7 @@
             "type": "{ assetId: string; }"
           }
         ],
-        "returns": "Promise<void>",
+        "returns": "any",
         "tags": [],
         "docs": "",
         "complexTypes": [],
@@ -123,7 +123,7 @@
       },
       {
         "name": "unload",
-        "signature": "(options: { assetId: string; }) => Promise<void>",
+        "signature": "(options: { assetId: string; }) => any",
         "parameters": [
           {
             "name": "options",
@@ -131,7 +131,7 @@
             "type": "{ assetId: string; }"
           }
         ],
-        "returns": "Promise<void>",
+        "returns": "any",
         "tags": [],
         "docs": "",
         "complexTypes": [],
@@ -139,7 +139,7 @@
       },
       {
         "name": "setVolume",
-        "signature": "(options: { assetId: string; volume: number; }) => Promise<void>",
+        "signature": "(options: { assetId: string; volume: number; }) => any",
         "parameters": [
           {
             "name": "options",
@@ -147,7 +147,7 @@
             "type": "{ assetId: string; volume: number; }"
           }
         ],
-        "returns": "Promise<void>",
+        "returns": "any",
         "tags": [],
         "docs": "",
         "complexTypes": [],
@@ -155,7 +155,7 @@
       },
       {
         "name": "getCurrentTime",
-        "signature": "(options: { assetId: string; }) => Promise<{ currentTime: number; }>",
+        "signature": "(options: { assetId: string; }) => any",
         "parameters": [
           {
             "name": "options",
@@ -163,7 +163,7 @@
             "type": "{ assetId: string; }"
           }
         ],
-        "returns": "Promise<{ currentTime: number; }>",
+        "returns": "any",
         "tags": [],
         "docs": "",
         "complexTypes": [],
@@ -171,7 +171,7 @@
       },
       {
         "name": "getDuration",
-        "signature": "(options: { assetId: string; }) => Promise<{ duration: number; }>",
+        "signature": "(options: { assetId: string; }) => any",
         "parameters": [
           {
             "name": "options",
@@ -179,7 +179,7 @@
             "type": "{ assetId: string; }"
           }
         ],
-        "returns": "Promise<{ duration: number; }>",
+        "returns": "any",
         "tags": [],
         "docs": "",
         "complexTypes": [],
@@ -187,7 +187,7 @@
       },
       {
         "name": "isPlaying",
-        "signature": "(options: { assetId: string; }) => Promise<{ isPlaying: boolean; }>",
+        "signature": "(options: { assetId: string; }) => any",
         "parameters": [
           {
             "name": "options",
@@ -195,7 +195,7 @@
             "type": "{ assetId: string; }"
           }
         ],
-        "returns": "Promise<{ isPlaying: boolean; }>",
+        "returns": "any",
         "tags": [],
         "docs": "",
         "complexTypes": [],

package/dist/plugin.cjs.js

@@ -124,8 +124,8 @@ const NativeAudio = new NativeAudioWeb();
 
 var web = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    NativeAudioWeb: NativeAudioWeb,
-    NativeAudio: NativeAudio
+    NativeAudio: NativeAudio,
+    NativeAudioWeb: NativeAudioWeb
 });
 
 exports.NativeAudio = NativeAudio$1;

package/dist/plugin.js

@@ -123,8 +123,8 @@ var capacitorApp = (function (exports, core) {
 
     var web = /*#__PURE__*/Object.freeze({
         __proto__: null,
-        NativeAudioWeb: NativeAudioWeb,
-        NativeAudio: NativeAudio
+        NativeAudio: NativeAudio,
+        NativeAudioWeb: NativeAudioWeb
     });
 
     exports.NativeAudio = NativeAudio$1;

package/ios/Plugin/Plugin.swift

@@ -200,7 +200,7 @@ public class NativeAudio: CAPPlugin {
         let isUrl: Bool?
 
         if audioId != "" {
-            let assetPath: String = call.getString(Constant.AssetPathKey) ?? ""
+            var assetPath: String = call.getString(Constant.AssetPathKey) ?? ""
 
             if complex {
                 volume = call.getFloat("volume") ?? 1.0
@@ -225,6 +225,9 @@ public class NativeAudio: CAPPlugin {
                 if asset == nil {
                     var basePath: String?
                     if isUrl == false {
+                        // if assetPath dont start with public/ add it
+                        assetPath = assetPath.starts(with: "public/") ? assetPath : "public/" + assetPath 
+
                         let assetPathSplit = assetPath.components(separatedBy: ".")
                         basePath = Bundle.main.path(forResource: assetPathSplit[0], ofType: assetPathSplit[1])
                     } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/native-audio",
-  "version": "5.0.7",
+  "version": "5.0.12",
   "description": "A native plugin for native audio engine",
   "main": "dist/plugin.js",
   "module": "dist/esm/index.js",
@@ -40,25 +40,25 @@
   "author": "Martin Donadieu <martindonadieu@gmail.com>",
   "license": "MIT",
   "devDependencies": {
-    "@capacitor/android": "^4.4.0",
-    "@capacitor/cli": "^4.4.0",
-    "@capacitor/core": "^4.4.0",
-    "@capacitor/docgen": "^0.2.0",
-    "@capacitor/ios": "^4.4.0",
+    "@capacitor/android": "^4.7.0",
+    "@capacitor/cli": "^4.7.0",
+    "@capacitor/core": "^4.7.0",
+    "@capacitor/docgen": "^0.2.1",
+    "@capacitor/ios": "^4.7.0",
     "@ionic/eslint-config": "^0.3.0",
     "@ionic/prettier-config": "^2.0.0",
     "@ionic/swiftlint-config": "^1.1.2",
-    "@typescript-eslint/eslint-plugin": "^5.42.1",
-    "@typescript-eslint/parser": "^5.42.1",
-    "eslint": "^8.27.0",
-    "eslint-plugin-import": "^2.26.0",
-    "husky": "^8.0.2",
+    "@typescript-eslint/eslint-plugin": "^5.54.1",
+    "@typescript-eslint/parser": "^5.54.1",
+    "eslint": "^8.35.0",
+    "eslint-plugin-import": "^2.27.5",
+    "husky": "^8.0.3",
     "prettier": "^2.7.1",
     "prettier-plugin-java": "^2.0.0",
-    "rimraf": "^3.0.2",
-    "rollup": "^3.2.5",
+    "rimraf": "^4.3.1",
+    "rollup": "^3.18.0",
     "swiftlint": "^1.0.1",
-    "typescript": "^4.8.4"
+    "typescript": "^4.9.5"
   },
   "peerDependencies": {
     "@capacitor/core": "^4.0.0"