Audio Recorder Capacitor plugin

Using @capgo/capacitor-audio-recorder

Capacitor plugin contract for recording audio.

Install

bun add @capgo/capacitor-audio-recorder
bunx cap sync

bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.

Import

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

API at a glance

Examples

startRecording()

Start recording audio using the device microphone.

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

await CapacitorAudioRecorder.startRecording();

pauseRecording()

Pause the ongoing recording. Only available on Android (API 24+), iOS, and Web.

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

await CapacitorAudioRecorder.pauseRecording();

resumeRecording()

Resume a previously paused recording.

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

await CapacitorAudioRecorder.resumeRecording();

stopRecording()

Stop the current recording and persist the recorded audio.

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

const result = await CapacitorAudioRecorder.stopRecording();
console.log(result);

cancelRecording()

Cancel the current recording and discard any captured audio.

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

await CapacitorAudioRecorder.cancelRecording();

getRecordingStatus()

Retrieve the current recording status.

import { CapacitorAudioRecorder } from '@capgo/capacitor-audio-recorder';

const result = await CapacitorAudioRecorder.getRecordingStatus();
console.log(result);

The table above lists the 9 core methods. Listener and version helpers, and the full contract of each method, are documented in the GitHub repository.

Listen to events

addListener returns a handle. Call handle.remove() when the screen unmounts, or CapacitorAudioRecorder.removeAllListeners() to clear every listener.

Full reference

• GitHub repository
• Documentation
• API reference

Keep going from Using @capgo/capacitor-audio-recorder

If you are using Using @capgo/capacitor-audio-recorder to plan native media and interface behavior, connect it with @capgo/capacitor-audio-recorder for the implementation detail in @capgo/capacitor-audio-recorder, Getting Started for the implementation detail in Getting Started, Using @capgo/capacitor-live-activities for the native capability in Using @capgo/capacitor-live-activities, @capgo/capacitor-live-activities for the implementation detail in @capgo/capacitor-live-activities, and Using @capgo/capacitor-video-player for the native capability in Using @capgo/capacitor-video-player.