Skip to main content

AudioRecorder

Constructor

AudioRecorder(options)

Example

import { AudioRecorder } from 'react-native-audio-api';

function App() {
const recorder = new AudioRecorder({
sampleRate: 16000,
bufferLengthInSamples: 16000,
});

recorder.onAudioReady((event) => {
const { buffer, numFrames, when } = event;

console.log(
'Audio recorder buffer ready:',
buffer.duration,
numFrames,
when
);
});

recorder.start();
}

Methods

start

The above starts recording.

Returns undefined.

stop

The above stops recording.

Returns undefined.

onAudioReady

The above allows user to set a callback after every portion of data deliverance.

ParametersTypeDescription
callback(OnAudioReadyEventType => void)callback that will be invoked

Returns undefined.

Remarks

AudioRecorderOptions

Type definitions
interface AudioRecorderOptions {
sampleRate: number;
bufferLengthInSamples: number; //how many samples to be put in the buffer
}

OnAudioReadyEventType

Type definitions
interface OnAudioReadyEventType {
buffer: AudioBuffer;
numFrames: number; //number of frames in a buffer
when: number; //timestamp
}