@capgo/capacitor-screen-recorder 7.1.2 → 7.1.4

package/README.md

@@ -19,14 +19,29 @@ npx cap sync
 add NSPhotoLibraryUsageDescription in your info.plist
 
 ## Android
-increase project's minSdk version to 23, it's required by the dependency scrcast
+increase project's minSdk version to 23, it's required by the dependency HBRecorder
 
-Add this permissions in your `AndroidManifest.xml`
+Add these permissions in your `AndroidManifest.xml`:
 ```xml
-  <uses-permission android:name="android.permission.CAPTURE_VIDEO_OUTPUT" />
-  <uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" />
+<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+<uses-permission android:name="android.permission.WRITE_INTERNAL_STORAGE" />
+<uses-permission android:name="android.permission.RECORD_AUDIO" />
+<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
+<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" />
 ```
 
+### Add JitPack Repository
+Add JitPack repository to your Android app's build.gradle (android/app/build.gradle):
+
+```gradle
+allprojects {
+    repositories {
+        google()
+        mavenCentral()
+        maven { url 'https://jitpack.io/' }
+    }
+}
+```
 
 ### Variables
 
@@ -57,7 +72,7 @@ No configuration required for this plugin.
 
 <docgen-index>
 
-* [`start()`](#start)
+* [`start(...)`](#start)
 * [`stop()`](#stop)
 
 </docgen-index>
@@ -65,14 +80,18 @@ No configuration required for this plugin.
 <docgen-api>
 <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
 
-### start()
+### start(...)
 
 ```typescript
-start() => Promise<void>
+start(options?: { recordAudio?: boolean | undefined; } | undefined) => Promise<void>
 ```
 
 start the recording
 
+| Param         | Type                                    | Description       |
+| ------------- | --------------------------------------- | ----------------- |
+| **`options`** | <code>{ recordAudio?: boolean; }</code> | Recording options |
+
 --------------------
 
 

package/dist/docs.json

@@ -7,10 +7,21 @@
     "methods": [
       {
         "name": "start",
-        "signature": "() => Promise<void>",
-        "parameters": [],
+        "signature": "(options?: { recordAudio?: boolean | undefined; } | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "Recording options",
+            "type": "{ recordAudio?: boolean | undefined; } | undefined"
+          }
+        ],
         "returns": "Promise<void>",
-        "tags": [],
+        "tags": [
+          {
+            "name": "param",
+            "text": "options Recording options"
+          }
+        ],
         "docs": "start the recording",
         "complexTypes": [],
         "slug": "start"

package/dist/esm/definitions.d.ts

@@ -1,12 +1,13 @@
 export interface ScreenRecorderPlugin {
     /**
      * start the recording
-     *
+     * @param options Recording options
      */
-    start(): Promise<void>;
+    start(options?: {
+        recordAudio?: boolean;
+    }): Promise<void>;
     /**
      * stop the recording
-     *
      */
     stop(): Promise<void>;
 }

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":""}
+{"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"]}

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,cAAc,GAAG,cAAc,CAAuB,gBAAgB,EAAE;IAC5E,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,iBAAiB,EAAE,CAAC;CAClE,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,cAAc,GAAG,cAAc,CAAuB,gBAAgB,EAAE;IAC5E,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,iBAAiB,EAAE,CAAC;CAClE,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,CAAC","sourcesContent":["import { registerPlugin } from \"@capacitor/core\";\n\nimport type { ScreenRecorderPlugin } from \"./definitions\";\n\nconst ScreenRecorder = registerPlugin<ScreenRecorderPlugin>(\"ScreenRecorder\", {\n  web: () => import(\"./web\").then((m) => new m.ScreenRecorderWeb()),\n});\n\nexport * from \"./definitions\";\nexport { ScreenRecorder };\n"]}

package/dist/esm/web.js.map

@@ -1 +1 @@
-{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,MAAM,OAAO,iBACX,SAAQ,SAAS;IAGjB,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IACD,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;CACF"}
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,MAAM,OAAO,iBACX,SAAQ,SAAS;IAGjB,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IACD,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;CACF","sourcesContent":["import { WebPlugin } from \"@capacitor/core\";\n\nimport type { ScreenRecorderPlugin } from \"./definitions\";\n\nexport class ScreenRecorderWeb\n  extends WebPlugin\n  implements ScreenRecorderPlugin\n{\n  async start(): Promise<void> {\n    throw new Error(\"Method not implemented.\");\n  }\n  async stop(): Promise<void> {\n    throw new Error(\"Method not implemented.\");\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-screen-recorder",
-  "version": "7.1.2",
+  "version": "7.1.4",
   "description": "Record device's screen",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",