@capgo/native-audio 4.0.0

package/CapgoNativeAudio.podspec

@@ -0,0 +1,16 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapacitorCommunityNativeAudio'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  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.ios.deployment_target  = '12.0'
+  s.dependency 'Capacitor'
+end

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) COPYRIGHT_YEAR COPYRIGHT_HOLDER
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,394 @@
+<p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p>
+<h3 align="center">Native Audio</h3>
+<p align="center"><strong><code>@capacitor-community/native-audio</code></strong></p>
+<p align="center">
+  Capacitor community plugin for playing sounds.
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/maintenance/yes/2021?style=flat-square" />
+  <a href="https://github.com/capacitor-community/native-audio/actions?query=workflow%3A%22Test+and+Build+Plugin%22"><img src="https://img.shields.io/github/workflow/status/capacitor-community/native-audio/Test%20and%20Build%20Plugin?style=flat-square" /></a>
+  <a href="https://www.npmjs.com/package/@capacitor-community/native-audio"><img src="https://img.shields.io/npm/l/@capacitor-community/native-audio?style=flat-square" /></a>
+<br>
+  <a href="https://www.npmjs.com/package/@capacitor-community/native-audio"><img src="https://img.shields.io/npm/dw/@capacitor-community/native-audio?style=flat-square" /></a>
+  <a href="https://www.npmjs.com/package/@capacitor-community/native-audio"><img src="https://img.shields.io/npm/v/@capacitor-community/native-audio?style=flat-square" /></a>
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+<a href="#contributors-"><img src="https://img.shields.io/badge/all%20contributors-6-orange?style=flat-square" /></a>
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+</p>
+
+# Capacitor Native Audio Plugin
+
+Capacitor plugin for native audio engine.
+Capacitor v3 - ✅ Support!
+
+Click on video to see example 💥
+
+[![YouTube Example](https://img.youtube.com/vi/XpUGlWWtwHs/0.jpg)](https://www.youtube.com/watch?v=XpUGlWWtwHs)
+
+
+## Maintainers
+
+| Maintainer    | GitHub                                      | Social                              |
+| ------------- | ------------------------------------------- | ----------------------------------- |
+| Maxim Bazuev  | [bazuka5801](https://github.com/bazuka5801) | [Telegram](https://t.me/bazuka5801) |
+
+Mainteinance Status: Actively Maintained
+
+## Preparation
+All audio place in specific platform folder
+
+Andoid: `android/app/src/assets`
+
+iOS: `ios/App/App/sounds`
+
+Web: `assets/sounds`
+
+## Installation
+
+To use npm
+
+```bash
+npm install @capacitor-community/native-audio
+```
+
+To use yarn
+
+```bash
+yarn add @capacitor-community/native-audio
+```
+
+Sync native files
+
+```bash
+npx cap sync
+```
+
+On iOS, Android and Web, no further steps are needed.
+
+## Configuration
+
+No configuration required for this plugin.
+<docgen-config>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+
+
+</docgen-config>
+
+## Supported methods
+
+| Name           | Android | iOS | Web |
+| :------------- | :------ | :-- | :-- |
+| configure      | ✅      | ✅  | ❌  |
+| preload        | ✅      | ✅  | ✅  |
+| play           | ✅      | ✅  | ✅  |
+| pause          | ✅      | ✅  | ✅  |
+| resume         | ✅      | ✅  | ✅  |
+| loop           | ✅      | ✅  | ✅  |
+| stop           | ✅      | ✅  | ✅  |
+| unload         | ✅      | ✅  | ✅  |
+| setVolume      | ✅      | ✅  | ✅  |
+| getDuration    | ✅      | ✅  | ✅  |
+| getCurrentTime | ✅      | ✅  | ✅  |
+| isPlaying      | ✅      | ✅  | ✅  |
+
+## Usage
+
+[Example repository](https://github.com/bazuka5801/native-audio-example)
+
+```typescript
+import {NativeAudio} from '@capacitor-community/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://)
+ *        assetId - unique identifier of the file
+ *        audioChannelNum - number of audio channels
+ *        isUrl - pass true if assetPath is a `file://` url
+ * @returns void
+ */
+NativeAudio.preload({
+    assetId: "fire",
+    assetPath: "fire.mp3",
+    audioChannelNum: 1,
+    isUrl: false
+});
+
+/**
+ * This method will play the loaded audio file if present in the memory.
+ * @param assetId - identifier of the asset
+ * @param time - (optional) play with seek. example: 6.0 - start playing track from 6 sec
+ * @returns void
+ */
+NativeAudio.play({
+    assetId: 'fire',
+    // time: 6.0 - seek time
+});
+
+/**
+ * This method will loop the audio file for playback.
+ * @param assetId - identifier of the asset
+ * @returns void
+ */
+NativeAudio.loop({
+  assetId: 'fire',
+});
+
+
+/**
+ * This method will stop the audio file if it's currently playing.
+ * @param assetId - identifier of the asset
+ * @returns void
+ */
+NativeAudio.stop({
+  assetId: 'fire',
+});
+
+/**
+ * This method will unload the audio file from the memory.
+ * @param assetId - identifier of the asset
+ * @returns void
+ */
+NativeAudio.unload({
+  assetId: 'fire',
+});
+
+/**
+ * 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
+ * @returns void
+ */
+NativeAudio.setVolume({
+  assetId: 'fire',
+  volume: 0.4,
+});
+
+/**
+ * this method will get the duration of an audio file.
+ * only works if channels == 1
+ */
+NativeAudio.getDuration({
+  assetId: 'fire'
+})
+.then(result => {
+  console.log(result.duration);
+})
+
+/**
+ * this method will get the current time of a playing audio file.
+ * only works if channels == 1
+ */
+NativeAudio.getCurrentTime({
+  assetId: 'fire'
+});
+.then(result => {
+  console.log(result.currentTime);
+})
+
+/**
+ * This method will return false if audio is paused or not loaded.
+ * @param assetId - identifier of the asset
+ * @returns {isPlaying: boolean}
+ */
+NativeAudio.isPlaying({
+  assetId: 'fire'
+})
+.then(result => {
+  console.log(result.isPlaying);
+})
+```
+
+## API
+
+<docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### configure(...)
+
+```typescript
+configure(options: ConfigureOptions) => Promise<void>
+```
+
+| Param         | Type                                                          |
+| ------------- | ------------------------------------------------------------- |
+| **`options`** | <code><a href="#configureoptions">ConfigureOptions</a></code> |
+
+--------------------
+
+
+### preload(...)
+
+```typescript
+preload(options: PreloadOptions) => Promise<void>
+```
+
+| Param         | Type                                                      |
+| ------------- | --------------------------------------------------------- |
+| **`options`** | <code><a href="#preloadoptions">PreloadOptions</a></code> |
+
+--------------------
+
+
+### play(...)
+
+```typescript
+play(options: { assetId: string; time: number; }) => Promise<void>
+```
+
+| Param         | Type                                            |
+| ------------- | ----------------------------------------------- |
+| **`options`** | <code>{ assetId: string; time: number; }</code> |
+
+--------------------
+
+
+### pause(...)
+
+```typescript
+pause(options: { assetId: string; }) => Promise<void>
+```
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ assetId: string; }</code> |
+
+--------------------
+
+
+### resume(...)
+
+```typescript
+resume(options: { assetId: string; }) => Promise<void>
+```
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ assetId: string; }</code> |
+
+--------------------
+
+
+### loop(...)
+
+```typescript
+loop(options: { assetId: string; }) => Promise<void>
+```
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ assetId: string; }</code> |
+
+--------------------
+
+
+### stop(...)
+
+```typescript
+stop(options: { assetId: string; }) => Promise<void>
+```
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ assetId: string; }</code> |
+
+--------------------
+
+
+### unload(...)
+
+```typescript
+unload(options: { assetId: string; }) => Promise<void>
+```
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ assetId: string; }</code> |
+
+--------------------
+
+
+### setVolume(...)
+
+```typescript
+setVolume(options: { assetId: string; volume: number; }) => Promise<void>
+```
+
+| Param         | Type                                              |
+| ------------- | ------------------------------------------------- |
+| **`options`** | <code>{ assetId: string; volume: number; }</code> |
+
+--------------------
+
+
+### getCurrentTime(...)
+
+```typescript
+getCurrentTime(options: { assetId: string; }) => Promise<{ currentTime: number; }>
+```
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ assetId: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ currentTime: number; }&gt;</code>
+
+--------------------
+
+
+### getDuration(...)
+
+```typescript
+getDuration(options: { assetId: string; }) => Promise<{ duration: number; }>
+```
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ assetId: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ duration: number; }&gt;</code>
+
+--------------------
+
+
+### isPlaying(...)
+
+```typescript
+isPlaying(options: { assetId: string; }) => Promise<{ isPlaying: boolean; }>
+```
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ assetId: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ isPlaying: boolean; }&gt;</code>
+
+--------------------
+
+
+### Interfaces
+
+
+#### ConfigureOptions
+
+| Prop        | Type                 |
+| ----------- | -------------------- |
+| **`fade`**  | <code>boolean</code> |
+| **`focus`** | <code>boolean</code> |
+
+
+#### PreloadOptions
+
+| Prop                  | Type                 |
+| --------------------- | -------------------- |
+| **`assetPath`**       | <code>string</code>  |
+| **`assetId`**         | <code>string</code>  |
+| **`volume`**          | <code>number</code>  |
+| **`audioChannelNum`** | <code>number</code>  |
+| **`isUrl`**           | <code>boolean</code> |
+
+</docgen-api>

package/android/build.gradle

@@ -0,0 +1,55 @@
+ext {
+    junitVersion =  project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.12'
+    androidxJunitVersion =  project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.1'
+    androidxEspressoCoreVersion =  project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.2.0'
+}
+
+buildscript {
+    repositories {
+        google()
+        jcenter()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:3.6.1'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 30
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 21
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 29
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+        disable "UnsafeExperimentalUsageError",
+                    "UnsafeExperimentalUsageWarning"
+    }
+}
+
+repositories {
+    google()
+    jcenter()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation 'com.android.support:appcompat-v7:XX.X.+'
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,5 @@
+
+  <manifest xmlns:android="http://schemas.android.com/apk/res/android"
+      package="ee.forgr.audio.nativeaudio">
+  </manifest>
+  

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

@@ -0,0 +1,140 @@
+package ee.forgr.audio;
+
+import android.content.res.AssetFileDescriptor;
+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 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;
+        }
+
+        for (int x = 0; x < audioChannelNum; x++) {
+            AudioDispatcher audioDispatcher = new AudioDispatcher(assetFileDescriptor, volume);
+            audioList.add(audioDispatcher);
+            if (audioChannelNum == 1) audioDispatcher.setOwner(this);
+        }
+    }
+
+    public void dispatchComplete() {
+        this.owner.dispatchComplete(this.assetId);
+    }
+
+    public void play(Double time, Callable<Void> callback) throws Exception {
+        AudioDispatcher audio = audioList.get(playIndex);
+
+        if (audio != null) {
+            audio.play(time, callback);
+            playIndex++;
+            playIndex = playIndex % audioList.size();
+        }
+    }
+
+    public double getDuration() {
+        if (audioList.size() != 1) return 0;
+
+        AudioDispatcher audio = audioList.get(playIndex);
+
+        if (audio != null) {
+            return audio.getDuration();
+        }
+        return 0;
+    }
+
+    public double getCurrentPosition() {
+        if (audioList.size() != 1) return 0;
+
+        AudioDispatcher audio = audioList.get(playIndex);
+
+        if (audio != null) {
+            return audio.getCurrentPosition();
+        }
+        return 0;
+    }
+
+    public boolean pause() throws Exception {
+        boolean wasPlaying = false;
+
+        for (int x = 0; x < audioList.size(); x++) {
+            AudioDispatcher audio = audioList.get(x);
+            wasPlaying |= audio.pause();
+        }
+
+        return wasPlaying;
+    }
+
+    public void resume() throws Exception {
+        if (audioList.size() > 0) {
+            AudioDispatcher audio = audioList.get(0);
+
+            if (audio != null) {
+                audio.resume();
+            }
+        }
+    }
+
+    public void stop() throws Exception {
+        for (int x = 0; x < audioList.size(); x++) {
+            AudioDispatcher audio = audioList.get(x);
+
+            if (audio != null) {
+                audio.stop();
+            }
+        }
+    }
+
+    public void loop() throws Exception {
+        AudioDispatcher audio = audioList.get(playIndex);
+
+        if (audio != null) {
+            audio.loop();
+            playIndex++;
+            playIndex = playIndex % audioList.size();
+        }
+    }
+
+    public void unload() throws Exception {
+        this.stop();
+
+        for (int x = 0; x < audioList.size(); x++) {
+            AudioDispatcher audio = audioList.get(x);
+
+            if (audio != null) {
+                audio.unload();
+            }
+        }
+
+        audioList.clear();
+    }
+
+    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);
+            }
+        }
+    }
+
+    public boolean isPlaying() throws Exception {
+        if (audioList.size() != 1) return false;
+
+        return audioList.get(playIndex).isPlaying();
+    }
+}