@capgo/capacitor-audio-recorder

Overview

Capacitor plugin contract for recording audio.

Core Capabilities

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

Public API

Method	Description
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.
cancelRecording	Cancel the current recording and discard any captured audio.
getRecordingStatus	Retrieve the current recording status.
getCurrentAmplitude	Retrieve the current input amplitude (microphone level) as a normalized number in the [0, 1] range.
checkPermissions	Return the current permission state for accessing the microphone.
requestPermissions	Request permission to access the microphone.
addListener	Listen for recording errors.
addListener	Listen for pause events emitted when a recording is paused.
addListener	Listen for recording completion events.
removeAllListeners	Remove all registered listeners.
getPluginVersion	Get the native Capacitor plugin version.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-audio-recorder.