react-native-audio-recorder-player

This is a react-native link module for audio recorder and player. This is not a playlist audio module and this library provides simple recorder and player functionalities for both android and ios platforms. This only supports default file extension for each platform. This module can also handle file from url.

Free read

• Happy Blog.

Breaking Changes

• Migrated to Android X in 2.2.0. Please check the Migration Guide.

Migration Guide

To migrate to 2.2.0 you must migrate your Android app to Android X by following the Migrating to AndroidX Guide.

Preview

Migration Guide

| 1.. | 2.. | | --- | --- | | startRecord | startRecorder | | stopRecord | stopRecorder | | startPlay | startPlayer | | stopPlay | stopPlayer | | pausePlay | pausePlayer | | resume | resumePlayer | | seekTo | seekToPlayer | | | setSubscriptionDuration | | setRecordInterval | addRecordBackListener | | removeRecordInterval | `` | | | setVolume |

Getting started

$ npm install react-native-audio-recorder-player --save

Mostly automatic installation

$ react-native link react-native-audio-recorder-player

Manual installation

iOS

1. In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project's name]
2. Go to node_modules ➜ react-native-audio-recorder-player and add RNAudioRecorderPlayer.xcodeproj
3. In XCode, in the project navigator, select your project. Add libRNAudioRecorderPlayer.a to your project's Build Phases ➜ Link Binary With Libraries
4. Run your project (Cmd+R)<

Android

1. Open up android/app/src/main/java/[...]/MainActivity.java

• Add import com.dooboolab.RNAudioRecorderPlayerPackage; to the imports at the top of the file
• Add new RNAudioRecorderPlayerPackage() to the list returned by the getPackages() method

2. Append the following lines to android/settings.gradle:

   include ':react-native-audio-recorder-player'
   project(':react-native-audio-recorder-player').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-audio-recorder-player/android')

3. Insert the following lines inside the dependencies block in android/app/build.gradle:

     compile project(':react-native-audio-recorder-player')

Post installation

On iOS you need to add a usage description to Info.plist:

<key>NSMicrophoneUsageDescription</key>
<string>This sample uses the microphone to record your speech and convert it to text.</string>

On Android you need to add a permission to AndroidManifest.xml:

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

Also, android above Marshmallow needs runtime permission to record audio. Using react-native-permissions will help you out with this problem. Below is sample usage before when started the recording.

if (Platform.OS === 'android') {
  const micPermission: string = await checkPermission('microphone');
  console.log('micPermission', micPermission);
  if (micPermission !== 'authorized') {
    const micRequest: string = await requestPermission('microphone');
    console.log('micRequest', micRequest);
    if (micRequest !== 'authorized') {
      return;
    }
  }
  const storagePermission: string = await checkPermission('storage');
  if (storagePermission !== 'authorized') {
    const storageRequest: string = await requestPermission('storage');
    if (storageRequest !== 'authorized') {
      return;
    }
  }
}

Methods

All methods are implemented with promises.

| Func | Param | Return | Description | | :------------ |:---------------:| :---------------:| :-----| | mmss | number seconds | string | Convert seconds to minute:second string. | | addRecordBackListener | | Promise<void> | Set record interval in second. | | addPlayBackListener | Function callBack | void | Get callback from native module. Will receive duration, current_position | | startRecorder | <string> uri? | Promise<void> | Start recording. Not passing the param will save audio in default location. | | stopRecorder | | Promise<string> | Stop recording. | | startPlayer | <string> uri? | Promise<string> | Start playing. Not passing the param will play audio in default location. | | stopPlayer | | Promise<string> | Stop playing. | | pausePlayer | | Promise<string> | Pause playing. | | seekToPlayer | number seconds | Promise<string> | Seek audio. | | setVolume | doulbe value | Promise<string> | Set volume of audio player (default 1.0, range: 0.0 ~ 1.0). |

Default Path

• Default path for android uri is sdcard/sound.mp4.
• Default path for ios uri is sound.m4a.

Usage

import AudioRecorderPlayer from 'react-native-audio-recorder-player';

const audioRecorderPlayer = new AudioRecorderPlayer();

onStartRecord = async () => {
  const result = await this.audioRecorderPlayer.startRecorder();
  this.audioRecorderPlayer.addRecordBackListener((e) => {
    this.setState({
      recordSecs: e.current_position,
      recordTime: this.audioRecorderPlayer.mmssss(Math.floor(e.current_position)),
    });
    return;
  });
  console.log(result);
}

onStopRecord = async () => {
  const result = await this.audioRecorderPlayer.stopRecorder();
  this.audioRecorderPlayer.removeRecordBackListener();
  this.setState({
    recordSecs: 0,
  });
  console.log(result);
}

onStartPlay = async () => {
  console.log('onStartPlay');
  const msg = await this.audioRecorderPlayer.startPlayer();
  console.log(msg);
  this.audioRecorderPlayer.addPlayBackListener((e) => {
    if (e.current_position === e.duration) {
      console.log('finished');
      this.audioRecorderPlayer.stopPlayer();
    }
    this.setState({
      currentPositionSec: e.current_position,
      currentDurationSec: e.duration,
      playTime: this.audioRecorderPlayer.mmssss(Math.floor(e.current_position)),
      duration: this.audioRecorderPlayer.mmssss(Math.floor(e.duration)),
    });
    return;
  });
}

onPausePlay = async () => {
  await this.audioRecorderPlayer.pausePlayer();
}

onStopPlay = async () => {
  console.log('onStopPlay');
  this.audioRecorderPlayer.stopPlayer();
  this.audioRecorderPlayer.removePlayBackListener();
}

TIPS

If you want to get actual uri from the record or play file to actually grab it and upload it to your bucket, just grab the resolved message when using startPlay or startRecord method like below.

const path = Platform.select({
  ios: 'hello.m4a',
  android: 'sdcard/hello.mp4', // should give extra dir name in android. Won't grant permission to the first level of dir.
});
const uri = await audioRecorderPlayer.startRecord(path);

Also, above example helps you to setup manual path to record audio. Not giving path param will record in default path as mentioned above.

Try yourself

1. Goto Example folder by running cd Example.
2. Run npm install && npm start.
3. Run npm run ios to run on ios simulator and npm run android to run on your android device.

TODO

• [ ] Better android permission handling
• [x] Volume Control
• [x] Sync timing for recorder callback handler

Special Thanks

mansya - logo designer.

Help Maintenance

I've been maintaining quite many repos these days and burning out slowly. If you could help me cheer up, buying me a cup of coffee will make my life really happy and get much energy out of it.