@capgo/native-audio 5.1.3 → 5.1.13

package/README.md

@@ -213,164 +213,144 @@ NativeAudio.isPlaying({
 ### configure(...)
 
 ```typescript
-configure(options: ConfigureOptions) => any
+configure(options: ConfigureOptions) => Promise<void>
 ```
 
 | Param         | Type                                                          |
 | ------------- | ------------------------------------------------------------- |
 | **`options`** | <code><a href="#configureoptions">ConfigureOptions</a></code> |
 
-**Returns:** <code>any</code>
-
 --------------------
 
 
 ### preload(...)
 
 ```typescript
-preload(options: PreloadOptions) => any
+preload(options: PreloadOptions) => Promise<void>
 ```
 
 | Param         | Type                                                      |
 | ------------- | --------------------------------------------------------- |
 | **`options`** | <code><a href="#preloadoptions">PreloadOptions</a></code> |
 
-**Returns:** <code>any</code>
-
 --------------------
 
 
 ### play(...)
 
 ```typescript
-play(options: { assetId: string; time?: number; }) => any
+play(options: { assetId: string; time?: number; }) => Promise<void>
 ```
 
 | Param         | Type                                             |
 | ------------- | ------------------------------------------------ |
 | **`options`** | <code>{ assetId: string; time?: number; }</code> |
 
-**Returns:** <code>any</code>
-
 --------------------
 
 
 ### pause(...)
 
 ```typescript
-pause(options: { assetId: string; }) => any
+pause(options: { assetId: string; }) => Promise<void>
 ```
 
 | Param         | Type                              |
 | ------------- | --------------------------------- |
 | **`options`** | <code>{ assetId: string; }</code> |
 
-**Returns:** <code>any</code>
-
 --------------------
 
 
 ### resume(...)
 
 ```typescript
-resume(options: { assetId: string; }) => any
+resume(options: { assetId: string; }) => Promise<void>
 ```
 
 | Param         | Type                              |
 | ------------- | --------------------------------- |
 | **`options`** | <code>{ assetId: string; }</code> |
 
-**Returns:** <code>any</code>
-
 --------------------
 
 
 ### loop(...)
 
 ```typescript
-loop(options: { assetId: string; }) => any
+loop(options: { assetId: string; }) => Promise<void>
 ```
 
 | Param         | Type                              |
 | ------------- | --------------------------------- |
 | **`options`** | <code>{ assetId: string; }</code> |
 
-**Returns:** <code>any</code>
-
 --------------------
 
 
 ### stop(...)
 
 ```typescript
-stop(options: { assetId: string; }) => any
+stop(options: { assetId: string; }) => Promise<void>
 ```
 
 | Param         | Type                              |
 | ------------- | --------------------------------- |
 | **`options`** | <code>{ assetId: string; }</code> |
 
-**Returns:** <code>any</code>
-
 --------------------
 
 
 ### unload(...)
 
 ```typescript
-unload(options: { assetId: string; }) => any
+unload(options: { assetId: string; }) => Promise<void>
 ```
 
 | Param         | Type                              |
 | ------------- | --------------------------------- |
 | **`options`** | <code>{ assetId: string; }</code> |
 
-**Returns:** <code>any</code>
-
 --------------------
 
 
 ### setVolume(...)
 
 ```typescript
-setVolume(options: { assetId: string; volume: number; }) => any
+setVolume(options: { assetId: string; volume: number; }) => Promise<void>
 ```
 
 | Param         | Type                                              |
 | ------------- | ------------------------------------------------- |
 | **`options`** | <code>{ assetId: string; volume: number; }</code> |
 
-**Returns:** <code>any</code>
-
 --------------------
 
 
 ### setRate(...)
 
 ```typescript
-setRate(options: { assetId: string; rate: number; }) => any
+setRate(options: { assetId: string; rate: number; }) => Promise<void>
 ```
 
 | Param         | Type                                            |
 | ------------- | ----------------------------------------------- |
 | **`options`** | <code>{ assetId: string; rate: number; }</code> |
 
-**Returns:** <code>any</code>
-
 --------------------
 
 
 ### getCurrentTime(...)
 
 ```typescript
-getCurrentTime(options: { assetId: string; }) => any
+getCurrentTime(options: { assetId: string; }) => Promise<{ currentTime: number; }>
 ```
 
 | Param         | Type                              |
 | ------------- | --------------------------------- |
 | **`options`** | <code>{ assetId: string; }</code> |
 
-**Returns:** <code>any</code>
+**Returns:** <code>Promise&lt;{ currentTime: number; }&gt;</code>
 
 --------------------
 
@@ -378,14 +358,14 @@ getCurrentTime(options: { assetId: string; }) => any
 ### getDuration(...)
 
 ```typescript
-getDuration(options: { assetId: string; }) => any
+getDuration(options: { assetId: string; }) => Promise<{ duration: number; }>
 ```
 
 | Param         | Type                              |
 | ------------- | --------------------------------- |
 | **`options`** | <code>{ assetId: string; }</code> |
 
-**Returns:** <code>any</code>
+**Returns:** <code>Promise&lt;{ duration: number; }&gt;</code>
 
 --------------------
 
@@ -393,14 +373,34 @@ getDuration(options: { assetId: string; }) => any
 ### isPlaying(...)
 
 ```typescript
-isPlaying(options: { assetId: string; }) => any
+isPlaying(options: { assetId: string; }) => Promise<{ isPlaying: boolean; }>
 ```
 
 | Param         | Type                              |
 | ------------- | --------------------------------- |
 | **`options`** | <code>{ assetId: string; }</code> |
 
-**Returns:** <code>any</code>
+**Returns:** <code>Promise&lt;{ isPlaying: boolean; }&gt;</code>
+
+--------------------
+
+
+### addListener('complete', ...)
+
+```typescript
+addListener(eventName: "complete", listenerFunc: CompletedListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+```
+
+Listen for complete event
+
+| Param              | Type                                                            |
+| ------------------ | --------------------------------------------------------------- |
+| **`eventName`**    | <code>'complete'</code>                                         |
+| **`listenerFunc`** | <code><a href="#completedlistener">CompletedListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+**Since:** 5.0.0
 
 --------------------
 
@@ -426,4 +426,26 @@ isPlaying(options: { assetId: string; }) => any
 | **`audioChannelNum`** | <code>number</code>  |
 | **`isUrl`**           | <code>boolean</code> |
 
+
+#### PluginListenerHandle
+
+| Prop         | Type                                      |
+| ------------ | ----------------------------------------- |
+| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
+
+
+#### CompletedEvent
+
+| Prop          | Type                | Description                | Since |
+| ------------- | ------------------- | -------------------------- | ----- |
+| **`assetId`** | <code>string</code> | Emit when a play completes | 5.0.0 |
+
+
+### Type Aliases
+
+
+#### CompletedListener
+
+<code>(state: <a href="#completedevent">CompletedEvent</a>): void</code>
+
 </docgen-api>

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

@@ -1,152 +1,172 @@
 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 final String TAG = "AudioAsset";
+
+  private ArrayList<AudioDispatcher> audioList;
+  private int playIndex = 0;
+  private String assetId;
+  private NativeAudio owner;
+
+  AudioAsset(
+    NativeAudio owner,
+    String assetId,
+    AssetFileDescriptor assetFileDescriptor,
+    int audioChannelNum,
+    float volume
+  ) throws Exception {
+    audioList = new ArrayList<>();
+    this.owner = owner;
+    this.assetId = assetId;
+
+    if (audioChannelNum < 0) {
+      audioChannelNum = 1;
+    }
 
-    private ArrayList<AudioDispatcher> audioList;
-    private int playIndex = 0;
-    private String assetId;
-    private NativeAudio owner;
+    for (int x = 0; x < audioChannelNum; x++) {
+      AudioDispatcher audioDispatcher = new AudioDispatcher(
+        assetFileDescriptor,
+        volume
+      );
+      audioList.add(audioDispatcher);
+      if (audioChannelNum == 1) audioDispatcher.setOwner(this);
+    }
+  }
 
-    AudioAsset(NativeAudio owner, String assetId, AssetFileDescriptor assetFileDescriptor, int audioChannelNum, float volume)
-        throws Exception {
-        audioList = new ArrayList<>();
-        this.owner = owner;
-        this.assetId = assetId;
+  public void dispatchComplete() {
+    this.owner.dispatchComplete(this.assetId);
+  }
 
-        if (audioChannelNum < 0) {
-            audioChannelNum = 1;
-        }
+  public void play(Double time) throws Exception {
+    AudioDispatcher audio = audioList.get(playIndex);
 
-        for (int x = 0; x < audioChannelNum; x++) {
-            AudioDispatcher audioDispatcher = new AudioDispatcher(assetFileDescriptor, volume);
-            audioList.add(audioDispatcher);
-            if (audioChannelNum == 1) audioDispatcher.setOwner(this);
-        }
+    if (audio != null) {
+      audio.play(time);
+      playIndex++;
+      playIndex = playIndex % audioList.size();
+    } else {
+      throw new Exception("AudioDispatcher is null");
     }
+  }
 
-    public void dispatchComplete() {
-        this.owner.dispatchComplete(this.assetId);
-    }
+  public double getDuration() {
+    if (audioList.size() != 1) return 0;
 
-    public void play(Double time, Callable<Void> callback) throws Exception {
-        AudioDispatcher audio = audioList.get(playIndex);
+    AudioDispatcher audio = audioList.get(playIndex);
 
-        if (audio != null) {
-            audio.play(time, callback);
-            playIndex++;
-            playIndex = playIndex % audioList.size();
-        } else {
-            throw new Exception("AudioDispatcher is null");
-        }
+    if (audio != null) {
+      return audio.getDuration();
     }
+    return 0;
+  }
 
-    public double getDuration() {
-        if (audioList.size() != 1) return 0;
+  public double getCurrentPosition() {
+    if (audioList.size() != 1) return 0;
 
-        AudioDispatcher audio = audioList.get(playIndex);
+    AudioDispatcher audio = audioList.get(playIndex);
 
-        if (audio != null) {
-            return audio.getDuration();
-        }
-        return 0;
+    if (audio != null) {
+      return audio.getCurrentPosition();
     }
+    return 0;
+  }
 
-    public double getCurrentPosition() {
-        if (audioList.size() != 1) return 0;
+  public boolean pause() throws Exception {
+    boolean wasPlaying = false;
 
-        AudioDispatcher audio = audioList.get(playIndex);
-
-        if (audio != null) {
-            return audio.getCurrentPosition();
-        }
-        return 0;
+    for (int x = 0; x < audioList.size(); x++) {
+      AudioDispatcher audio = audioList.get(x);
+      wasPlaying |= audio.pause();
     }
 
-    public boolean pause() throws Exception {
-        boolean wasPlaying = false;
+    return wasPlaying;
+  }
 
-        for (int x = 0; x < audioList.size(); x++) {
-            AudioDispatcher audio = audioList.get(x);
-            wasPlaying |= audio.pause();
-        }
+  public void resume() throws Exception {
+    if (audioList.size() > 0) {
+      AudioDispatcher audio = audioList.get(0);
 
-        return wasPlaying;
+      if (audio != null) {
+        audio.resume();
+      } else {
+        throw new Exception("AudioDispatcher is null");
+      }
     }
+  }
 
-    public void resume() throws Exception {
-        if (audioList.size() > 0) {
-            AudioDispatcher audio = audioList.get(0);
+  public void stop() throws Exception {
+    for (int x = 0; x < audioList.size(); x++) {
+      AudioDispatcher audio = audioList.get(x);
 
-            if (audio != null) {
-                audio.resume();
-            } else {
-                throw new Exception("AudioDispatcher is null");
-            }
-        }
+      if (audio != null) {
+        audio.stop();
+      } else {
+        throw new Exception("AudioDispatcher is null");
+      }
     }
+  }
 
-    public void stop() throws Exception {
-        for (int x = 0; x < audioList.size(); x++) {
-            AudioDispatcher audio = audioList.get(x);
+  public void loop() throws Exception {
+    AudioDispatcher audio = audioList.get(playIndex);
 
-            if (audio != null) {
-                audio.stop();
-            } else {
-                throw new Exception("AudioDispatcher is null");
-            }
-        }
+    if (audio != null) {
+      audio.loop();
+      playIndex++;
+      playIndex = playIndex % audioList.size();
+    } else {
+      throw new Exception("AudioDispatcher is null");
     }
+  }
 
-    public void loop() throws Exception {
-        AudioDispatcher audio = audioList.get(playIndex);
+  public void unload() throws Exception {
+    this.stop();
 
-        if (audio != null) {
-            audio.loop();
-            playIndex++;
-            playIndex = playIndex % audioList.size();
-        } else {
-            throw new Exception("AudioDispatcher is null");
-        }
-    }
+    for (int x = 0; x < audioList.size(); x++) {
+      AudioDispatcher audio = audioList.get(x);
 
-    public void unload() throws Exception {
-        this.stop();
+      if (audio != null) {
+        audio.unload();
+      } else {
+        throw new Exception("AudioDispatcher is null");
+      }
+    }
 
-        for (int x = 0; x < audioList.size(); x++) {
-            AudioDispatcher audio = audioList.get(x);
+    audioList.clear();
+  }
 
-            if (audio != null) {
-                audio.unload();
-            } else {
-                throw new Exception("AudioDispatcher is null");
-            }
-        }
+  public void setVolume(float volume) throws Exception {
+    for (int x = 0; x < audioList.size(); x++) {
+      AudioDispatcher audio = audioList.get(x);
 
-        audioList.clear();
+      if (audio != null) {
+        audio.setVolume(volume);
+      } else {
+        throw new Exception("AudioDispatcher is null");
+      }
     }
-
-    public void setVolume(float volume) throws Exception {
-        for (int x = 0; x < audioList.size(); x++) {
-            AudioDispatcher audio = audioList.get(x);
-
-            if (audio != null) {
-                audio.setVolume(volume);
-            } else {
-                throw new Exception("AudioDispatcher is null");
-            }
-        }
+  }
+
+  @RequiresApi(api = Build.VERSION_CODES.M)
+  public void setRate(float rate) throws Exception {
+    for (int x = 0; x < audioList.size(); x++) {
+      AudioDispatcher audio = audioList.get(x);
+      if (audio != null) {
+        audio.setRate(rate);
+      }
     }
+  }
 
-    public boolean isPlaying() throws Exception {
-        if (audioList.size() != 1) return false;
+  public boolean isPlaying() throws Exception {
+    if (audioList.size() != 1) return false;
 
-        return audioList.get(playIndex).isPlaying();
-    }
+    return audioList.get(playIndex).isPlaying();
+  }
 }