Skip to main content
Capgo logo
Back to plugins
@capgo/capacitor-audio-recorder
Tutorial
@capgo/capacitor-audio-recorder

Audio Recorder

Record audio on iOS, Android, and Web with simple controls and formats

Downloads/month

43.3k

GitHub Stars

12

Guide

Tutorial on Audio Recorder

Using @capgo/capacitor-audio-recorder

Capacitor plugin contract for recording audio.

Install

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

What This Plugin Exposes

  • startRecording - Start recording audio using the device microphone.
  • pauseRecording - Pause the ongoing recording. Only available on Android (API 24+), iOS, and Web.
  • resumeRecording - Resume a previously paused recording.
  • stopRecording - Stop the current recording and persist the recorded audio.

Example Usage

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';

await CapacitorAudioRecorder.stopRecording();

Full 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.