@vidtreo/recorder-wc 1.2.1 → 1.3.0
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 +8 -0
- package/dist/vidtreo-recorder.js +77 -52
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -54,12 +54,15 @@ All attributes are optional except where noted. Attributes use kebab-case (e.g.,
|
|
|
54
54
|
| `api-key` | `string` | No* | - | API key for authentication. Required if not set via JavaScript. |
|
|
55
55
|
| `backend-url` | `string` | No | `https://core.vidtreo.com` | Backend API URL. Automatically adds `https://` prefix if missing. |
|
|
56
56
|
| `countdown-duration` | `number` | No | - | Countdown duration in milliseconds before recording starts (e.g., `3000` for 3 seconds) |
|
|
57
|
+
| `min-time-record` | `number` | No | - | Minimum recording time in milliseconds before stop is allowed (e.g., `10000` for 10 seconds) |
|
|
57
58
|
| `max-recording-time` | `number` | No | - | Maximum recording time in milliseconds (e.g., `300000` for 5 minutes) |
|
|
58
59
|
| `user-metadata` | `string` (JSON) | No | - | Custom metadata to attach to recordings. Must be valid JSON string. |
|
|
59
60
|
| `enable-source-switching` | `boolean` | No | `true` | Enable switching between camera and screen during recording. Set to `"false"` to disable. |
|
|
60
61
|
| `enable-mute` | `boolean` | No | `true` | Enable mute/unmute functionality. Set to `"false"` to disable. |
|
|
61
62
|
| `enable-pause` | `boolean` | No | `true` | Enable pause/resume functionality. Set to `"false"` to disable. |
|
|
62
63
|
| `enable-device-change` | `boolean` | No | `true` | Enable camera/microphone selection. Set to `"false"` to disable. |
|
|
64
|
+
| `enable-tab-visibility-overlay` | `boolean` | No | `false` | Show overlay in camera recordings when user switches to another tab. Set to `"true"` to enable. |
|
|
65
|
+
| `tab-visibility-overlay-text` | `string` | No | localized `userInAnotherTab` text | Custom text rendered for tab visibility overlay. |
|
|
63
66
|
| `lang` | `string` | No | `"en"` | Language code for UI text (`"en"` or `"es"`) |
|
|
64
67
|
| `mobile-mode` | `string` | No | `"overlay"` | Mobile recording mode. Options: `"overlay"` (fullscreen modal), `"embed"` (inline), `"native"` (device camera app via file input). |
|
|
65
68
|
| `texts` | `string` (JSON) | No | - | Custom text overrides for localization. Must be valid JSON string. |
|
|
@@ -76,6 +79,9 @@ All attributes are optional except where noted. Attributes use kebab-case (e.g.,
|
|
|
76
79
|
|
|
77
80
|
**Note:** Boolean attributes are enabled by default. To disable them, set the attribute value to `"false"` (string).
|
|
78
81
|
|
|
82
|
+
When `enable-tab-visibility-overlay="true"` and `tab-visibility-overlay-text` is omitted, the component resolves a
|
|
83
|
+
localized default using `lang`. Overlay rendering is skipped for screen capture recordings.
|
|
84
|
+
|
|
79
85
|
### Examples
|
|
80
86
|
|
|
81
87
|
#### Basic Usage
|
|
@@ -96,6 +102,7 @@ All attributes are optional except where noted. Attributes use kebab-case (e.g.,
|
|
|
96
102
|
api-key="your-api-key"
|
|
97
103
|
backend-url="https://core.vidtreo.com"
|
|
98
104
|
countdown-duration="3000"
|
|
105
|
+
min-time-record="10000"
|
|
99
106
|
max-recording-time="300000"
|
|
100
107
|
></vidtreo-recorder>
|
|
101
108
|
```
|
|
@@ -538,6 +545,7 @@ recorder.setAttribute('texts', JSON.stringify({
|
|
|
538
545
|
| `settings` | Settings | Configuración |
|
|
539
546
|
| `record` | Record | Grabar |
|
|
540
547
|
| `stop` | Stop | Detener |
|
|
548
|
+
| `minimumRecordingTimeNotReached` | You have not met the minimum recording time yet | Aun no cumples el tiempo minimo de grabacion |
|
|
541
549
|
| `pause` | Pause | Pausar |
|
|
542
550
|
| `resume` | Resume | Reanudar |
|
|
543
551
|
| `mute` | Mute | Silenciar |
|