@independo/capacitor-voice-recorder 5.0.0

package/CapacitorVoiceRecorder.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapacitorVoiceRecorder'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target  = '13.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

package/README.md

@@ -0,0 +1,232 @@
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" />
+</p>
+<h3 align="center">Capacitor Voice Recorder</h3>
+<p align="center"><strong><code>tchvu3/capacitor-voice-recorder</code></strong></p>
+<p align="center">Capacitor plugin for simple voice recording (For Capacitor 5)</p>
+
+<p align="center">
+  <img src="https://img.shields.io/maintenance/yes/2023" />
+  <a href="https://www.npmjs.com/package/capacitor-voice-recorder"><img src="https://img.shields.io/npm/l/capacitor-voice-recorder" /></a>
+<br>
+  <a href="https://www.npmjs.com/package/capacitor-voice-recorder"><img src="https://img.shields.io/npm/dw/capacitor-voice-recorder" /></a>
+  <a href="https://www.npmjs.com/package/capacitor-voice-recorder"><img src="https://img.shields.io/npm/v/capacitor-voice-recorder" /></a>
+</p>
+
+## Maintainers
+
+| Maintainer   | GitHub                              |
+|--------------|-------------------------------------|
+| Avihu Harush | [tchvu3](https://github.com/tchvu3) |
+
+## Installation
+
+```
+npm install --save capacitor-voice-recorder
+npx cap sync
+```
+
+#### ios note
+
+Make sure to include the ```NSMicrophoneUsageDescription```
+key, and a corresponding purpose string in your app's Info.plist
+
+## Configuration
+
+No configuration required for this plugin.
+
+## Supported methods
+
+| Name                            | Android | iOS | Web |
+|:--------------------------------|:--------|:----|:----|
+| canDeviceVoiceRecord            | ✅       | ✅   | ✅   |
+| requestAudioRecordingPermission | ✅       | ✅   | ✅   |
+| hasAudioRecordingPermission     | ✅       | ✅   | ✅   |
+| startRecording                  | ✅       | ✅   | ✅   |
+| stopRecording                   | ✅       | ✅   | ✅   |
+| pauseRecording                  | ✅       | ✅   | ✅   |
+| resumeRecording                 | ✅       | ✅   | ✅   |
+| getCurrentStatus                | ✅       | ✅   | ✅   |
+
+## Overview
+
+The `capacitor-voice-recorder` plugin allows you to record audio on Android, iOS, and Web platforms. Below is a summary
+of the key methods and how to use them.
+
+### Checking Device Capabilities and Permissions
+
+#### canDeviceVoiceRecord
+
+Checks if the device/browser can record audio.
+
+```typescript
+VoiceRecorder.canDeviceVoiceRecord().then((result: GenericResponse) => console.log(result.value));
+```
+
+| Return Value       | Description                                                                            |
+|--------------------|----------------------------------------------------------------------------------------|
+| `{ value: true }`  | The device/browser can record audio.                                                   |
+| `{ value: false }` | The browser cannot record audio. Note: On mobile, it always returns `{ value: true }`. |
+
+#### requestAudioRecordingPermission
+
+Requests audio recording permission from the user.
+
+```typescript
+VoiceRecorder.requestAudioRecordingPermission().then((result: GenericResponse) => console.log(result.value));
+```
+
+| Return Value       | Description         |
+|--------------------|---------------------|
+| `{ value: true }`  | Permission granted. |
+| `{ value: false }` | Permission denied.  |
+
+#### hasAudioRecordingPermission
+
+Checks if the audio recording permission has been granted.
+
+```typescript
+VoiceRecorder.hasAudioRecordingPermission().then((result: GenericResponse) => console.log(result.value));
+```
+
+| Return Value                        | Description                        |
+|-------------------------------------|------------------------------------|
+| `{ value: true }`                   | Permission granted.                |
+| `{ value: false }`                  | Permission denied.                 |
+| Error Code                          | Description                        |
+| `COULD_NOT_QUERY_PERMISSION_STATUS` | Failed to query permission status. |
+
+### Managing Recording
+
+#### startRecording
+
+Starts the audio recording.
+
+```typescript
+VoiceRecorder.startRecording()
+    .then((result: GenericResponse) => console.log(result.value))
+    .catch(error => console.log(error));
+```
+
+| Return Value      | Description                     |
+|-------------------|---------------------------------|
+| `{ value: true }` | Recording started successfully. |
+
+| Error Code                   | Description                              |
+|------------------------------|------------------------------------------|
+| `MISSING_PERMISSION`         | Required permission is missing.          |
+| `DEVICE_CANNOT_VOICE_RECORD` | Device/browser cannot record audio.      |
+| `ALREADY_RECORDING`          | A recording is already in progress.      |
+| `MICROPHONE_BEING_USED`      | Microphone is being used by another app. |
+| `FAILED_TO_RECORD`           | Unknown error occurred during recording. |
+
+#### stopRecording
+
+Stops the audio recording and returns the recording data.
+
+```typescript
+VoiceRecorder.stopRecording()
+    .then((result: RecordingData) => console.log(result.value))
+    .catch(error => console.log(error));
+```
+
+| Return Value       | Description                                    |
+|--------------------|------------------------------------------------|
+| `recordDataBase64` | The recorded audio data in Base64 format.      |
+| `msDuration`       | The duration of the recording in milliseconds. |
+| `mimeType`         | The MIME type of the recorded audio.           |
+
+| Error Code                  | Description                                          |
+|-----------------------------|------------------------------------------------------|
+| `RECORDING_HAS_NOT_STARTED` | No recording in progress.                            |
+| `EMPTY_RECORDING`           | Recording stopped immediately after starting.        |
+| `FAILED_TO_FETCH_RECORDING` | Unknown error occurred while fetching the recording. |
+
+#### pauseRecording
+
+Pauses the ongoing audio recording.
+
+```typescript
+VoiceRecorder.pauseRecording()
+    .then((result: GenericResponse) => console.log(result.value))
+    .catch(error => console.log(error));
+```
+
+| Return Value       | Description                    |
+|--------------------|--------------------------------|
+| `{ value: true }`  | Recording paused successfully. |
+| `{ value: false }` | Recording is already paused.   |
+
+| Error Code                  | Description                                        |
+|-----------------------------|----------------------------------------------------|
+| `RECORDING_HAS_NOT_STARTED` | No recording in progress.                          |
+| `NOT_SUPPORTED_OS_VERSION`  | Operation not supported on the current OS version. |
+
+#### resumeRecording
+
+Resumes a paused audio recording.
+
+```typescript
+VoiceRecorder.resumeRecording()
+    .then((result: GenericResponse) => console.log(result.value))
+    .catch(error => console.log(error));
+```
+
+| Return Value       | Description                     |
+|--------------------|---------------------------------|
+| `{ value: true }`  | Recording resumed successfully. |
+| `{ value: false }` | Recording is already running.   |
+
+| Error Code                  | Description                                        |
+|-----------------------------|----------------------------------------------------|
+| `RECORDING_HAS_NOT_STARTED` | No recording in progress.                          |
+| `NOT_SUPPORTED_OS_VERSION`  | Operation not supported on the current OS version. |
+
+#### getCurrentStatus
+
+Retrieves the current status of the recorder.
+
+```typescript
+VoiceRecorder.getCurrentStatus()
+    .then((result: CurrentRecordingStatus) => console.log(result.status))
+    .catch(error => console.log(error));
+```
+
+| Status Code | Description                                          |
+|-------------|------------------------------------------------------|
+| `NONE`      | Plugin is idle and waiting to start a new recording. |
+| `RECORDING` | Plugin is currently recording.                       |
+| `PAUSED`    | Recording is paused.                                 |
+
+## Format and Mime type
+
+The plugin will return the recording in one of several possible formats.
+the format is dependent on the os / web browser that the user uses.
+on android and ios the mime type will be `audio/aac`, while on chrome and firefox it
+will be `audio/webm;codecs=opus` and on safari it will be `audio/mp4`.
+note that these 3 browsers has been tested on. the plugin should still work on
+other browsers, as there is a list of mime types that the plugin checks against the
+user's browser.
+
+Note that this fact might cause unexpected behavior in case you'll try to play recordings
+between several devices or browsers - as they not all support the same set of audio formats.
+it is recommended to convert the recordings to a format that all your target devices supports.
+as this plugin focuses on the recording aspect, it does not provide any conversion between formats.
+
+## Playback
+
+To play the recorded file you can use plain javascript:
+
+```typescript
+const base64Sound = '...' // from plugin
+const mimeType = '...'  // from plugin
+const audioRef = new Audio(`data:${mimeType};base64,${base64Sound}`)
+audioRef.oncanplaythrough = () => audioRef.play()
+audioRef.load()
+```
+
+## Donation
+
+If you enjoy my work and find it useful, feel free to invite me to a cup of coffee :)
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/tchvu3)

package/android/build.gradle

@@ -0,0 +1,58 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.6.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.5'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.5.1'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.0.0'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace "com.tchvu3.capacitorvoicerecorder"
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 33
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 33
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>

package/android/src/main/java/com/tchvu3/capacitorvoicerecorder/CurrentRecordingStatus.java

@@ -0,0 +1,7 @@
+package com.tchvu3.capacitorvoicerecorder;
+
+public enum CurrentRecordingStatus {
+    RECORDING,
+    PAUSED,
+    NONE
+}

package/android/src/main/java/com/tchvu3/capacitorvoicerecorder/CustomMediaRecorder.java

@@ -0,0 +1,107 @@
+package com.tchvu3.capacitorvoicerecorder;
+
+import android.content.Context;
+import android.media.MediaRecorder;
+import android.os.Build;
+import java.io.File;
+import java.io.IOException;
+
+public class CustomMediaRecorder {
+
+    private final Context context;
+    private MediaRecorder mediaRecorder;
+    private File outputFile;
+    private CurrentRecordingStatus currentRecordingStatus = CurrentRecordingStatus.NONE;
+
+    public CustomMediaRecorder(Context context) throws IOException {
+        this.context = context;
+        generateMediaRecorder();
+    }
+
+    private void generateMediaRecorder() throws IOException {
+        mediaRecorder = new MediaRecorder();
+        mediaRecorder.setAudioSource(MediaRecorder.AudioSource.MIC);
+        mediaRecorder.setOutputFormat(MediaRecorder.OutputFormat.AAC_ADTS);
+        mediaRecorder.setAudioEncoder(MediaRecorder.AudioEncoder.AAC);
+        mediaRecorder.setAudioEncodingBitRate(96000);
+        mediaRecorder.setAudioSamplingRate(44100);
+        setRecorderOutputFile();
+        mediaRecorder.prepare();
+    }
+
+    private void setRecorderOutputFile() throws IOException {
+        File outputDir = context.getCacheDir();
+        outputFile = File.createTempFile("voice_record_temp", ".aac", outputDir);
+        outputFile.deleteOnExit();
+        mediaRecorder.setOutputFile(outputFile.getAbsolutePath());
+    }
+
+    public void startRecording() {
+        mediaRecorder.start();
+        currentRecordingStatus = CurrentRecordingStatus.RECORDING;
+    }
+
+    public void stopRecording() {
+        mediaRecorder.stop();
+        mediaRecorder.release();
+        currentRecordingStatus = CurrentRecordingStatus.NONE;
+    }
+
+    public File getOutputFile() {
+        return outputFile;
+    }
+
+    public boolean pauseRecording() throws NotSupportedOsVersion {
+        if (Build.VERSION.SDK_INT < Build.VERSION_CODES.N) {
+            throw new NotSupportedOsVersion();
+        }
+
+        if (currentRecordingStatus == CurrentRecordingStatus.RECORDING) {
+            mediaRecorder.pause();
+            currentRecordingStatus = CurrentRecordingStatus.PAUSED;
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    public boolean resumeRecording() throws NotSupportedOsVersion {
+        if (Build.VERSION.SDK_INT < Build.VERSION_CODES.N) {
+            throw new NotSupportedOsVersion();
+        }
+
+        if (currentRecordingStatus == CurrentRecordingStatus.PAUSED) {
+            mediaRecorder.resume();
+            currentRecordingStatus = CurrentRecordingStatus.RECORDING;
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    public CurrentRecordingStatus getCurrentStatus() {
+        return currentRecordingStatus;
+    }
+
+    public boolean deleteOutputFile() {
+        return outputFile.delete();
+    }
+
+    public static boolean canPhoneCreateMediaRecorder(Context context) {
+        return true;
+    }
+
+    private static boolean canPhoneCreateMediaRecorderWhileHavingPermission(Context context) {
+        CustomMediaRecorder tempMediaRecorder = null;
+        try {
+            tempMediaRecorder = new CustomMediaRecorder(context);
+            tempMediaRecorder.startRecording();
+            tempMediaRecorder.stopRecording();
+            return true;
+        } catch (Exception exp) {
+            return exp.getMessage().startsWith("stop failed");
+        } finally {
+            if (tempMediaRecorder != null) tempMediaRecorder.deleteOutputFile();
+        }
+    }
+}

package/android/src/main/java/com/tchvu3/capacitorvoicerecorder/Messages.java

@@ -0,0 +1,14 @@
+package com.tchvu3.capacitorvoicerecorder;
+
+public abstract class Messages {
+
+    public static final String MISSING_PERMISSION = "MISSING_PERMISSION";
+    public static final String CANNOT_RECORD_ON_THIS_PHONE = "CANNOT_RECORD_ON_THIS_PHONE";
+    public static final String FAILED_TO_RECORD = "FAILED_TO_RECORD";
+    public static final String RECORDING_HAS_NOT_STARTED = "RECORDING_HAS_NOT_STARTED";
+    public static final String FAILED_TO_FETCH_RECORDING = "FAILED_TO_FETCH_RECORDING";
+    public static final String NOT_SUPPORTED_OS_VERSION = "NOT_SUPPORTED_OS_VERSION";
+    public static final String ALREADY_RECORDING = "ALREADY_RECORDING";
+    public static final String EMPTY_RECORDING = "EMPTY_RECORDING";
+    public static final String MICROPHONE_BEING_USED = "MICROPHONE_BEING_USED";
+}

package/android/src/main/java/com/tchvu3/capacitorvoicerecorder/NotSupportedOsVersion.java

@@ -0,0 +1,3 @@
+package com.tchvu3.capacitorvoicerecorder;
+
+public class NotSupportedOsVersion extends Exception {}

package/android/src/main/java/com/tchvu3/capacitorvoicerecorder/RecordData.java

@@ -0,0 +1,50 @@
+package com.tchvu3.capacitorvoicerecorder;
+
+import com.getcapacitor.JSObject;
+
+public class RecordData {
+
+    private String recordDataBase64;
+    private String mimeType;
+    private int msDuration;
+
+    public RecordData() {}
+
+    public RecordData(String recordDataBase64, int msDuration, String mimeType) {
+        this.recordDataBase64 = recordDataBase64;
+        this.msDuration = msDuration;
+        this.mimeType = mimeType;
+    }
+
+    public String getRecordDataBase64() {
+        return recordDataBase64;
+    }
+
+    public void setRecordDataBase64(String recordDataBase64) {
+        this.recordDataBase64 = recordDataBase64;
+    }
+
+    public int getMsDuration() {
+        return msDuration;
+    }
+
+    public void setMsDuration(int msDuration) {
+        this.msDuration = msDuration;
+    }
+
+    public String getMimeType() {
+        return mimeType;
+    }
+
+    public void setMimeType(String mimeType) {
+        this.mimeType = mimeType;
+    }
+
+    public JSObject toJSObject() {
+        JSObject toReturn = new JSObject();
+        toReturn.put("recordDataBase64", recordDataBase64);
+        toReturn.put("msDuration", msDuration);
+        toReturn.put("mimeType", mimeType);
+        return toReturn;
+    }
+}

package/android/src/main/java/com/tchvu3/capacitorvoicerecorder/ResponseGenerator.java

@@ -0,0 +1,37 @@
+package com.tchvu3.capacitorvoicerecorder;
+
+import com.getcapacitor.JSObject;
+
+public class ResponseGenerator {
+
+    private static final String VALUE_RESPONSE_KEY = "value";
+    private static final String STATUS_RESPONSE_KEY = "status";
+
+    public static JSObject fromBoolean(boolean value) {
+        return value ? successResponse() : failResponse();
+    }
+
+    public static JSObject successResponse() {
+        JSObject success = new JSObject();
+        success.put(VALUE_RESPONSE_KEY, true);
+        return success;
+    }
+
+    public static JSObject failResponse() {
+        JSObject success = new JSObject();
+        success.put(VALUE_RESPONSE_KEY, false);
+        return success;
+    }
+
+    public static JSObject dataResponse(Object data) {
+        JSObject success = new JSObject();
+        success.put(VALUE_RESPONSE_KEY, data);
+        return success;
+    }
+
+    public static JSObject statusResponse(CurrentRecordingStatus status) {
+        JSObject success = new JSObject();
+        success.put(STATUS_RESPONSE_KEY, status.name());
+        return success;
+    }
+}