chore(repo): move files to new repo name

2026-05-02 00:07:23 +08:00 · 2021-09-27 17:07:03 +02:00
parent 3ae573b632
commit 15c441cc2a
246 changed files with 484 additions and 523 deletions
@@ -0,0 +1,120 @@
+import { Injectable } from '@angular/core';
+import { Cordova, IonicNativePlugin, Plugin } from '@awesome-cordova-plugins/core';
+/**
+ * @name Native Audio
+ * @description Native Audio Playback
+ * @usage
+ * ```typescript
+ * import { NativeAudio } from '@awesome-cordova-plugins/native-audio/ngx';
+ *
+ * constructor(private nativeAudio: NativeAudio) { }
+ *
+ * ...
+ *
+ * this.nativeAudio.preloadSimple('uniqueId1', 'path/to/file.mp3').then(onSuccess, onError);
+ * this.nativeAudio.preloadComplex('uniqueId2', 'path/to/file2.mp3', 1, 1, 0).then(onSuccess, onError);
+ *
+ * this.nativeAudio.play('uniqueId1').then(onSuccess, onError);
+ *
+ * // can optionally pass a callback to be called when the file is done playing
+ * this.nativeAudio.play('uniqueId1', () => console.log('uniqueId1 is done playing'));
+ *
+ * this.nativeAudio.loop('uniqueId2').then(onSuccess, onError);
+ *
+ * this.nativeAudio.setVolumeForComplexAsset('uniqueId2', 0.6).then(onSuccess,onError);
+ *
+ * this.nativeAudio.stop('uniqueId1').then(onSuccess,onError);
+ *
+ * this.nativeAudio.unload('uniqueId1').then(onSuccess,onError);
+ *
+ * ```
+ */
+@Plugin({
+  pluginName: 'NativeAudio',
+  plugin: 'cordova-plugin-nativeaudio',
+  pluginRef: 'plugins.NativeAudio',
+  repo: 'https://github.com/floatinghotpot/cordova-plugin-nativeaudio',
+  platforms: ['Android', 'Browser', 'iOS'],
+})
+@Injectable()
+export class NativeAudio extends IonicNativePlugin {
+  /**
+   * Loads an audio file into memory. Optimized for short clips / single shots (up to five seconds). Cannot be stopped / looped.
+   * @param id {string} unique ID for the audio file
+   * @param assetPath {string}  the relative path or absolute URL (inluding http://) to the audio asset.
+   * @returns {Promise<any>}
+   */
+  @Cordova()
+  preloadSimple(id: string, assetPath: string): Promise<any> {
+    return;
+  }
+
+  /**
+   * Loads an audio file into memory. Optimized for background music / ambient sound. Uses highlevel native APIs with a larger footprint. (iOS: AVAudioPlayer). Can be stopped / looped and used with multiple voices. Can be faded in and out using the delay parameter.
+   * @param id {string} unique ID for the audio file
+   * @param assetPath {string}  the relative path or absolute URL (inluding http://) to the audio asset.
+   * @param volume {number} the volume of the preloaded sound (0.1 to 1.0)
+   * @param voices {number} the number of multichannel voices available
+   * @param delay {number}
+   * @returns {Promise<any>}
+   */
+  @Cordova()
+  preloadComplex(id: string, assetPath: string, volume: number, voices: number, delay: number): Promise<any> {
+    return;
+  }
+
+  /**
+   * Plays an audio asset
+   * @param id {string} unique ID for the audio file
+   * @param completeCallback {Function} optional. Callback to be invoked when audio is done playing
+   * @returns {Promise<any>}
+   */
+  @Cordova({
+    successIndex: 1,
+    errorIndex: 2,
+  })
+  play(id: string, completeCallback?: Function): Promise<any> {
+    return;
+  }
+
+  /**
+   * Stops playing an audio
+   * @param id {string} unique ID for the audio file
+   * @returns {Promise<any>}
+   */
+  @Cordova()
+  stop(id: string): Promise<any> {
+    return;
+  }
+
+  /**
+   * Loops an audio asset infinitely, this only works for complex assets
+   * @param id {string} unique ID for the audio file
+   * @return {Promise<any>}
+   */
+  @Cordova()
+  loop(id: string): Promise<any> {
+    return;
+  }
+
+  /**
+   * Unloads an audio file from memory
+   * @param id {string} unique ID for the audio file
+   * @returns {Promise<any>}
+   */
+  @Cordova()
+  unload(id: string): Promise<any> {
+    return;
+  }
+
+  /**
+   * Changes the volume for preloaded complex assets.
+   * @param id {string} unique ID for the audio file
+   * @param volume {number} the volume of the audio asset (0.1 to 1.0)
+   * @returns {Promise<any>}
+   */
+  @Cordova()
+  setVolumeForComplexAsset(id: string, volume: number): Promise<any> {
+    return;
+  }
+}