videomail-client 16.1.1 → 16.4.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 +4 -6
- package/dist/cjs/index.cjs +2260 -1954
- package/dist/esm/index.js +2110 -1824
- package/dist/esm/types/events/params.d.ts +4 -3
- package/dist/esm/util/email/isRecipientSelectionValid.d.ts +4 -0
- package/dist/esm/util/html/media/AudioRecorder.d.ts +19 -9
- package/dist/esm/util/html/media/AudioRecorderWorklet.d.ts +17 -0
- package/dist/esm/wrappers/container.d.ts +1 -1
- package/dist/esm/wrappers/visuals/recorder/capture.d.ts +87 -0
- package/dist/esm/wrappers/visuals/recorder/connection.d.ts +46 -0
- package/dist/esm/wrappers/visuals/recorder/dimensions.d.ts +21 -0
- package/dist/esm/wrappers/visuals/recorder/media.d.ts +51 -0
- package/dist/esm/wrappers/visuals/recorder/mediaConstraints.d.ts +14 -0
- package/dist/esm/wrappers/visuals/recorder/progress.d.ts +11 -0
- package/dist/esm/wrappers/visuals/recorder/streamWriter.d.ts +56 -0
- package/dist/esm/wrappers/visuals/recorder.d.ts +13 -165
- package/dist/umd/index.js +2173 -1914
- package/package.json +12 -12
- /package/dist/esm/util/{trimEmail.d.ts → email/trimEmail.d.ts} +0 -0
package/README.md
CHANGED
|
@@ -75,11 +75,9 @@ The defaults suit most integrations. Set `whitelistKey` when deploying on your o
|
|
|
75
75
|
|
|
76
76
|
The examples in [src/stories](https://github.com/binarykitchen/videomail-client/tree/master/src/stories) show common configurations.
|
|
77
77
|
|
|
78
|
-
|
|
78
|
+
## Audio
|
|
79
79
|
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
`audio.volume` controls recording gain from `0` (silence) to `1` (unchanged microphone level, the default). It does not control playback volume or enable audible microphone monitoring.
|
|
80
|
+
See [docs/AUDIO.md](docs/AUDIO.md) for details on audio recording options and requirements.
|
|
83
81
|
|
|
84
82
|
## API
|
|
85
83
|
|
|
@@ -201,7 +199,7 @@ Returns the videomail thread containing the given key.
|
|
|
201
199
|
|
|
202
200
|
### videomailClient.unload()
|
|
203
201
|
|
|
204
|
-
Manually unloads the webcam and all
|
|
202
|
+
Manually unloads the webcam, closes the active WebSocket connection, and removes all internal event listeners.
|
|
205
203
|
|
|
206
204
|
### videomailClient.hide()
|
|
207
205
|
|
|
@@ -292,7 +290,7 @@ For a deployed domain, request access at [videomail.io/whitelist](https://videom
|
|
|
292
290
|
|
|
293
291
|
## Browser compatibility
|
|
294
292
|
|
|
295
|
-
Recording requires a secure context (`https://` or localhost) and support for `navigator.mediaDevices.getUserMedia()`, WebSocket, Canvas, and
|
|
293
|
+
Recording requires a secure context (`https://` or localhost) and support for `navigator.mediaDevices.getUserMedia()`, WebSocket, Canvas, and AudioWorklet when audio is enabled. Current evergreen desktop and mobile browsers are supported. Internet Explorer is not supported.
|
|
296
294
|
|
|
297
295
|
See [Can I Use: Media Capture from DOM Elements](https://caniuse.com/stream) and test the [live demo](#live-demo) in the browsers required by your integration.
|
|
298
296
|
|