@vidtreo/recorder-wc 1.0.5 → 1.0.7
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 +45 -1
- package/dist/vidtreo-recorder.js +293 -11
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -29,7 +29,7 @@ npm install @vidtreo/recorder-wc
|
|
|
29
29
|
#### Specific Version (Recommended for Production)
|
|
30
30
|
|
|
31
31
|
```html
|
|
32
|
-
<script type="module" src="https://cdn.jsdelivr.net/npm/@vidtreo/recorder-wc@0.
|
|
32
|
+
<script type="module" src="https://cdn.jsdelivr.net/npm/@vidtreo/recorder-wc@1.0.5/dist/vidtreo-recorder.js"></script>
|
|
33
33
|
|
|
34
34
|
<vidtreo-recorder
|
|
35
35
|
api-key="your-api-key"
|
|
@@ -61,6 +61,7 @@ All attributes are optional except where noted. Attributes use kebab-case (e.g.,
|
|
|
61
61
|
| `enable-pause` | `boolean` | No | `true` | Enable pause/resume functionality. Set to `"false"` to disable. |
|
|
62
62
|
| `enable-device-change` | `boolean` | No | `true` | Enable camera/microphone selection. Set to `"false"` to disable. |
|
|
63
63
|
| `lang` | `string` | No | `"en"` | Language code for UI text (`"en"` or `"es"`) |
|
|
64
|
+
| `mobile-mode` | `string` | No | `"overlay"` | Mobile recording mode. Options: `"overlay"` (fullscreen modal), `"embed"` (inline), `"native"` (device camera app via file input). |
|
|
64
65
|
| `texts` | `string` (JSON) | No | - | Custom text overrides for localization. Must be valid JSON string. |
|
|
65
66
|
| `watermark` | `string` (JSON) | No | - | Watermark configuration. Must be valid JSON string. |
|
|
66
67
|
|
|
@@ -135,6 +136,49 @@ All attributes are optional except where noted. Attributes use kebab-case (e.g.,
|
|
|
135
136
|
></vidtreo-recorder>
|
|
136
137
|
```
|
|
137
138
|
|
|
139
|
+
## Mobile Mode
|
|
140
|
+
|
|
141
|
+
The web component supports three mobile recording modes:
|
|
142
|
+
|
|
143
|
+
### Overlay Mode (Default)
|
|
144
|
+
|
|
145
|
+
Opens a fullscreen modal when the user taps "Open Camera". Best for focused recording experiences.
|
|
146
|
+
|
|
147
|
+
```html
|
|
148
|
+
<vidtreo-recorder
|
|
149
|
+
api-key="your-api-key"
|
|
150
|
+
mobile-mode="overlay"
|
|
151
|
+
></vidtreo-recorder>
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### Embed Mode
|
|
155
|
+
|
|
156
|
+
Renders the recorder inline within your page. Best when the recorder is the main content.
|
|
157
|
+
|
|
158
|
+
```html
|
|
159
|
+
<vidtreo-recorder
|
|
160
|
+
api-key="your-api-key"
|
|
161
|
+
mobile-mode="embed"
|
|
162
|
+
></vidtreo-recorder>
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
### Native Mode
|
|
166
|
+
|
|
167
|
+
Uses the device's native camera app via file input. Best for maximum compatibility, especially on iOS Safari.
|
|
168
|
+
|
|
169
|
+
```html
|
|
170
|
+
<vidtreo-recorder
|
|
171
|
+
api-key="your-api-key"
|
|
172
|
+
mobile-mode="native"
|
|
173
|
+
></vidtreo-recorder>
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
| Mode | UI | Best For |
|
|
177
|
+
|------|-----|----------|
|
|
178
|
+
| `overlay` | SDK fullscreen modal | Focused recording experience |
|
|
179
|
+
| `embed` | SDK inline | Main page content |
|
|
180
|
+
| `native` | Device camera app | iOS Safari compatibility |
|
|
181
|
+
|
|
138
182
|
## Programmatic Access
|
|
139
183
|
|
|
140
184
|
The web component exposes methods and properties that can be accessed via JavaScript for advanced use cases.
|