nativeScript-audio-jf | NativeScript 市场place

NativeScript 音频

用于 Android 和 iOS 播放和录制音频文件的 NativeScript 插件。

安装

tns plugin add nativescript-audio-jf

录制权限

iOS

要录制，请将以下内容添加到项目 Info.plist 文件中，该文件位于 App_Resources/iOS 目录下（示例见此处）。

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

Android

要录制，请将以下权限添加到位于 App_Resources/Android 目录下的 AndroidManifest.xml 文件中（示例见此处）。

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

Android 本地类

iOS 本地类

使用方法

TypeScript 示例

import { TNSPlayer } from 'nativescript-audio-jf';

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 示例

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

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

录音机

TNSRecorder 方法

方法	描述
TNSRecorder.CAN_RECORD(): `boolean` - *静态方法*	确定是否准备好录制。
start(options: AudioRecorderOptions): `Promise<void>`	开始录制到文件。
stop(): `Promise<void>`	停止录制。
pause(): `Promise<void>`	暂停录制。
resume(): `Promise<void>`	恢复录制。
dispose(): `Promise<void>`	完成录制后释放系统资源。
getMeters(channel?: number): `number`	返回输入的振幅。
isRecording(): `boolean` - *仅限 iOS*	如果录音机正在积极录制，则返回 true。
requestRecordPermission(): `Promise<void>`	仅限 Android 当用户授予权限时解决承诺。
hasRecordPermission(): `boolean`	仅限 Android 如果已授予 RECORD_AUDIO 权限，则返回 true。

TNSRecorder 实例属性

属性	描述
ios	获取原生 AVAudioRecorder 类实例。
android	获取原生 MediaRecorder 类实例。
debug	将 true 设置为启用调试控制台日志（默认为 false）。

播放器

TNSPlayer 方法

方法	描述
initFromFile(options: AudioPlayerOptions): `Promise`	使用文件初始化播放器实例，但不自动播放。
playFromFile(options: AudioPlayerOptions): `Promise`	从文件自动播放。
initFromUrl(options: AudioPlayerOptions): `Promise`	从 URL 初始化播放器实例，但不自动播放。
playFromUrl(options: AudioPlayerOptions): `Promise`	从 URL 自动播放。
pause(): `Promise<boolean>`	暂停播放。
resume(): `void`	恢复播放。
seekTo(time:number): `Promise<boolean>`	定位到轨道的位置（以秒为单位）。
dispose(): `Promise<boolean>`	播放音频完成后释放资源。
isAudioPlaying(): `boolean`	确定播放器是否正在播放。
getAudioTrackDuration(): `Promise<string>`	分配给播放器的媒体文件的持续时间。
playAtTime(time: number): void - *仅限 iOS*	在特定的持续时间时刻播放音频轨道。
changePlayerSpeed(speed: number): void - 仅限 Android API 23+	更改媒体播放器的播放速度。

TNSPlayer 实例属性

属性	描述
ios	获取原生 iOS AVAudioPlayer 实例。
android	获取原生 android MediaPlayer 实例。
debug: `布尔值`	将 true 设置为启用调试控制台日志（默认为 false）。
currentTime: `数字`	获取媒体文件持续时间的当前时间。
volume: `数字`	获取/设置播放器音量。值范围从 0 到 1。

许可

ISC