nativescript-audio-player

NativeScript Audio Player

NativeScript plugin to play audio files for Android and iOS.

---

Installation

tns plugin add nativescript-audio-player

---

$3

* Android - android.media.MediaPlayer
* iOS - AVAudioPlayer

Usage

$3

``typescript
import { TNSPlayer } from 'nativescript-audio-player';

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

$3

`javascript
const audio = require('nativescript-audio-player');

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

$3

#### TNSPlayer Methods

| Method | Description |
| ---------------------------------------------------------------------- | ------------------------------------------------------------ |
| _initFromFile(options: AudioPlayerOptions)_: Promise | Initialize player instance with a file without auto-playing. |
| _playFromFile(options: AudioPlayerOptions)_: Promise | Auto-play from a file. |
| _initFromUrl(options: AudioPlayerOptions)_: Promise | Initialize player instance from a url without auto-playing. |
| _playFromUrl(options: AudioPlayerOptions)_: Promise | Auto-play from a url. |
| _pause()_: Promise | Pause playback. |
| _resume()_: void | Resume playback. |
| _seekTo(time:number)_: Promise | Seek to position. |
| _dispose()_: Promise | Free up resources when done playing audio. |
| _isAudioPlaying()_: boolean | Determine if player is playing. |
| _getAudioTrackDuration()_: Promise | Duration of media file assigned to the player. |
| _playAtTime(time: number)_: void - _iOS Only_ | Play 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

| Property | Description |
| ----------------------- | ---------------------------------------------------------- |
| _ios_ | Get the native ios AVAudioPlayer instance. |
| _android_ | Get the native android MediaPlayer instance. |
| _debug_: boolean | Set true to enable debugging console logs (default false). |
| _currentTime_: number | Get the current time in the media file's duration. |
| _volume_: number` | Get/Set the player volume. Value range from 0 to 1. |

$3

MIT