capacitor-plugin-recorder 0.0.1

package/dist/docs.json

@@ -0,0 +1,562 @@
+{
+  "api": {
+    "name": "RecorderPlayerPlugin",
+    "slug": "recorderplayerplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "requestPermission",
+        "signature": "() => Promise<PermissionStatus>",
+        "parameters": [],
+        "returns": "Promise<PermissionStatus>",
+        "tags": [],
+        "docs": "Request microphone permission",
+        "complexTypes": [
+          "PermissionStatus"
+        ],
+        "slug": "requestpermission"
+      },
+      {
+        "name": "checkPermission",
+        "signature": "() => Promise<PermissionStatus>",
+        "parameters": [],
+        "returns": "Promise<PermissionStatus>",
+        "tags": [],
+        "docs": "Check current permission status",
+        "complexTypes": [
+          "PermissionStatus"
+        ],
+        "slug": "checkpermission"
+      },
+      {
+        "name": "startRecord",
+        "signature": "(options?: StartRecordOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "StartRecordOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Start recording audio",
+        "complexTypes": [
+          "StartRecordOptions"
+        ],
+        "slug": "startrecord"
+      },
+      {
+        "name": "stopRecord",
+        "signature": "() => Promise<StopRecordResult>",
+        "parameters": [],
+        "returns": "Promise<StopRecordResult>",
+        "tags": [],
+        "docs": "Stop recording and return the recorded file path",
+        "complexTypes": [
+          "StopRecordResult"
+        ],
+        "slug": "stoprecord"
+      },
+      {
+        "name": "pauseRecord",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Pause the current recording",
+        "complexTypes": [],
+        "slug": "pauserecord"
+      },
+      {
+        "name": "resumeRecord",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Resume a paused recording",
+        "complexTypes": [],
+        "slug": "resumerecord"
+      },
+      {
+        "name": "preparePlay",
+        "signature": "(options: PlayOptions) => Promise<PreparePlayResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PlayOptions"
+          }
+        ],
+        "returns": "Promise<PreparePlayResult>",
+        "tags": [],
+        "docs": "Prepare an audio file for playback (loads metadata without playing).\nReturns a playerId that must be used for all subsequent operations on this player.",
+        "complexTypes": [
+          "PreparePlayResult",
+          "PlayOptions"
+        ],
+        "slug": "prepareplay"
+      },
+      {
+        "name": "play",
+        "signature": "(options: PlayerOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PlayerOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Start playing an audio file",
+        "complexTypes": [
+          "PlayerOptions"
+        ],
+        "slug": "play"
+      },
+      {
+        "name": "pausePlay",
+        "signature": "(options: PlayerOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PlayerOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Pause audio playback",
+        "complexTypes": [
+          "PlayerOptions"
+        ],
+        "slug": "pauseplay"
+      },
+      {
+        "name": "resumePlay",
+        "signature": "(options: PlayerOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PlayerOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Resume paused audio playback",
+        "complexTypes": [
+          "PlayerOptions"
+        ],
+        "slug": "resumeplay"
+      },
+      {
+        "name": "stopPlay",
+        "signature": "(options: PlayerOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PlayerOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Stop audio playback",
+        "complexTypes": [
+          "PlayerOptions"
+        ],
+        "slug": "stopplay"
+      },
+      {
+        "name": "seekTo",
+        "signature": "(options: SeekOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SeekOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Seek to a specific position in the audio",
+        "complexTypes": [
+          "SeekOptions"
+        ],
+        "slug": "seekto"
+      },
+      {
+        "name": "getPlaybackStatus",
+        "signature": "(options: PlayerOptions) => Promise<PlaybackStatusChangeEvent>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PlayerOptions"
+          }
+        ],
+        "returns": "Promise<PlaybackStatusChangeEvent>",
+        "tags": [],
+        "docs": "Get current playback status for a specific player",
+        "complexTypes": [
+          "PlaybackStatusChangeEvent",
+          "PlayerOptions"
+        ],
+        "slug": "getplaybackstatus"
+      },
+      {
+        "name": "getRecordingStatus",
+        "signature": "() => Promise<RecordingStatusChangeEvent>",
+        "parameters": [],
+        "returns": "Promise<RecordingStatusChangeEvent>",
+        "tags": [],
+        "docs": "Get current recording status",
+        "complexTypes": [
+          "RecordingStatusChangeEvent"
+        ],
+        "slug": "getrecordingstatus"
+      },
+      {
+        "name": "destroyPlayer",
+        "signature": "(options: PlayerOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PlayerOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Destroy a player and release its resources",
+        "complexTypes": [
+          "PlayerOptions"
+        ],
+        "slug": "destroyplayer"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'recordingStatusChange', listenerFunc: (event: RecordingStatusChangeEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'recordingStatusChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: RecordingStatusChangeEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "Listen for recording status changes",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "RecordingStatusChangeEvent"
+        ],
+        "slug": "addlistenerrecordingstatuschange-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'playbackStatusChange', listenerFunc: (event: PlaybackStatusChangeEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'playbackStatusChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: PlaybackStatusChangeEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "Listen for playback status changes (includes playerId to identify which player)",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "PlaybackStatusChangeEvent"
+        ],
+        "slug": "addlistenerplaybackstatuschange-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Remove all listeners",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "PermissionStatus",
+      "slug": "permissionstatus",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "microphone",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "'granted' | 'denied' | 'prompt'"
+        }
+      ]
+    },
+    {
+      "name": "StartRecordOptions",
+      "slug": "startrecordoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "path",
+          "tags": [],
+          "docs": "Optional relative path for the recording (including extension), relative to the app's data directory. If not provided, a default filename will be used.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "StopRecordResult",
+      "slug": "stoprecordresult",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "path",
+          "tags": [],
+          "docs": "Path to the recorded file",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "duration",
+          "tags": [],
+          "docs": "Duration of the recording in milliseconds",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "PreparePlayResult",
+      "slug": "prepareplayresult",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "playerId",
+          "tags": [],
+          "docs": "Unique identifier for this player instance",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "duration",
+          "tags": [],
+          "docs": "Duration of the audio in milliseconds",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "PlayOptions",
+      "slug": "playoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "path",
+          "tags": [],
+          "docs": "Relative path to the audio file to play (relative to the app's data directory)",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PlayerOptions",
+      "slug": "playeroptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "playerId",
+          "tags": [],
+          "docs": "The player ID returned from preparePlay",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "SeekOptions",
+      "slug": "seekoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "playerId",
+          "tags": [],
+          "docs": "The player ID returned from preparePlay",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "position",
+          "tags": [],
+          "docs": "Position to seek to in milliseconds",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "PlaybackStatusChangeEvent",
+      "slug": "playbackstatuschangeevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "playerId",
+          "tags": [],
+          "docs": "The player ID this event belongs to",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "status",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "PlaybackStatus"
+          ],
+          "type": "PlaybackStatus"
+        },
+        {
+          "name": "currentPosition",
+          "tags": [],
+          "docs": "Current playback position in milliseconds",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "duration",
+          "tags": [],
+          "docs": "Total duration of the audio in milliseconds",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "RecordingStatusChangeEvent",
+      "slug": "recordingstatuschangeevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "status",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "RecordingStatus"
+          ],
+          "type": "RecordingStatus"
+        },
+        {
+          "name": "duration",
+          "tags": [],
+          "docs": "Current recording duration in milliseconds",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "PlaybackStatus",
+      "slug": "playbackstatus",
+      "docs": "",
+      "types": [
+        {
+          "text": "'playing'",
+          "complexTypes": []
+        },
+        {
+          "text": "'paused'",
+          "complexTypes": []
+        },
+        {
+          "text": "'stopped'",
+          "complexTypes": []
+        },
+        {
+          "text": "'ended'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "RecordingStatus",
+      "slug": "recordingstatus",
+      "docs": "",
+      "types": [
+        {
+          "text": "'recording'",
+          "complexTypes": []
+        },
+        {
+          "text": "'paused'",
+          "complexTypes": []
+        },
+        {
+          "text": "'stopped'",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,125 @@
+import type { PluginListenerHandle } from '@capacitor/core';
+export type RecordingStatus = 'recording' | 'paused' | 'stopped';
+export type PlaybackStatus = 'playing' | 'paused' | 'stopped' | 'ended';
+export interface StartRecordOptions {
+    /** Optional relative path for the recording (including extension), relative to the app's data directory. If not provided, a default filename will be used. */
+    path?: string;
+}
+export interface StopRecordResult {
+    /** Path to the recorded file */
+    path: string;
+    /** Duration of the recording in milliseconds */
+    duration: number;
+}
+export interface PlayOptions {
+    /** Relative path to the audio file to play (relative to the app's data directory) */
+    path: string;
+}
+export interface PreparePlayResult {
+    /** Unique identifier for this player instance */
+    playerId: string;
+    /** Duration of the audio in milliseconds */
+    duration: number;
+}
+export interface PlayerOptions {
+    /** The player ID returned from preparePlay */
+    playerId: string;
+}
+export interface SeekOptions {
+    /** The player ID returned from preparePlay */
+    playerId: string;
+    /** Position to seek to in milliseconds */
+    position: number;
+}
+export interface RecordingStatusChangeEvent {
+    status: RecordingStatus;
+    /** Current recording duration in milliseconds */
+    duration: number;
+}
+export interface PlaybackStatusChangeEvent {
+    /** The player ID this event belongs to */
+    playerId: string;
+    status: PlaybackStatus;
+    /** Current playback position in milliseconds */
+    currentPosition: number;
+    /** Total duration of the audio in milliseconds */
+    duration: number;
+}
+export interface PermissionStatus {
+    microphone: 'granted' | 'denied' | 'prompt';
+}
+export interface RecorderPlayerPlugin {
+    /**
+     * Request microphone permission
+     */
+    requestPermission(): Promise<PermissionStatus>;
+    /**
+     * Check current permission status
+     */
+    checkPermission(): Promise<PermissionStatus>;
+    /**
+     * Start recording audio
+     */
+    startRecord(options?: StartRecordOptions): Promise<void>;
+    /**
+     * Stop recording and return the recorded file path
+     */
+    stopRecord(): Promise<StopRecordResult>;
+    /**
+     * Pause the current recording
+     */
+    pauseRecord(): Promise<void>;
+    /**
+     * Resume a paused recording
+     */
+    resumeRecord(): Promise<void>;
+    /**
+     * Prepare an audio file for playback (loads metadata without playing).
+     * Returns a playerId that must be used for all subsequent operations on this player.
+     */
+    preparePlay(options: PlayOptions): Promise<PreparePlayResult>;
+    /**
+     * Start playing an audio file
+     */
+    play(options: PlayerOptions): Promise<void>;
+    /**
+     * Pause audio playback
+     */
+    pausePlay(options: PlayerOptions): Promise<void>;
+    /**
+     * Resume paused audio playback
+     */
+    resumePlay(options: PlayerOptions): Promise<void>;
+    /**
+     * Stop audio playback
+     */
+    stopPlay(options: PlayerOptions): Promise<void>;
+    /**
+     * Seek to a specific position in the audio
+     */
+    seekTo(options: SeekOptions): Promise<void>;
+    /**
+     * Get current playback status for a specific player
+     */
+    getPlaybackStatus(options: PlayerOptions): Promise<PlaybackStatusChangeEvent>;
+    /**
+     * Get current recording status
+     */
+    getRecordingStatus(): Promise<RecordingStatusChangeEvent>;
+    /**
+     * Destroy a player and release its resources
+     */
+    destroyPlayer(options: PlayerOptions): Promise<void>;
+    /**
+     * Listen for recording status changes
+     */
+    addListener(eventName: 'recordingStatusChange', listenerFunc: (event: RecordingStatusChangeEvent) => void): Promise<PluginListenerHandle>;
+    /**
+     * Listen for playback status changes (includes playerId to identify which player)
+     */
+    addListener(eventName: 'playbackStatusChange', listenerFunc: (event: PlaybackStatusChangeEvent) => void): Promise<PluginListenerHandle>;
+    /**
+     * Remove all listeners
+     */
+    removeAllListeners(): Promise<void>;
+}

package/dist/esm/definitions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nexport type RecordingStatus = 'recording' | 'paused' | 'stopped';\nexport type PlaybackStatus = 'playing' | 'paused' | 'stopped' | 'ended';\n\nexport interface StartRecordOptions {\n  /** Optional relative path for the recording (including extension), relative to the app's data directory. If not provided, a default filename will be used. */\n  path?: string;\n}\n\nexport interface StopRecordResult {\n  /** Path to the recorded file */\n  path: string;\n  /** Duration of the recording in milliseconds */\n  duration: number;\n}\n\nexport interface PlayOptions {\n  /** Relative path to the audio file to play (relative to the app's data directory) */\n  path: string;\n}\n\nexport interface PreparePlayResult {\n  /** Unique identifier for this player instance */\n  playerId: string;\n  /** Duration of the audio in milliseconds */\n  duration: number;\n}\n\nexport interface PlayerOptions {\n  /** The player ID returned from preparePlay */\n  playerId: string;\n}\n\nexport interface SeekOptions {\n  /** The player ID returned from preparePlay */\n  playerId: string;\n  /** Position to seek to in milliseconds */\n  position: number;\n}\n\nexport interface RecordingStatusChangeEvent {\n  status: RecordingStatus;\n  /** Current recording duration in milliseconds */\n  duration: number;\n}\n\nexport interface PlaybackStatusChangeEvent {\n  /** The player ID this event belongs to */\n  playerId: string;\n  status: PlaybackStatus;\n  /** Current playback position in milliseconds */\n  currentPosition: number;\n  /** Total duration of the audio in milliseconds */\n  duration: number;\n}\n\nexport interface PermissionStatus {\n  microphone: 'granted' | 'denied' | 'prompt';\n}\n\nexport interface RecorderPlayerPlugin {\n  /**\n   * Request microphone permission\n   */\n  requestPermission(): Promise<PermissionStatus>;\n\n  /**\n   * Check current permission status\n   */\n  checkPermission(): Promise<PermissionStatus>;\n\n  /**\n   * Start recording audio\n   */\n  startRecord(options?: StartRecordOptions): Promise<void>;\n\n  /**\n   * Stop recording and return the recorded file path\n   */\n  stopRecord(): Promise<StopRecordResult>;\n\n  /**\n   * Pause the current recording\n   */\n  pauseRecord(): Promise<void>;\n\n  /**\n   * Resume a paused recording\n   */\n  resumeRecord(): Promise<void>;\n\n  /**\n   * Prepare an audio file for playback (loads metadata without playing).\n   * Returns a playerId that must be used for all subsequent operations on this player.\n   */\n  preparePlay(options: PlayOptions): Promise<PreparePlayResult>;\n\n  /**\n   * Start playing an audio file\n   */\n  play(options: PlayerOptions): Promise<void>;\n\n  /**\n   * Pause audio playback\n   */\n  pausePlay(options: PlayerOptions): Promise<void>;\n\n  /**\n   * Resume paused audio playback\n   */\n  resumePlay(options: PlayerOptions): Promise<void>;\n\n  /**\n   * Stop audio playback\n   */\n  stopPlay(options: PlayerOptions): Promise<void>;\n\n  /**\n   * Seek to a specific position in the audio\n   */\n  seekTo(options: SeekOptions): Promise<void>;\n\n  /**\n   * Get current playback status for a specific player\n   */\n  getPlaybackStatus(options: PlayerOptions): Promise<PlaybackStatusChangeEvent>;\n\n  /**\n   * Get current recording status\n   */\n  getRecordingStatus(): Promise<RecordingStatusChangeEvent>;\n\n  /**\n   * Destroy a player and release its resources\n   */\n  destroyPlayer(options: PlayerOptions): Promise<void>;\n\n  /**\n   * Listen for recording status changes\n   */\n  addListener(\n    eventName: 'recordingStatusChange',\n    listenerFunc: (event: RecordingStatusChangeEvent) => void\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Listen for playback status changes (includes playerId to identify which player)\n   */\n  addListener(\n    eventName: 'playbackStatusChange',\n    listenerFunc: (event: PlaybackStatusChangeEvent) => void\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Remove all listeners\n   */\n  removeAllListeners(): Promise<void>;\n}\n"]}