![\"CapacitorJS](\"https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png\")
\n\n \n
@independo/capacitor-voice-recorder
Capacitor plugin for audio recording
\n\n\n ![\"Maintenance](\"https://img.shields.io/maintenance/yes/2026\")
![\"License](\"https://img.shields.io/npm/l/@independo/capacitor-voice-recorder\")
\n ![\"\"](\"https://img.shields.io/npm/dw/@independo/capacitor-voice-recorder\")
![\"\"](\"https://img.shields.io/npm/v/@independo/capacitor-voice-recorder\")
![\"Coverage](\"https://codecov.io/gh/independo-gmbh/capacitor-voice-recorder/branch/master/graph/badge.svg\"){kind=icon}
\n
Promise<GenericResponse>\n\n--------------------\n\n\n### requestAudioRecordingPermission()\n\n```typescript\nrequestAudioRecordingPermission() => PromisePromise<GenericResponse>\n\n--------------------\n\n\n### hasAudioRecordingPermission()\n\n```typescript\nhasAudioRecordingPermission() => PromisePromise<GenericResponse>\n\n--------------------\n\n\n### startRecording(...)\n\n```typescript\nstartRecording(options?: RecordingOptions | undefined) => PromiseRecordingOptions | The options for the recording. |\n\n**Returns:** Promise<GenericResponse>\n\n--------------------\n\n\n### stopRecording()\n\n```typescript\nstopRecording() => PromisePromise<RecordingData>\n\n--------------------\n\n\n### pauseRecording()\n\n```typescript\npauseRecording() => PromisePromise<GenericResponse>\n\n--------------------\n\n\n### resumeRecording()\n\n```typescript\nresumeRecording() => PromisePromise<GenericResponse>\n\n--------------------\n\n\n### getCurrentStatus()\n\n```typescript\ngetCurrentStatus() => PromisePromise<CurrentRecordingStatus>\n\n--------------------\n\n\n### getCurrentAmplitude()\n\n```typescript\ngetCurrentAmplitude() => PromisePromise<CurrentAmplitude>\n\n--------------------\n\n\n### addListener('voiceRecordingInterrupted', ...)\n\n```typescript\naddListener(eventName: 'voiceRecordingInterrupted', listenerFunc: (event: VoiceRecordingInterruptedEvent) => void) => Promise'voiceRecordingInterrupted' | The name of the event to listen for. |\n| **`listenerFunc`** | (event: VoiceRecordingInterruptedEvent) => void | The callback function to invoke when the event occurs. |\n\n**Returns:** Promise<PluginListenerHandle>\n\n--------------------\n\n\n### addListener('voiceRecordingInterruptionEnded', ...)\n\n```typescript\naddListener(eventName: 'voiceRecordingInterruptionEnded', listenerFunc: (event: VoiceRecordingInterruptionEndedEvent) => void) => Promise'voiceRecordingInterruptionEnded' | The name of the event to listen for. |\n| **`listenerFunc`** | (event: VoiceRecordingInterruptionEndedEvent) => void | The callback function to invoke when the event occurs. |\n\n**Returns:** Promise<PluginListenerHandle>\n\n--------------------\n\n\n### removeAllListeners()\n\n```typescript\nremoveAllListeners() => Promiseboolean | The result of the operation as a boolean value. |\n\n\n#### RecordingOptions\n\nCan be used to specify options for the recording.\n\n| Prop | Type | Description |\n| ---------------------------- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`directory`** | Directory | The capacitor filesystem directory where the recording should be saved. If not specified, the recording will be stored in a base64 string and returned in the `RecordingData` object. |\n| **`subDirectory`** | string | An optional subdirectory in the specified directory where the recording should be saved. |\n| **`requirePlaybackSupport`** | boolean | Whether the web implementation should require the selected recording MIME type to also be playable by the browser's native HTML `<audio>` element. Defaults to `true` on web to reduce cases where `MediaRecorder` reports support for a format but the recorded file cannot be played back in the same browser (observed on some Safari/iOS/WKWebView combinations). Native platforms ignore this option. |\n\n\n#### RecordingData\n\nInterface representing the data of a recording.\n\n| Prop | Type | Description |\n| ----------- | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |\n| **`value`** | { recordDataBase64: string; msDuration: number; mimeType: string; fileExtension: string; uri?: string; } | The value containing the recording details. |\n\n\n#### CurrentRecordingStatus\n\nInterface representing the current status of the voice recorder.\n\n| Prop | Type | Description |\n| ------------ | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| **`status`** | 'NONE' \\| 'RECORDING' \\| 'PAUSED' \\| 'INTERRUPTED' | The current status of the recorder, which can be one of the following values: 'RECORDING', 'PAUSED', 'INTERRUPTED', 'NONE'. |\n\n\n#### CurrentAmplitude\n\nInterface representing the current input amplitude.\n\n| Prop | Type | Description |\n| ----------- | ------------------- | ------------------------------------------------------------- |\n| **`value`** | number | The current input amplitude normalized to the `[0, 1]` range. |\n\n\n#### PluginListenerHandle\n\n| Prop | Type |\n| ------------ | ----------------------------------------- |\n| **`remove`** | () => Promise<void> |\n\n\n### Type Aliases\n\n\n#### Base64String\n\nRepresents a Base64 encoded string.\n\nstring\n\n\n#### VoiceRecordingInterruptedEvent\n\nEvent payload for voiceRecordingInterrupted event (empty - no data).\n\nRecord<string, never>\n\n\n#### Record\n\nConstruct a type with a set of properties K of type T\n\n{\r [P in K]: T;\r }\n\n\n#### VoiceRecordingInterruptionEndedEvent\n\nEvent payload for voiceRecordingInterruptionEnded event (empty - no data).\n\nRecord<string, never>\n\n\n### Enums\n\n\n#### Directory\n\n| Members | Value | Description | Since |\n| --------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |\n| **`Documents`** | \"DOCUMENTS\" | The Documents directory. On iOS it's the app's documents directory. Use this directory to store user-generated content. On Android it's the Public Documents folder, so it's accessible from other apps. It's not accessible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage=\"true\"` in the `application` tag in the `AndroidManifest.xml`. On Android 11 or newer the app can only access the files/folders the app created. | 1.0.0 |\n| **`Data`** | \"DATA\" | The Data directory. On iOS it will use the Documents directory. On Android it's the directory holding application files. Files will be deleted when the application is uninstalled. | 1.0.0 |\n| **`Library`** | \"LIBRARY\" | The Library directory. On iOS it will use the Library directory. On Android it's the directory holding application files. Files will be deleted when the application is uninstalled. | 1.1.0 |\n| **`Cache`** | \"CACHE\" | The Cache directory. Can be deleted in cases of low memory, so use this directory to write app-specific files. that your app can re-create easily. | 1.0.0 |\n| **`External`** | \"EXTERNAL\" | The external directory. On iOS it will use the Documents directory. On Android it's the directory on the primary shared/external storage device where the application can place persistent files it owns. These files are internal to the applications, and not typically visible to the user as media. Files will be deleted when the application is uninstalled. | 1.0.0 |\n| **`ExternalStorage`** | \"EXTERNAL_STORAGE\" | The external storage directory. On iOS it will use the Documents directory. On Android it's the primary shared/external storage directory. It's not accessible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage=\"true\"` in the `application` tag in the `AndroidManifest.xml`. It's not accessible on Android 11 or newer. | 1.0.0 |\n| **`ExternalCache`** | \"EXTERNAL_CACHE\" | The external cache directory. On iOS it will use the Documents directory. On Android it's the primary shared/external cache. | 7.1.0 |\n| **`LibraryNoCloud`** | \"LIBRARY_NO_CLOUD\" | The Library directory without cloud backup. Used in iOS. On Android it's the directory holding application files. | 7.1.0 |\n| **`Temporary`** | \"TEMPORARY\" | A temporary directory for iOS. On Android it's the directory holding the application cache. | 7.1.0 |\n\n