Native Audio

Improve this doc

Native Audio Playback

Repo: https://github.com/floatinghotpot/cordova-plugin-nativeaudio

Installation

1. Install the Cordova and Ionic Native plugins:
   

   $ ionic cordova plugin add cordova-plugin-nativeaudio
   $ npm install --save @ionic-native/native-audio@4
   

2. Add this plugin to your app's module

Supported platforms

• Android
• Browser
• iOS

Usage

import { NativeAudio } from '@ionic-native/native-audio';

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);

Instance Members

preloadSimple(id, assetPath)

Loads an audio file into memory. Optimized for short clips / single shots (up to five seconds). Cannot be stopped / looped.

preloadComplex(id, assetPath, volume, voices, delay)

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.

play(id, completeCallback)

Plays an audio asset

stop(id)

Stops playing an audio

loop(id)

Loops an audio asset infinitely, this only works for complex assets

unload(id)

Unloads an audio file from memory

setVolumeForComplexAsset(id, volume)

Changes the volume for preloaded complex assets.