@capgo/native-audio 6.3.4 → 6.4.2

package/README.md

@@ -6,9 +6,8 @@
 </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/?ref=awesome-list"> ➡️ Get Instant updates for your App with Capgo 🚀</a></h2>
+  <h2><a href="https://capgo.app/consulting/"> Fix your annoying bug now, Hire a Capacitor expert 💪</a></h2>
 </div>
 
 <h3 align="center">Native Audio</h3>
@@ -114,7 +113,7 @@ import {NativeAudio} from '@capgo/native-audio'
 
 /**
  * This method will load more optimized audio files for background into memory.
- * @param assetPath - relative path of the file or absolute url (file://) or remote URL (https://)
+ * @param assetPath - relative path of the file, absolute url (file://) or remote url (https://)
  *        assetId - unique identifier of the file
  *        audioChannelNum - number of audio channels
  *        isUrl - pass true if assetPath is a `file://` url
@@ -169,7 +168,7 @@ NativeAudio.unload({
 /**
  * This method will set the new volume for a audio file.
  * @param assetId - identifier of the asset
- *        volume - numerical value of the volume between 0.1 - 1.0
+ *        volume - numerical value of the volume between 0.1 - 1.0 default 1.0
  * @returns void
  */
 NativeAudio.setVolume({
@@ -225,10 +224,14 @@ NativeAudio.isPlaying({
 configure(options: ConfigureOptions) => Promise<void>
 ```
 
+Configure the audio player
+
 | Param         | Type                                                          |
 | ------------- | ------------------------------------------------------------- |
 | **`options`** | <code><a href="#configureoptions">ConfigureOptions</a></code> |
 
+**Since:** 5.0.0
+
 --------------------
 
 
@@ -238,10 +241,33 @@ configure(options: ConfigureOptions) => Promise<void>
 preload(options: PreloadOptions) => Promise<void>
 ```
 
+Load an audio file
+
+| Param         | Type                                                      |
+| ------------- | --------------------------------------------------------- |
+| **`options`** | <code><a href="#preloadoptions">PreloadOptions</a></code> |
+
+**Since:** 5.0.0
+
+--------------------
+
+
+### isPreloaded(...)
+
+```typescript
+isPreloaded(options: PreloadOptions) => Promise<boolean>
+```
+
+Check if an audio file is preloaded
+
 | Param         | Type                                                      |
 | ------------- | --------------------------------------------------------- |
 | **`options`** | <code><a href="#preloadoptions">PreloadOptions</a></code> |
 
+**Returns:** <code>Promise&lt;boolean&gt;</code>
+
+**Since:** 6.1.0
+
 --------------------
 
 
@@ -251,22 +277,30 @@ preload(options: PreloadOptions) => Promise<void>
 play(options: { assetId: string; time?: number; delay?: number; }) => Promise<void>
 ```
 
+Play an audio file
+
 | Param         | Type                                                             |
 | ------------- | ---------------------------------------------------------------- |
 | **`options`** | <code>{ assetId: string; time?: number; delay?: number; }</code> |
 
+**Since:** 5.0.0
+
 --------------------
 
 
 ### pause(...)
 
 ```typescript
-pause(options: { assetId: string; }) => Promise<void>
+pause(options: Assets) => Promise<void>
 ```
 
-| Param         | Type                              |
-| ------------- | --------------------------------- |
-| **`options`** | <code>{ assetId: string; }</code> |
+Pause an audio file
+
+| Param         | Type                                      |
+| ------------- | ----------------------------------------- |
+| **`options`** | <code><a href="#assets">Assets</a></code> |
+
+**Since:** 5.0.0
 
 --------------------
 
@@ -274,12 +308,16 @@ pause(options: { assetId: string; }) => Promise<void>
 ### resume(...)
 
 ```typescript
-resume(options: { assetId: string; }) => Promise<void>
+resume(options: Assets) => Promise<void>
 ```
 
-| Param         | Type                              |
-| ------------- | --------------------------------- |
-| **`options`** | <code>{ assetId: string; }</code> |
+Resume an audio file
+
+| Param         | Type                                      |
+| ------------- | ----------------------------------------- |
+| **`options`** | <code><a href="#assets">Assets</a></code> |
+
+**Since:** 5.0.0
 
 --------------------
 
@@ -287,12 +325,16 @@ resume(options: { assetId: string; }) => Promise<void>
 ### loop(...)
 
 ```typescript
-loop(options: { assetId: string; }) => Promise<void>
+loop(options: Assets) => Promise<void>
 ```
 
-| Param         | Type                              |
-| ------------- | --------------------------------- |
-| **`options`** | <code>{ assetId: string; }</code> |
+Stop an audio file
+
+| Param         | Type                                      |
+| ------------- | ----------------------------------------- |
+| **`options`** | <code><a href="#assets">Assets</a></code> |
+
+**Since:** 5.0.0
 
 --------------------
 
@@ -300,12 +342,16 @@ loop(options: { assetId: string; }) => Promise<void>
 ### stop(...)
 
 ```typescript
-stop(options: { assetId: string; }) => Promise<void>
+stop(options: Assets) => Promise<void>
 ```
 
-| Param         | Type                              |
-| ------------- | --------------------------------- |
-| **`options`** | <code>{ assetId: string; }</code> |
+Stop an audio file
+
+| Param         | Type                                      |
+| ------------- | ----------------------------------------- |
+| **`options`** | <code><a href="#assets">Assets</a></code> |
+
+**Since:** 5.0.0
 
 --------------------
 
@@ -313,12 +359,16 @@ stop(options: { assetId: string; }) => Promise<void>
 ### unload(...)
 
 ```typescript
-unload(options: { assetId: string; }) => Promise<void>
+unload(options: Assets) => Promise<void>
 ```
 
-| Param         | Type                              |
-| ------------- | --------------------------------- |
-| **`options`** | <code>{ assetId: string; }</code> |
+Unload an audio file
+
+| Param         | Type                                      |
+| ------------- | ----------------------------------------- |
+| **`options`** | <code><a href="#assets">Assets</a></code> |
+
+**Since:** 5.0.0
 
 --------------------
 
@@ -329,10 +379,14 @@ unload(options: { assetId: string; }) => Promise<void>
 setVolume(options: { assetId: string; volume: number; }) => Promise<void>
 ```
 
+Set the volume of an audio file
+
 | Param         | Type                                              |
 | ------------- | ------------------------------------------------- |
 | **`options`** | <code>{ assetId: string; volume: number; }</code> |
 
+**Since:** 5.0.0
+
 --------------------
 
 
@@ -342,10 +396,14 @@ setVolume(options: { assetId: string; volume: number; }) => Promise<void>
 setRate(options: { assetId: string; rate: number; }) => Promise<void>
 ```
 
+Set the rate of an audio file
+
 | Param         | Type                                            |
 | ------------- | ----------------------------------------------- |
 | **`options`** | <code>{ assetId: string; rate: number; }</code> |
 
+**Since:** 5.0.0
+
 --------------------
 
 
@@ -355,42 +413,54 @@ setRate(options: { assetId: string; rate: number; }) => Promise<void>
 getCurrentTime(options: { assetId: string; }) => Promise<{ currentTime: number; }>
 ```
 
+Set the current time of an audio file
+
 | Param         | Type                              |
 | ------------- | --------------------------------- |
 | **`options`** | <code>{ assetId: string; }</code> |
 
 **Returns:** <code>Promise&lt;{ currentTime: number; }&gt;</code>
 
+**Since:** 5.0.0
+
 --------------------
 
 
 ### getDuration(...)
 
 ```typescript
-getDuration(options: { assetId: string; }) => Promise<{ duration: number; }>
+getDuration(options: Assets) => Promise<{ duration: number; }>
 ```
 
-| Param         | Type                              |
-| ------------- | --------------------------------- |
-| **`options`** | <code>{ assetId: string; }</code> |
+Get the duration of an audio file
+
+| Param         | Type                                      |
+| ------------- | ----------------------------------------- |
+| **`options`** | <code><a href="#assets">Assets</a></code> |
 
 **Returns:** <code>Promise&lt;{ duration: number; }&gt;</code>
 
+**Since:** 5.0.0
+
 --------------------
 
 
 ### isPlaying(...)
 
 ```typescript
-isPlaying(options: { assetId: string; }) => Promise<{ isPlaying: boolean; }>
+isPlaying(options: Assets) => Promise<{ isPlaying: boolean; }>
 ```
 
-| Param         | Type                              |
-| ------------- | --------------------------------- |
-| **`options`** | <code>{ assetId: string; }</code> |
+Check if an audio file is playing
+
+| Param         | Type                                      |
+| ------------- | ----------------------------------------- |
+| **`options`** | <code><a href="#assets">Assets</a></code> |
 
 **Returns:** <code>Promise&lt;{ isPlaying: boolean; }&gt;</code>
 
+**Since:** 5.0.0
+
 --------------------
 
 
@@ -410,6 +480,7 @@ Listen for complete event
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
 
 **Since:** 5.0.0
+return {@link CompletedEvent}
 
 --------------------
 
@@ -419,22 +490,29 @@ Listen for complete event
 
 #### ConfigureOptions
 
-| Prop             | Type                 |
-| ---------------- | -------------------- |
-| **`fade`**       | <code>boolean</code> |
-| **`focus`**      | <code>boolean</code> |
-| **`background`** | <code>boolean</code> |
+| Prop             | Type                 | Description                                             |
+| ---------------- | -------------------- | ------------------------------------------------------- |
+| **`fade`**       | <code>boolean</code> | Play the audio with Fade effect, only available for IOS |
+| **`focus`**      | <code>boolean</code> | focus the audio with Audio Focus                        |
+| **`background`** | <code>boolean</code> | Play the audio in the background                        |
 
 
 #### PreloadOptions
 
-| Prop                  | Type                 |
-| --------------------- | -------------------- |
-| **`assetPath`**       | <code>string</code>  |
-| **`assetId`**         | <code>string</code>  |
-| **`volume`**          | <code>number</code>  |
-| **`audioChannelNum`** | <code>number</code>  |
-| **`isUrl`**           | <code>boolean</code> |
+| Prop                  | Type                 | Description                                                                                        |
+| --------------------- | -------------------- | -------------------------------------------------------------------------------------------------- |
+| **`assetPath`**       | <code>string</code>  | Path to the audio file, relative path of the file, absolute url (file://) or remote url (https://) |
+| **`assetId`**         | <code>string</code>  | Asset Id, unique identifier of the file                                                            |
+| **`volume`**          | <code>number</code>  | Volume of the audio, between 0.1 and 1.0                                                           |
+| **`audioChannelNum`** | <code>number</code>  | Audio channel number, default is 1                                                                 |
+| **`isUrl`**           | <code>boolean</code> | Is the audio file a URL, pass true if assetPath is a `file://` url                                 |
+
+
+#### Assets
+
+| Prop          | Type                | Description                             |
+| ------------- | ------------------- | --------------------------------------- |
+| **`assetId`** | <code>string</code> | Asset Id, unique identifier of the file |
 
 
 #### PluginListenerHandle

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

@@ -3,18 +3,16 @@ package ee.forgr.audio;
 import android.content.res.AssetFileDescriptor;
 import android.os.Build;
 import androidx.annotation.RequiresApi;
-import com.getcapacitor.JSObject;
 import java.util.ArrayList;
-import java.util.concurrent.Callable;
 
 public class AudioAsset {
 
   private final String TAG = "AudioAsset";
 
-  private ArrayList<AudioDispatcher> audioList;
+  private final ArrayList<AudioDispatcher> audioList;
   private int playIndex = 0;
-  private String assetId;
-  private NativeAudio owner;
+  private final String assetId;
+  private final NativeAudio owner;
 
   AudioAsset(
     NativeAudio owner,
@@ -91,7 +89,7 @@ public class AudioAsset {
   }
 
   public void resume() throws Exception {
-    if (audioList.size() > 0) {
+    if (!audioList.isEmpty()) {
       AudioDispatcher audio = audioList.get(0);
 
       if (audio != null) {

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

@@ -1,11 +1,18 @@
 package ee.forgr.audio;
 
+import static ee.forgr.audio.Constant.INVALID;
+import static ee.forgr.audio.Constant.LOOPING;
+import static ee.forgr.audio.Constant.PAUSE;
+import static ee.forgr.audio.Constant.PENDING_LOOP;
+import static ee.forgr.audio.Constant.PENDING_PLAY;
+import static ee.forgr.audio.Constant.PLAYING;
+import static ee.forgr.audio.Constant.PREPARED;
+
 import android.content.res.AssetFileDescriptor;
 import android.media.AudioAttributes;
 import android.media.MediaPlayer;
 import android.os.Build;
 import android.util.Log;
-import java.util.concurrent.Callable;
 
 public class AudioDispatcher
   implements
@@ -14,16 +21,7 @@ public class AudioDispatcher
     MediaPlayer.OnSeekCompleteListener {
 
   private final String TAG = "AudioDispatcher";
-
-  private final int INVALID = 0;
-  private final int PREPARED = 1;
-  private final int PENDING_PLAY = 2;
-  private final int PLAYING = 3;
-  private final int PENDING_LOOP = 4;
-  private final int LOOPING = 5;
-  private final int PAUSE = 6;
-
-  private MediaPlayer mediaPlayer;
+  private final MediaPlayer mediaPlayer;
   private int mediaState;
   private AudioAsset owner;
 
@@ -63,7 +61,7 @@ public class AudioDispatcher
   }
 
   public void play(Double time) throws Exception {
-    invokePlay(time, false);
+    invokePlay(time);
   }
 
   public boolean pause() throws Exception {
@@ -159,23 +157,23 @@ public class AudioDispatcher
     }
   }
 
-  private void invokePlay(Double time, Boolean loop) {
+  private void invokePlay(Double time) {
     try {
       boolean playing = mediaPlayer.isPlaying();
 
       if (playing) {
         mediaPlayer.pause();
-        mediaPlayer.setLooping(loop);
+        mediaPlayer.setLooping(false);
         mediaState = PENDING_PLAY;
         seek(time);
       } else {
         if (mediaState == PREPARED) {
-          mediaState = (loop ? PENDING_LOOP : PENDING_PLAY);
+          mediaState = (PENDING_PLAY);
           onPrepared(mediaPlayer);
           seek(time);
         } else {
-          mediaState = (loop ? PENDING_LOOP : PENDING_PLAY);
-          mediaPlayer.setLooping(loop);
+          mediaState = (PENDING_PLAY);
+          mediaPlayer.setLooping(false);
           seek(time);
         }
       }

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

@@ -17,4 +17,11 @@ public class Constant {
   public static final String RATE = "rate";
   public static final String AUDIO_CHANNEL_NUM = "audioChannelNum";
   public static final String LOOP = "loop";
+  public static final int INVALID = 0;
+  public static final int PREPARED = 1;
+  public static final int PENDING_PLAY = 2;
+  public static final int PLAYING = 3;
+  public static final int PENDING_LOOP = 4;
+  public static final int LOOPING = 5;
+  public static final int PAUSE = 6;
 }

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

@@ -9,13 +9,11 @@ import static ee.forgr.audio.Constant.ERROR_AUDIO_ASSET_MISSING;
 import static ee.forgr.audio.Constant.ERROR_AUDIO_EXISTS;
 import static ee.forgr.audio.Constant.ERROR_AUDIO_ID_MISSING;
 import static ee.forgr.audio.Constant.LOOP;
-import static ee.forgr.audio.Constant.OPT_FADE_MUSIC;
 import static ee.forgr.audio.Constant.OPT_FOCUS_AUDIO;
 import static ee.forgr.audio.Constant.RATE;
 import static ee.forgr.audio.Constant.VOLUME;
 
 import android.Manifest;
-import android.app.Application;
 import android.content.Context;
 import android.content.res.AssetFileDescriptor;
 import android.content.res.AssetManager;
@@ -50,7 +48,6 @@ public class NativeAudio
 
   private static HashMap<String, AudioAsset> audioAssetList;
   private static ArrayList<AudioAsset> resumeList;
-  private boolean fadeMusic = false;
   private AudioManager audioManager;
 
   @Override
@@ -125,24 +122,45 @@ public class NativeAudio
   public void configure(PluginCall call) {
     initSoundPool();
 
-    if (call.hasOption(OPT_FADE_MUSIC)) this.fadeMusic = call.getBoolean(
-      OPT_FADE_MUSIC
-    );
+    if (this.audioManager == null) {
+      call.resolve();
+      return;
+    }
 
-    if (call.hasOption(OPT_FOCUS_AUDIO) && this.audioManager != null) {
-      if (call.getBoolean(OPT_FOCUS_AUDIO)) {
-        this.audioManager.requestAudioFocus(
-            this,
-            AudioManager.STREAM_MUSIC,
-            AudioManager.AUDIOFOCUS_GAIN
-          );
-      } else {
-        this.audioManager.abandonAudioFocus(this);
-      }
+    if (Boolean.TRUE.equals(call.getBoolean(OPT_FOCUS_AUDIO, false))) {
+      this.audioManager.requestAudioFocus(
+          this,
+          AudioManager.STREAM_MUSIC,
+          AudioManager.AUDIOFOCUS_GAIN
+        );
+    } else {
+      this.audioManager.abandonAudioFocus(this);
     }
     call.resolve();
   }
 
+  @PluginMethod
+  public void isPreloaded(final PluginCall call) {
+    new Thread(
+      new Runnable() {
+        @Override
+        public void run() {
+          initSoundPool();
+
+          String audioId = call.getString(ASSET_ID);
+
+          if (!isStringValid(audioId)) {
+            call.reject(ERROR_AUDIO_ID_MISSING + " - " + audioId);
+            return;
+          }
+          call.resolve(
+            new JSObject().put("found", audioAssetList.containsKey(audioId))
+          );
+        }
+      }
+    ).start();
+  }
+
   @PluginMethod
   public void preload(final PluginCall call) {
     new Thread(
@@ -348,7 +366,7 @@ public class NativeAudio
       initSoundPool();
 
       String audioId = call.getString(ASSET_ID);
-      float volume = call.getFloat(VOLUME);
+      float volume = call.getFloat(VOLUME, 1F);
 
       if (audioAssetList.containsKey(audioId)) {
         AudioAsset asset = audioAssetList.get(audioId);
@@ -372,7 +390,7 @@ public class NativeAudio
       initSoundPool();
 
       String audioId = call.getString(ASSET_ID);
-      float rate = call.getFloat(RATE);
+      float rate = call.getFloat(RATE, 1F);
 
       if (audioAssetList.containsKey(audioId)) {
         AudioAsset asset = audioAssetList.get(audioId);
@@ -421,7 +439,7 @@ public class NativeAudio
   }
 
   private void preloadAsset(PluginCall call) {
-    double volume = 1.0;
+    float volume = 1F;
     int audioChannelNum = 1;
     JSObject status = new JSObject();
     status.put("STATUS", "OK");
@@ -450,17 +468,8 @@ public class NativeAudio
 
         String fullPath = assetPath; //"raw/".concat(assetPath);
 
-        if (call.getDouble(VOLUME) == null) {
-          volume = 1.0;
-        } else {
-          volume = call.getDouble(VOLUME, 0.5);
-        }
-
-        if (call.getInt(AUDIO_CHANNEL_NUM) == null) {
-          audioChannelNum = 1;
-        } else {
-          audioChannelNum = call.getInt(AUDIO_CHANNEL_NUM);
-        }
+        volume = call.getFloat(VOLUME, 1F);
+        audioChannelNum = call.getInt(AUDIO_CHANNEL_NUM, 1);
 
         AssetFileDescriptor assetFileDescriptor;
         if (isLocalUrl) {
@@ -484,7 +493,7 @@ public class NativeAudio
                 audioId,
                 uri,
                 audioChannelNum,
-                (float) volume
+                volume
               );
               audioAssetList.put(audioId, remoteAudioAsset);
               call.resolve(status);
@@ -511,7 +520,7 @@ public class NativeAudio
           audioId,
           assetFileDescriptor,
           audioChannelNum,
-          (float) volume
+          volume
         );
         audioAssetList.put(audioId, asset);