Awesome

Installation

tns plugin add nativescript-audio

Recording Permissions

iOS

• To record, add the following to your project's Info.plist file in the App_Resources/iOS directory (see here for example).

<key>NSMicrophoneUsageDescription</key>
<string>The app needs to access your Microphone to record.</string>

Android

• To record, add the following permission to your AndroidManifest.xml file in App_Resources/Android/ directory (see here for example).

<uses-permission android:name="android.permission.RECORD_AUDIO" />

Android Native Classes

• Player - android.media.MediaPlayer
• Recorder - android.media.MediaRecorder

iOS Native Classes

• Player - AVAudioPlayer
• Recorder - AVAudioRecorder

Usage

TypeScript Example

import { TNSPlayer } from 'nativescript-audio';

export class YourClass {
  private _player: TNSPlayer;

  constructor() {
    this._player = new TNSPlayer();
    this._player.debug = true; // set true to enable TNSPlayer console logs for debugging.
    this._player
      .initFromFile({
        audioFile: '~/audio/song.mp3', // ~ = app directory
        loop: false,
        completeCallback: this._trackComplete.bind(this),
        errorCallback: this._trackError.bind(this)
      })
      .then(() => {
        this._player.getAudioTrackDuration().then(duration => {
          // iOS: duration is in seconds
          // Android: duration is in milliseconds
          console.log(`song duration:`, duration);
        });
      });
  }

  public togglePlay() {
    if (this._player.isAudioPlaying()) {
      this._player.pause();
    } else {
      this._player.play();
    }
  }

  private _trackComplete(args: any) {
    console.log('reference back to player:', args.player);
    // iOS only: flag indicating if completed succesfully
    console.log('whether song play completed successfully:', args.flag);
  }

  private _trackError(args: any) {
    console.log('reference back to player:', args.player);
    console.log('the error:', args.error);
    // Android only: extra detail on error
    console.log('extra info on the error:', args.extra);
  }
}

Javascript Example:

const audio = require('nativescript-audio');

const player = new audio.TNSPlayer();
const playerOptions = {
  audioFile: 'http://some/audio/file.mp3',
  loop: false,
  completeCallback: function() {
    console.log('finished playing');
  },
  errorCallback: function(errorObject) {
    console.log(JSON.stringify(errorObject));
  },
  infoCallback: function(args) {
    console.log(JSON.stringify(args));
  }
};

player
  .playFromUrl(playerOptions)
  .then(function(res) {
    console.log(res);
  })
  .catch(function(err) {
    console.log('something went wrong...', err);
  });

API

Recorder

TNSRecorder Methods

TNSRecorder Instance Properties

Player

TNSPlayer Methods

TNSPlayer Instance Properties

License

MIT

Demo App

• fork/clone the repository
• cd into the src directory
• execute npm run demo.android or npm run demo.ios (scripts are located in the scripts of the package.json in the src directory if you are curious)