@capgo/capacitor-screen-recorder 7.2.6 → 7.3.0

package/README.md

@@ -2,8 +2,8 @@
  <a href="https://capgo.app/"><img src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/></a>
 
 <div align="center">
-  <h2><a href="https://capgo.app/?ref=plugin"> ➡️ Get Instant updates for your App with Capgo</a></h2>
-  <h2><a href="https://capgo.app/consulting/?ref=plugin"> Missing a feature? We’ll build the plugin for you 💪</a></h2>
+  <h2><a href="https://capgo.app/?ref=plugin_screen_recorder"> ➡️ Get Instant updates for your App with Capgo</a></h2>
+  <h2><a href="https://capgo.app/consulting/?ref=plugin_screen_recorder"> Missing a feature? We’ll build the plugin for you 💪</a></h2>
 </div>
 Record device's screen
 
@@ -85,17 +85,27 @@ No configuration required for this plugin.
 <docgen-api>
 <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
 
+Capacitor Screen Recorder Plugin for recording the device screen.
+Allows you to capture video recordings of the screen with optional audio.
+
 ### start(...)
 
 ```typescript
 start(options?: { recordAudio?: boolean | undefined; } | undefined) => Promise<void>
 ```
 
-start the recording
+Start recording the device screen.
+
+Initiates screen recording with optional audio capture. The user will be
+prompted to grant screen recording permissions if not already granted.
+On iOS, the system recording UI will be displayed. On Android, the recording
+starts immediately after permission is granted.
+
+| Param         | Type                                    | Description                       |
+| ------------- | --------------------------------------- | --------------------------------- |
+| **`options`** | <code>{ recordAudio?: boolean; }</code> | - Recording configuration options |
 
-| Param         | Type                                    | Description       |
-| ------------- | --------------------------------------- | ----------------- |
-| **`options`** | <code>{ recordAudio?: boolean; }</code> | Recording options |
+**Since:** 1.0.0
 
 --------------------
 
@@ -106,7 +116,13 @@ start the recording
 stop() => Promise<void>
 ```
 
-stop the recording
+Stop the current screen recording.
+
+Stops the active screen recording and saves the video to the device's
+camera roll or gallery. On iOS, the system will show a preview of the
+recording. On Android, the video is saved directly to the gallery.
+
+**Since:** 1.0.0
 
 --------------------
 
@@ -117,10 +133,12 @@ stop the recording
 getPluginVersion() => Promise<{ version: string; }>
 ```
 
-Get the native Capacitor plugin version
+Get the native Capacitor plugin version.
 
 **Returns:** <code>Promise&lt;{ version: string; }&gt;</code>
 
+**Since:** 1.0.0
+
 --------------------
 
 </docgen-api>

package/android/src/main/java/ee/forgr/plugin/screenrecorder/ScreenRecorderPlugin.java

@@ -11,7 +11,7 @@ import dev.bmcreations.scrcast.config.Options;
 @CapacitorPlugin(name = "ScreenRecorder")
 public class ScreenRecorderPlugin extends Plugin {
 
-    private final String PLUGIN_VERSION = "7.2.6";
+    private final String PLUGIN_VERSION = "7.3.0";
 
     private ScrCast recorder;
 

package/dist/docs.json

@@ -2,8 +2,13 @@
   "api": {
     "name": "ScreenRecorderPlugin",
     "slug": "screenrecorderplugin",
-    "docs": "",
-    "tags": [],
+    "docs": "Capacitor Screen Recorder Plugin for recording the device screen.\nAllows you to capture video recordings of the screen with optional audio.",
+    "tags": [
+      {
+        "text": "1.0.0",
+        "name": "since"
+      }
+    ],
     "methods": [
       {
         "name": "start",
@@ -11,7 +16,7 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "Recording options",
+            "docs": "- Recording configuration options",
             "type": "{ recordAudio?: boolean | undefined; } | undefined"
           }
         ],
@@ -19,10 +24,30 @@
         "tags": [
           {
             "name": "param",
-            "text": "options Recording options"
+            "text": "options - Recording configuration options"
+          },
+          {
+            "name": "param",
+            "text": "options.recordAudio - Whether to record audio along with the screen video. Defaults to false."
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when recording starts"
+          },
+          {
+            "name": "throws",
+            "text": "Error if recording fails to start or permissions are denied"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\n// Start recording without audio\nawait ScreenRecorder.start();\n\n// Start recording with audio\nawait ScreenRecorder.start({ recordAudio: true });\n```"
           }
         ],
-        "docs": "start the recording",
+        "docs": "Start recording the device screen.\n\nInitiates screen recording with optional audio capture. The user will be\nprompted to grant screen recording permissions if not already granted.\nOn iOS, the system recording UI will be displayed. On Android, the recording\nstarts immediately after permission is granted.",
         "complexTypes": [],
         "slug": "start"
       },
@@ -31,8 +56,25 @@
         "signature": "() => Promise<void>",
         "parameters": [],
         "returns": "Promise<void>",
-        "tags": [],
-        "docs": "stop the recording",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves when recording stops and the video is saved"
+          },
+          {
+            "name": "throws",
+            "text": "Error if stopping the recording fails or no recording is active"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait ScreenRecorder.stop();\nconsole.log('Recording saved to gallery');\n```"
+          }
+        ],
+        "docs": "Stop the current screen recording.\n\nStops the active screen recording and saves the video to the device's\ncamera roll or gallery. On iOS, the system will show a preview of the\nrecording. On Android, the video is saved directly to the gallery.",
         "complexTypes": [],
         "slug": "stop"
       },
@@ -44,14 +86,22 @@
         "tags": [
           {
             "name": "returns",
-            "text": "an Promise with version for this device"
+            "text": "Promise that resolves with the plugin version"
           },
           {
             "name": "throws",
-            "text": "An error if the something went wrong"
+            "text": "Error if getting the version fails"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { version } = await ScreenRecorder.getPluginVersion();\nconsole.log('Plugin version:', version);\n```"
           }
         ],
-        "docs": "Get the native Capacitor plugin version",
+        "docs": "Get the native Capacitor plugin version.",
         "complexTypes": [],
         "slug": "getpluginversion"
       }

package/dist/esm/definitions.d.ts

@@ -1,20 +1,63 @@
+/**
+ * Capacitor Screen Recorder Plugin for recording the device screen.
+ * Allows you to capture video recordings of the screen with optional audio.
+ *
+ * @since 1.0.0
+ */
 export interface ScreenRecorderPlugin {
     /**
-     * start the recording
-     * @param options Recording options
+     * Start recording the device screen.
+     *
+     * Initiates screen recording with optional audio capture. The user will be
+     * prompted to grant screen recording permissions if not already granted.
+     * On iOS, the system recording UI will be displayed. On Android, the recording
+     * starts immediately after permission is granted.
+     *
+     * @param options - Recording configuration options
+     * @param options.recordAudio - Whether to record audio along with the screen video. Defaults to false.
+     * @returns Promise that resolves when recording starts
+     * @throws Error if recording fails to start or permissions are denied
+     * @since 1.0.0
+     * @example
+     * ```typescript
+     * // Start recording without audio
+     * await ScreenRecorder.start();
+     *
+     * // Start recording with audio
+     * await ScreenRecorder.start({ recordAudio: true });
+     * ```
      */
     start(options?: {
         recordAudio?: boolean;
     }): Promise<void>;
     /**
-     * stop the recording
+     * Stop the current screen recording.
+     *
+     * Stops the active screen recording and saves the video to the device's
+     * camera roll or gallery. On iOS, the system will show a preview of the
+     * recording. On Android, the video is saved directly to the gallery.
+     *
+     * @returns Promise that resolves when recording stops and the video is saved
+     * @throws Error if stopping the recording fails or no recording is active
+     * @since 1.0.0
+     * @example
+     * ```typescript
+     * await ScreenRecorder.stop();
+     * console.log('Recording saved to gallery');
+     * ```
      */
     stop(): Promise<void>;
     /**
-     * Get the native Capacitor plugin version
+     * Get the native Capacitor plugin version.
      *
-     * @returns {Promise<{ id: string }>} an Promise with version for this device
-     * @throws An error if the something went wrong
+     * @returns Promise that resolves with the plugin version
+     * @throws Error if getting the version fails
+     * @since 1.0.0
+     * @example
+     * ```typescript
+     * const { version } = await ScreenRecorder.getPluginVersion();
+     * console.log('Plugin version:', version);
+     * ```
      */
     getPluginVersion(): Promise<{
         version: string;

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export interface ScreenRecorderPlugin {\n  /**\n   * start the recording\n   * @param options Recording options\n   */\n  start(options?: { recordAudio?: boolean }): Promise<void>;\n  /**\n   * stop the recording\n   */\n  stop(): Promise<void>;\n\n  /**\n   * Get the native Capacitor plugin version\n   *\n   * @returns {Promise<{ id: string }>} an Promise with version for this device\n   * @throws An error if the something went wrong\n   */\n  getPluginVersion(): Promise<{ version: string }>;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Capacitor Screen Recorder Plugin for recording the device screen.\n * Allows you to capture video recordings of the screen with optional audio.\n *\n * @since 1.0.0\n */\nexport interface ScreenRecorderPlugin {\n  /**\n   * Start recording the device screen.\n   *\n   * Initiates screen recording with optional audio capture. The user will be\n   * prompted to grant screen recording permissions if not already granted.\n   * On iOS, the system recording UI will be displayed. On Android, the recording\n   * starts immediately after permission is granted.\n   *\n   * @param options - Recording configuration options\n   * @param options.recordAudio - Whether to record audio along with the screen video. Defaults to false.\n   * @returns Promise that resolves when recording starts\n   * @throws Error if recording fails to start or permissions are denied\n   * @since 1.0.0\n   * @example\n   * ```typescript\n   * // Start recording without audio\n   * await ScreenRecorder.start();\n   *\n   * // Start recording with audio\n   * await ScreenRecorder.start({ recordAudio: true });\n   * ```\n   */\n  start(options?: { recordAudio?: boolean }): Promise<void>;\n\n  /**\n   * Stop the current screen recording.\n   *\n   * Stops the active screen recording and saves the video to the device's\n   * camera roll or gallery. On iOS, the system will show a preview of the\n   * recording. On Android, the video is saved directly to the gallery.\n   *\n   * @returns Promise that resolves when recording stops and the video is saved\n   * @throws Error if stopping the recording fails or no recording is active\n   * @since 1.0.0\n   * @example\n   * ```typescript\n   * await ScreenRecorder.stop();\n   * console.log('Recording saved to gallery');\n   * ```\n   */\n  stop(): Promise<void>;\n\n  /**\n   * Get the native Capacitor plugin version.\n   *\n   * @returns Promise that resolves with the plugin version\n   * @throws Error if getting the version fails\n   * @since 1.0.0\n   * @example\n   * ```typescript\n   * const { version } = await ScreenRecorder.getPluginVersion();\n   * console.log('Plugin version:', version);\n   * ```\n   */\n  getPluginVersion(): Promise<{ version: string }>;\n}\n"]}

package/ios/Sources/ScreenRecorderPlugin/ScreenRecorderPlugin.swift

@@ -7,7 +7,7 @@ import Capacitor
  */
 @objc(ScreenRecorderPlugin)
 public class ScreenRecorderPlugin: CAPPlugin, CAPBridgedPlugin {
-    private let PLUGIN_VERSION: String = "7.2.6"
+    private let PLUGIN_VERSION: String = "7.3.0"
     public let identifier = "ScreenRecorderPlugin"
     public let jsName = "ScreenRecorder"
     public let pluginMethods: [CAPPluginMethod] = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-screen-recorder",
-  "version": "7.2.6",
+  "version": "7.3.0",
   "description": "Record device's screen",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -27,7 +27,15 @@
   "keywords": [
     "capacitor",
     "plugin",
-    "native"
+    "native",
+    "screen-recorder",
+    "screen-recording",
+    "video",
+    "recording",
+    "capture",
+    "screen-capture",
+    "ios",
+    "android"
   ],
   "scripts": {
     "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",