@capgo/capacitor-screen-recorder 7.1.3 → 7.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -3
- package/dist/docs.json +14 -3
- package/dist/esm/definitions.d.ts +4 -3
- package/dist/esm/definitions.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -72,7 +72,7 @@ No configuration required for this plugin.
|
|
|
72
72
|
|
|
73
73
|
<docgen-index>
|
|
74
74
|
|
|
75
|
-
* [`start()`](#start)
|
|
75
|
+
* [`start(...)`](#start)
|
|
76
76
|
* [`stop()`](#stop)
|
|
77
77
|
|
|
78
78
|
</docgen-index>
|
|
@@ -80,14 +80,18 @@ No configuration required for this plugin.
|
|
|
80
80
|
<docgen-api>
|
|
81
81
|
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
|
|
82
82
|
|
|
83
|
-
### start()
|
|
83
|
+
### start(...)
|
|
84
84
|
|
|
85
85
|
```typescript
|
|
86
|
-
start() => Promise<void>
|
|
86
|
+
start(options?: { recordAudio?: boolean | undefined; } | undefined) => Promise<void>
|
|
87
87
|
```
|
|
88
88
|
|
|
89
89
|
start the recording
|
|
90
90
|
|
|
91
|
+
| Param | Type | Description |
|
|
92
|
+
| ------------- | --------------------------------------- | ----------------- |
|
|
93
|
+
| **`options`** | <code>{ recordAudio?: boolean; }</code> | Recording options |
|
|
94
|
+
|
|
91
95
|
--------------------
|
|
92
96
|
|
|
93
97
|
|
package/dist/docs.json
CHANGED
|
@@ -7,10 +7,21 @@
|
|
|
7
7
|
"methods": [
|
|
8
8
|
{
|
|
9
9
|
"name": "start",
|
|
10
|
-
"signature": "() => Promise<void>",
|
|
11
|
-
"parameters": [
|
|
10
|
+
"signature": "(options?: { recordAudio?: boolean | undefined; } | undefined) => Promise<void>",
|
|
11
|
+
"parameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "options",
|
|
14
|
+
"docs": "Recording options",
|
|
15
|
+
"type": "{ recordAudio?: boolean | undefined; } | undefined"
|
|
16
|
+
}
|
|
17
|
+
],
|
|
12
18
|
"returns": "Promise<void>",
|
|
13
|
-
"tags": [
|
|
19
|
+
"tags": [
|
|
20
|
+
{
|
|
21
|
+
"name": "param",
|
|
22
|
+
"text": "options Recording options"
|
|
23
|
+
}
|
|
24
|
+
],
|
|
14
25
|
"docs": "start the recording",
|
|
15
26
|
"complexTypes": [],
|
|
16
27
|
"slug": "start"
|
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
export interface ScreenRecorderPlugin {
|
|
2
2
|
/**
|
|
3
3
|
* start the recording
|
|
4
|
-
*
|
|
4
|
+
* @param options Recording options
|
|
5
5
|
*/
|
|
6
|
-
start(
|
|
6
|
+
start(options?: {
|
|
7
|
+
recordAudio?: boolean;
|
|
8
|
+
}): Promise<void>;
|
|
7
9
|
/**
|
|
8
10
|
* stop the recording
|
|
9
|
-
*
|
|
10
11
|
*/
|
|
11
12
|
stop(): Promise<void>;
|
|
12
13
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export interface ScreenRecorderPlugin {\n /**\n * start the recording\n
|
|
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"]}
|