@scr2em/capacitor-plugin-recorder 0.0.1

package/CapacitorPluginRecorder.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapacitorPluginRecorder'
+  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/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target = '15.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

package/Package.swift

@@ -0,0 +1,28 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "CapacitorPluginRecorder",
+    platforms: [.iOS(.v15)],
+    products: [
+        .library(
+            name: "CapacitorPluginRecorder",
+            targets: ["RecorderPlayerPlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "8.0.0")
+    ],
+    targets: [
+        .target(
+            name: "RecorderPlayerPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm")
+            ],
+            path: "ios/Sources/RecorderPlayerPlugin"),
+        .testTarget(
+            name: "RecorderPlayerPluginTests",
+            dependencies: ["RecorderPlayerPlugin"],
+            path: "ios/Tests/RecorderPlayerPluginTests")
+    ]
+)

package/README.md

@@ -0,0 +1,395 @@
+# capacitor-plugin-recorder
+
+ee
+
+## Install
+
+```bash
+npm install capacitor-plugin-recorder
+npx cap sync
+```
+
+## API
+
+<docgen-index>
+
+* [`requestPermission()`](#requestpermission)
+* [`checkPermission()`](#checkpermission)
+* [`startRecord(...)`](#startrecord)
+* [`stopRecord()`](#stoprecord)
+* [`pauseRecord()`](#pauserecord)
+* [`resumeRecord()`](#resumerecord)
+* [`preparePlay(...)`](#prepareplay)
+* [`play(...)`](#play)
+* [`pausePlay(...)`](#pauseplay)
+* [`resumePlay(...)`](#resumeplay)
+* [`stopPlay(...)`](#stopplay)
+* [`seekTo(...)`](#seekto)
+* [`getPlaybackStatus(...)`](#getplaybackstatus)
+* [`getRecordingStatus()`](#getrecordingstatus)
+* [`destroyPlayer(...)`](#destroyplayer)
+* [`addListener('recordingStatusChange', ...)`](#addlistenerrecordingstatuschange-)
+* [`addListener('playbackStatusChange', ...)`](#addlistenerplaybackstatuschange-)
+* [`removeAllListeners()`](#removealllisteners)
+* [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### requestPermission()
+
+```typescript
+requestPermission() => Promise<PermissionStatus>
+```
+
+Request microphone permission
+
+**Returns:** <code>Promise&lt;<a href="#permissionstatus">PermissionStatus</a>&gt;</code>
+
+--------------------
+
+
+### checkPermission()
+
+```typescript
+checkPermission() => Promise<PermissionStatus>
+```
+
+Check current permission status
+
+**Returns:** <code>Promise&lt;<a href="#permissionstatus">PermissionStatus</a>&gt;</code>
+
+--------------------
+
+
+### startRecord(...)
+
+```typescript
+startRecord(options?: StartRecordOptions | undefined) => Promise<void>
+```
+
+Start recording audio
+
+| Param         | Type                                                              |
+| ------------- | ----------------------------------------------------------------- |
+| **`options`** | <code><a href="#startrecordoptions">StartRecordOptions</a></code> |
+
+--------------------
+
+
+### stopRecord()
+
+```typescript
+stopRecord() => Promise<StopRecordResult>
+```
+
+Stop recording and return the recorded file path
+
+**Returns:** <code>Promise&lt;<a href="#stoprecordresult">StopRecordResult</a>&gt;</code>
+
+--------------------
+
+
+### pauseRecord()
+
+```typescript
+pauseRecord() => Promise<void>
+```
+
+Pause the current recording
+
+--------------------
+
+
+### resumeRecord()
+
+```typescript
+resumeRecord() => Promise<void>
+```
+
+Resume a paused recording
+
+--------------------
+
+
+### preparePlay(...)
+
+```typescript
+preparePlay(options: PlayOptions) => Promise<PreparePlayResult>
+```
+
+Prepare an audio file for playback (loads metadata without playing).
+Returns a playerId that must be used for all subsequent operations on this player.
+
+| Param         | Type                                                |
+| ------------- | --------------------------------------------------- |
+| **`options`** | <code><a href="#playoptions">PlayOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#prepareplayresult">PreparePlayResult</a>&gt;</code>
+
+--------------------
+
+
+### play(...)
+
+```typescript
+play(options: PlayerOptions) => Promise<void>
+```
+
+Start playing an audio file
+
+| Param         | Type                                                    |
+| ------------- | ------------------------------------------------------- |
+| **`options`** | <code><a href="#playeroptions">PlayerOptions</a></code> |
+
+--------------------
+
+
+### pausePlay(...)
+
+```typescript
+pausePlay(options: PlayerOptions) => Promise<void>
+```
+
+Pause audio playback
+
+| Param         | Type                                                    |
+| ------------- | ------------------------------------------------------- |
+| **`options`** | <code><a href="#playeroptions">PlayerOptions</a></code> |
+
+--------------------
+
+
+### resumePlay(...)
+
+```typescript
+resumePlay(options: PlayerOptions) => Promise<void>
+```
+
+Resume paused audio playback
+
+| Param         | Type                                                    |
+| ------------- | ------------------------------------------------------- |
+| **`options`** | <code><a href="#playeroptions">PlayerOptions</a></code> |
+
+--------------------
+
+
+### stopPlay(...)
+
+```typescript
+stopPlay(options: PlayerOptions) => Promise<void>
+```
+
+Stop audio playback
+
+| Param         | Type                                                    |
+| ------------- | ------------------------------------------------------- |
+| **`options`** | <code><a href="#playeroptions">PlayerOptions</a></code> |
+
+--------------------
+
+
+### seekTo(...)
+
+```typescript
+seekTo(options: SeekOptions) => Promise<void>
+```
+
+Seek to a specific position in the audio
+
+| Param         | Type                                                |
+| ------------- | --------------------------------------------------- |
+| **`options`** | <code><a href="#seekoptions">SeekOptions</a></code> |
+
+--------------------
+
+
+### getPlaybackStatus(...)
+
+```typescript
+getPlaybackStatus(options: PlayerOptions) => Promise<PlaybackStatusChangeEvent>
+```
+
+Get current playback status for a specific player
+
+| Param         | Type                                                    |
+| ------------- | ------------------------------------------------------- |
+| **`options`** | <code><a href="#playeroptions">PlayerOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#playbackstatuschangeevent">PlaybackStatusChangeEvent</a>&gt;</code>
+
+--------------------
+
+
+### getRecordingStatus()
+
+```typescript
+getRecordingStatus() => Promise<RecordingStatusChangeEvent>
+```
+
+Get current recording status
+
+**Returns:** <code>Promise&lt;<a href="#recordingstatuschangeevent">RecordingStatusChangeEvent</a>&gt;</code>
+
+--------------------
+
+
+### destroyPlayer(...)
+
+```typescript
+destroyPlayer(options: PlayerOptions) => Promise<void>
+```
+
+Destroy a player and release its resources
+
+| Param         | Type                                                    |
+| ------------- | ------------------------------------------------------- |
+| **`options`** | <code><a href="#playeroptions">PlayerOptions</a></code> |
+
+--------------------
+
+
+### addListener('recordingStatusChange', ...)
+
+```typescript
+addListener(eventName: 'recordingStatusChange', listenerFunc: (event: RecordingStatusChangeEvent) => void) => Promise<PluginListenerHandle>
+```
+
+Listen for recording status changes
+
+| Param              | Type                                                                                                  |
+| ------------------ | ----------------------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'recordingStatusChange'</code>                                                                  |
+| **`listenerFunc`** | <code>(event: <a href="#recordingstatuschangeevent">RecordingStatusChangeEvent</a>) =&gt; void</code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
+### addListener('playbackStatusChange', ...)
+
+```typescript
+addListener(eventName: 'playbackStatusChange', listenerFunc: (event: PlaybackStatusChangeEvent) => void) => Promise<PluginListenerHandle>
+```
+
+Listen for playback status changes (includes playerId to identify which player)
+
+| Param              | Type                                                                                                |
+| ------------------ | --------------------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'playbackStatusChange'</code>                                                                 |
+| **`listenerFunc`** | <code>(event: <a href="#playbackstatuschangeevent">PlaybackStatusChangeEvent</a>) =&gt; void</code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
+### removeAllListeners()
+
+```typescript
+removeAllListeners() => Promise<void>
+```
+
+Remove all listeners
+
+--------------------
+
+
+### Interfaces
+
+
+#### PermissionStatus
+
+| Prop             | Type                                           |
+| ---------------- | ---------------------------------------------- |
+| **`microphone`** | <code>'granted' \| 'denied' \| 'prompt'</code> |
+
+
+#### StartRecordOptions
+
+| Prop       | Type                | Description                                                                                                                                             |
+| ---------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`path`** | <code>string</code> | Optional relative path for the recording (including extension), relative to the app's data directory. If not provided, a default filename will be used. |
+
+
+#### StopRecordResult
+
+| Prop           | Type                | Description                               |
+| -------------- | ------------------- | ----------------------------------------- |
+| **`path`**     | <code>string</code> | Path to the recorded file                 |
+| **`duration`** | <code>number</code> | Duration of the recording in milliseconds |
+
+
+#### PreparePlayResult
+
+| Prop           | Type                | Description                                |
+| -------------- | ------------------- | ------------------------------------------ |
+| **`playerId`** | <code>string</code> | Unique identifier for this player instance |
+| **`duration`** | <code>number</code> | Duration of the audio in milliseconds      |
+
+
+#### PlayOptions
+
+| Prop       | Type                | Description                                                                    |
+| ---------- | ------------------- | ------------------------------------------------------------------------------ |
+| **`path`** | <code>string</code> | Relative path to the audio file to play (relative to the app's data directory) |
+
+
+#### PlayerOptions
+
+| Prop           | Type                | Description                             |
+| -------------- | ------------------- | --------------------------------------- |
+| **`playerId`** | <code>string</code> | The player ID returned from preparePlay |
+
+
+#### SeekOptions
+
+| Prop           | Type                | Description                             |
+| -------------- | ------------------- | --------------------------------------- |
+| **`playerId`** | <code>string</code> | The player ID returned from preparePlay |
+| **`position`** | <code>number</code> | Position to seek to in milliseconds     |
+
+
+#### PlaybackStatusChangeEvent
+
+| Prop                  | Type                                                      | Description                                 |
+| --------------------- | --------------------------------------------------------- | ------------------------------------------- |
+| **`playerId`**        | <code>string</code>                                       | The player ID this event belongs to         |
+| **`status`**          | <code><a href="#playbackstatus">PlaybackStatus</a></code> |                                             |
+| **`currentPosition`** | <code>number</code>                                       | Current playback position in milliseconds   |
+| **`duration`**        | <code>number</code>                                       | Total duration of the audio in milliseconds |
+
+
+#### RecordingStatusChangeEvent
+
+| Prop           | Type                                                        | Description                                |
+| -------------- | ----------------------------------------------------------- | ------------------------------------------ |
+| **`status`**   | <code><a href="#recordingstatus">RecordingStatus</a></code> |                                            |
+| **`duration`** | <code>number</code>                                         | Current recording duration in milliseconds |
+
+
+#### PluginListenerHandle
+
+| Prop         | Type                                      |
+| ------------ | ----------------------------------------- |
+| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
+
+
+### Type Aliases
+
+
+#### PlaybackStatus
+
+<code>'playing' | 'paused' | 'stopped' | 'ended'</code>
+
+
+#### RecordingStatus
+
+<code>'recording' | 'paused' | 'stopped'</code>
+
+</docgen-api>

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.7.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.3.0'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.7.0'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.13.0'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace = "com.capacitor.recorderplayer"
+    compileSdk = project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 36
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 24
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 36
+        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_21
+        targetCompatibility JavaVersion.VERSION_21
+    }
+}
+
+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,3 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <uses-permission android:name="android.permission.RECORD_AUDIO" />
+</manifest>