Home

Awesome

<a align="center" href="https://www.npmjs.com/package/nativescript-audio"> <h3 align="center">NativeScript Audio</h3> </a> <h4 align="center">NativeScript plugin to play and record audio files for Android and iOS.</h4> <p align="center"> <a href="https://www.npmjs.com/package/nativescript-audio"> <img src="https://img.shields.io/npm/v/nativescript-audio.svg" alt="npm"> </a> <a href="https://www.npmjs.com/package/nativescript-audio"> <img src="https://img.shields.io/npm/dt/nativescript-audio.svg?label=npm%20downloads" alt="npm"> </a> <a href="https://github.com/nstudio/nativescript-audio/stargazers"> <img src="https://img.shields.io/github/stars/nstudio/nativescript-audio.svg" alt="stars"> </a> <a href="https://github.com/nstudio/nativescript-audio/network"> <img src="https://img.shields.io/github/forks/nstudio/nativescript-audio.svg" alt="forks"> </a> <a href="https://github.com/nstudio/nativescript-audio/blob/master/LICENSE.md"> <img src="https://img.shields.io/github/license/nstudio/nativescript-audio.svg" alt="license"> </a> <a href="https://paypal.me/bradwayne88"> <img src="https://img.shields.io/badge/Donate-PayPal-green.svg" alt="donate"> </a> <a href="http://nstudio.io"> <img src="./screens/nstudio-banner.png" alt="nStudio banner"> </a> <h5 align="center">Do you need assistance on your project or plugin? Contact the nStudio team anytime at <a href="mailto:team@nstudio.io">team@nstudio.io</a> to get up to speed with the best practices in mobile and web app development. </h5> </p>

Installation

tns plugin add nativescript-audio

Recording Permissions

iOS

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

Android

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

Android Native Classes

iOS Native Classes

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

MethodDescription
TNSRecorder.CAN_RECORD(): boolean - static methodDetermine if ready to record.
start(options: AudioRecorderOptions): Promise<void>Start recording to file.
stop(): Promise<void>Stop recording.
pause(): Promise<void>Pause recording.
resume(): Promise<void>Resume recording.
dispose(): Promise<void>Free up system resources when done with recorder.
getMeters(channel?: number): numberReturns the amplitude of the input.
isRecording(): boolean - iOS OnlyReturns true if recorder is actively recording.
requestRecordPermission(): Promise<void>Android Only Resolves the promise is user grants the permission.
hasRecordPermission(): booleanAndroid Only Returns true if RECORD_AUDIO permission has been granted.

TNSRecorder Instance Properties

PropertyDescription
iosGet the native AVAudioRecorder class instance.
androidGet the native MediaRecorder class instance.
debugSet true to enable debugging console logs (default false).

Player

TNSPlayer Methods

MethodDescription
initFromFile(options: AudioPlayerOptions): PromiseInitialize player instance with a file without auto-playing.
playFromFile(options: AudioPlayerOptions): PromiseAuto-play from a file.
initFromUrl(options: AudioPlayerOptions): PromiseInitialize player instance from a url without auto-playing.
playFromUrl(options: AudioPlayerOptions): PromiseAuto-play from a url.
pause(): Promise<boolean>Pause playback.
resume(): voidResume playback.
seekTo(time:number): Promise<boolean>Seek to position of track (in seconds).
dispose(): Promise<boolean>Free up resources when done playing audio.
isAudioPlaying(): booleanDetermine if player is playing.
getAudioTrackDuration(): Promise<string>Duration of media file assigned to the player.
playAtTime(time: number): void - iOS OnlyPlay audio track at specific time of duration.
changePlayerSpeed(speed: number): void - On Android Only API 23+Change the playback speed of the media player.

TNSPlayer Instance Properties

PropertyDescription
iosGet the native ios AVAudioPlayer instance.
androidGet the native android MediaPlayer instance.
debug: booleanSet true to enable debugging console logs (default false).
currentTime: numberGet the current time in the media file's duration.
volume: numberGet/Set the player volume. Value range from 0 to 1.

License

MIT

Demo App