-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathreadme.txt
More file actions
572 lines (421 loc) · 15.2 KB
/
readme.txt
File metadata and controls
572 lines (421 loc) · 15.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
=== Videomail for Ninja Forms ===
Contributors: michael.heuberger, kbjohnson90
Tags: video, email, recorder, sign language
Requires at least: 6.0
Tested up to: 6.9.1
Stable tag: 10.2.1
Requires PHP: 8.1.0
Donate link: https://videomail.io/faq
License: CC0-1.0
Record videos with audio or in Sign Language with Ninja Forms!
== Description ==
With this add-on recording and sending videos in WordPress *finally* comes true. No further coding required. Just install + configure a bit (like duration, width or enable audio etc) and that’s all. Wicked.
* Record from webcam, simple
* Allow *video* and *audio* inputs in your forms, wow!
* World first solution
* Very easy to add with Ninja Forms
All you need is the Ninja Forms plugin so that this extension can be added there.
Latest version (zip file) also can be downloaded for free anytime from GitHub:
[https://github.com/binarykitchen/videomail-for-ninja-forms/blob/master/dist/videomail-for-ninja-forms.zip](https://github.com/binarykitchen/videomail-for-ninja-forms/blob/master/dist/videomail-for-ninja-forms.zip)
More documentation on setup and configuration see:
[https://github.com/binarykitchen/videomail-for-ninja-forms/tree/master/doc/faq/videomail-for-ninja-forms-faq.pdf](https://github.com/binarykitchen/videomail-for-ninja-forms/tree/master/doc/faq/videomail-for-ninja-forms-faq.pdf)
== Installation ==
This section describes how to install the plugin and get it working.
1. Upload the `videomail-for-ninja-forms` plugin folder to your `/wp-content/plugins/` directory
2. Activate the plugin through the ‘Plugins’ menu in WordPress
3. Visit the ‘Ninja Forms’ menu item in your admin sidebar
4. Build a form using videomail
Probably you also want to whitelist additional domains besides localhost. See whitelisting under FAQ.
== Frequently Asked Questions ==
= Donations? =
That would be awesome :) Scroll to bottom of https://videomail.io/faq
= Where is the documentation? =
Check out that pretty online PDF at [https://github.com/binarykitchen/videomail-for-ninja-forms/blob/master/doc/faq/videomail-for-ninja-forms-faq.pdf](https://github.com/binarykitchen/videomail-for-ninja-forms/blob/master/doc/faq/videomail-for-ninja-forms-faq.pdf)
= What options are there? =
That new recordable video field comes with many options you can configure yourself such as duration, width, audio on/off and much more.
Each option is explained well at bottom of this PDF file: [Videomail FAQ](https://github.com/binarykitchen/videomail-for-ninja-forms/tree/master/doc/faq/videomail-for-ninja-forms-faq.pdf)
= How does whitelisting work? =
For local development, everything will work right away because the localhost URL is already whitelisted on the videomail server.
But once you deploy your Wordpress site out in the wild, we will have to whitelist your production URL(s). For that, just submit a [Whitelist Request](https://videomail.io/whitelist). Once your whitelist entry has been approved, you'll get a secret whitelist key. With that key, you can activate this plugin for your site.
Just note that this requires registration on Videomail and that the first three months are free (trial period).
= Is there a live example? =
There is also the live site [videomail.io](https://videomail.io). Have a look and play.
You can see the videomail-client in action and use it right away for free, anytime, anywhere. Many people, especially Deaf and Sign Language users, already use it for their everyday communication.
= Can I use videomail outside of WordPress? =
Yes. There is a low level npm [videomail-client](https://github.com/binarykitchen/videomail-client) package. This WordPress plugin relies on it.
= Where is the support? =
To get help, just use any of these contacts at [https://binarykitchen.com](https://binarykitchen.com)
== Screenshots ==
1. There will be a new Ninja Form Fields in the common section called Videomail.
2. Once you have assembled a form and preview it, any browser will ask for webcam access first.
== Changelog ==
= 10.2.1 (1 Apr 2026) =
**Fix**
* Make WebSocket connection more robust
**Chore**
* Upgrade VC dependency
* Switch Prettier extension
= 10.2.0 (21 Mar 2026) =
**Change:**
* Remove obsolete WebSocket options to reduce race-condition related errors
**Chore**
* Upgrade VC dependency
* Apply patches
* Export types
= 10.1.0 (7 Feb 2026) =
**Improvement**
* Corrected documentation about whitelist key and polished its formatting further
**Chore**
* Upgrade VC dependency
* Polished dev documentation
**Change:**
* Upgrade pipeline dependencies
= 10.0.0 (12 Jan 2026) =
**Change:**
* Breaking: renamed site_name to whitelist_key. Retrieve your whitelist key on https://www.videomail.io/whitelist
= 9.1.1 (8 Jan 2026) =
**Improvement**
* Some error messages are more user friendlier, less technical. Sorry :)
**Fix**
* Correct height of videos, this by making it more responsive to your environment
**Change:**
* Lay out the foundation for the upcoming new whitelist management. There a no breaking changes.
**Chore**
* Apply security patches
= 9.1.0 (4 Dec 2025) =
**Improvement**
* Videomail button states (enabled/disabled) are now more robust, especially for mobile devices
* Video recording duration can be limited on the spot
**Change:**
* Accessibility: no more auto play - users have to click on the play button first before watching
* Bump to Node.js v24
* Replace deprecated prettier with the latest version
**Fix**
* Do not emit resize event when not built
**Chore**
* Upgrade VC dependency
* Polished dev documentation
= 9.0.1 (2 Nov 2025) =
**Improvement**
* More user friendlier error messages for missing inputs
**Change:**
* Include recording location which will assist investigating technical issues
**Fix**
* Rename wrong option name from ninjaFormPlugin to videomailNinjaFormPlugin
**Chore**
* Upgrade VC dependency
= 9.0.0 (21 Oct 2025) =
**Change:**
* Breaking change: switch to new Videomail API endpoint.
= 8.3.1 (17 Oct 2025) =
**Fix**
* Adds one missing comma :)
= 8.3.0 (17 Oct 2025) =
**Improvement**
* Adds new advanced option "disableFormWhenSubmitting" to increase security during form submissions.
**Change:**
* Defaults that new option "disableFormWhenSubmitting" to false, because plugins overlap with each other.
**Chore**
* Upgrade VC dependency
= 8.2.0 (8 Oct 2025) =
**Fix**
* Exclude videomail-client from LiteSpeed
**Chore**
* Upgrade VC dependency
* Upgrade Node.js
= 8.1.1 (26 Sept 2025) =
**Fix**
* Rename minified files to prevent LiteSpeed from minifying them all over again, see https://github.com/litespeedtech/lscache_wp/issues/908
= 8.1.0 (23 Sept 2025) =
**Fix**
* Clear LiteSpeed Cache when upgrading this plugin, see https://github.com/litespeedtech/lscache_wp/issues/895
**Chore**
* Upgrade VC dependency and re-release complete build
= 8.0.3 (2 Sept 2025) =
**Fix**
* Rearrange loading of Videomail-Client assets
= 8.0.2 (2 Sept 2025) =
**Chore**
* Upgrade VC dependency and re-release complete build
= 8.0.1 (27 Aug 2025) =
**Fix**
* Upgrade all libraries related to releasing new versions to WP.org
= 8.0.0 (25 Aug 2025) =
**Change:**
* Embrace the new upcoming Videomail features around user authentication, associating them with registered users
* They are not released yet, although, to avoid downtime and migrations, we are releasing new data structures early.
* Bonus: there more fun waiting animations to enjoy during encoding ;)
**Fix**
* On the side, an important bug has been fixed where failed deliveries are properly reported back
**Chore**
* Upgrade all dependencies to latest versions. All tested.
= 7.1.1 (25 June 2025) =
**Improvement:**
* Allow logins while recording
**Chore**
* Upgrade Videomail-Client for big upcoming changes
* Polish changelog
= 7.1.0 (15 May 2025) =
**Improvement**
* Also serialize unhandled play promises for more stability on Android phones
**Chore**
* Upgrade Videomail-Client
= 7.0.9 (21 Apr 2025) =
**Improvement**
* Also serialize all error variables from web sockets
**Chore**
* Upgrade Videomail-Client
= 7.0.8 (9 Apr 2025) =
**Improvement**
* Serialize all error variables for improved error reporting
**Chore**
* Upgrade Videomail-Client
**Fix**
* Corrects invalid version for the "Tested up to" field
= 7.0.7 (18 March 2025) =
**Improvement:**
* More robust error reporting from mobile devices
**Chore:**
* Upgrade Videomail-Client
* Export more types
= 7.0.5 (5 Feb 2025) =
**Improvement:**
* Properly recognizes full height of iPhone devices
= 7.0.4 (2 Feb 2025) =
**Chore:**
* Upgrade Videomail-Client
= 7.0.3 (31 Jan 2025) =
**Improvement:**
* Inject version in error reports
= 7.0.2 (30 Jan 2025) =
**Fix:**
* Remove invalid import statement
= 7.0.1 (15 Jan 2025) =
**Improvement:**
* Proper versions of anything are properly recorded for any error reports
**Change:**
* Bumps Videomail-Client to latest version
= 7.0.0 (21 Dec 2024) =
**Change:**
* After video processing, pick the correct API response (intelligence)
**Fix:**
* Revert invalid imports (ESM back to UMD)
**Improvement:**
* Better error messages (more human friendly)
= 6.0.0 (29 Nov 2024) =
**Change:**
* Upgrade Videomail-Client to v10 (15% faster)
= 5.3.0 (13 Sep 2024) =
**Improvement:**
* Speed: all is about 20% faster
**Change:**
* Upgrade runs on Node.js v22
**Bugs:**
* No conflicts when React is on the same page
* Pause + Resume video recording won't crash when hit too many times
= 5.2.1 (30 Jun 2024) =
**Improvement:**
* New option "stretch' to let the video take full width of the parent container, regardless of the webcam resolution.
* Improve documentation for developers
**Change:**
* Upgrade internal dependencies
**Bugs:**
* Do not lint before build completes
= 5.1.1 (13 Jun 2024) =
**Change:**
* Upgrade Node.js and npm
* Tested on WordPress v6.5.4
**Bugs:**
* Correct invalid tags
= 5.1.0 (24 Feb 2024) =
**Improvement:**
* New option: "load_user_media_on_record". When enabled, webcam permission are only being asked for when user hits record button
= 5.0.2 (21 Nov 2023) =
**Change:**
* Upgrade deployment tools
= 5.0.1 (21 Nov 2023) =
**Bugs:**
* Fix deployment issues
= 5.0.0 (19 Nov 2023) =
**Change:**
* Internal technical improvements for releasing new versions
* Internal technical change: Bump to NodeJS v20 and npm v9
= 4.0.16 (14 Jul 2023) =
**Bugs:**
* Fix versioning
= 4.0.15 (14 Jul 2023) =
**Bugs:**
* Fix versioning
= 4.0.14 (14 Jul 2023) =
**Bugs:**
* Fix versioning
= 4.0.13 (14 Jul 2023) =
**Bugs:**
* Fix boolean check for media library addition
= 4.0.12 (12 Jul 2023) =
**Bugs:**
* Fix a releasing issue
= 4.0.11 (12 Jul 2023) =
**Bugs:**
* Do not save to media library when disabled
**Change:**
* Deliver un-minified JS for easier debugging
= 4.0.10 (29 June 2023) =
**Bugs:**
* Repair broken bash comment
= 4.0.9 (29 June 2023) =
**Bugs:**
* Repair broken repo syncing
= 4.0.8 (29 June 2023) =
**Bugs:**
* Repair broken versioning
= 4.0.6 (29 June 2023) =
**Bugs:**
* Bump videomail-client which resolves a bug when webcam permissions are missing.
= 4.0.5 (29 May 2023) =
**Change:**
* Rebuild lockfile
= 4.0.4 (29 May 2023) =
**Change:**
* Include target folder
= 4.0.3 (29 May 2023) =
**Change:**
* Internal technical improvements for versioning
= 4.0.2 (29 May 2023) =
**Change:**
* Internal technical improvements for development
= 4.0.1 (29 May 2023) =
**Change:**
* Upgrade Videomail-Client
**Improvement:**
* Prefer serving MP4 over WebM movies (better coverage, especially on mobiles)
= 4.0.0 (31 Dec 2022) =
**Change:**
* Bump all dependencies and rebuild with NodeJS v18
= 3.13.1 (23 Sep 2022) =
**Improvement:**
* Better detection of supported video types
= 3.13.0 (22 Sep 2022) =
**Bugs:**
* Fixes broken video type detection
= 3.12.0 (3 Sep 2022) =
**Improvements:**
* Audio and Video 99.9% in sync now
**Tasks:**
* Upgrade all inside dependencies without breaking changes.
= 3.11.2 (11 Jun 2022) =
**Tasks:**
* Tested everything on latest WordPress v6.0.0 and works well
**Change:**
* Upgraded all internal libraries, especially Videomail-Client on npm (they come with lots of stability fixes)
= 3.11.1 (28 Aug 2021) =
**Change:**
* Just a maintenance bump using latest Videomail-Client
* Better treatment of undefined form inputs
= 3.11.0 (19 Jul 2021) =
**Change:**
* Switch to node.js v16 and npm v7.18
* Runs security audit toward all dependencies
= 3.10.4 (12 Jul 2021) =
**Change:**
* Countdown and pause texts are bolder now
= 3.10.3 (29 Jan 2021) =
**Bugs:**
* Another workaround for more global pollution situations
= 3.10.2 (29 Jan 2021) =
**Bugs:**
* Works for older Backbone versions too or when other plugins pollute its global scope.
= 3.10.1 (5 Dec 2020) =
**Change:**
* Bump min required and tested versions
= 3.10.0 (5 Dec 2020) =
**Bugs:**
* Make it work along with the Conditional Logic add-on
* Required attribute works again with latest WP and Ninja Form versions
**Change:**
* Upgrades Videomail dependency
= 3.9.8 (20 Oct 2020) =
**Bugs:**
* Fixed wrong FPS calculation. Now overall quality of encoded videos won’t be impacted when connectivity deteriorates toward the end.
**Change:**
* Upgrades Videomail dependency
= 3.9.7 (9 Sept 2020) =
**Improvements:**
* Better release procedure
* Consistent source code
= 3.9.6 (16 Jun 2020) =
**Change:**
* Upgrades Videomail dependency
= 3.9.5 (16 Jun 2020) =
**Bugs:**
* Flip video feed horizontally to match with reality (all webcams are inverted by default)
= 3.9.4 (13 Mar 2020) =
**Bugs:**
* Ping more often to keep connection alive
* Also submit disabled form inputs
= 3.9.3 (7 Nov 2019) =
**Bugs:**
* Do not enable audio when already false
= 3.9.2 (7 Nov 2019) =
**Bugs:**
* Repaired merging fields into strings
= 3.8.1 (7 Nov 2019) =
**Bugs:**
* Repair readme.txt
= 3.8.0 (6 Nov 2019) =
**Change:**
Lots improved under the hood, updated many libraries for speed and security.
**Bugs:**
* Works again on IE11
= 3.7.4 (3 Sep 2019) =
**Bugs:**
* Fix invalid URLs for Windows machines
= 3.7.3 (27 Aug 2019) =
**Bugs:**
* Correct error message when on insecure HTTP with recommendation to switch to HTTPS
* Works again on older iPhones
**Change:**
* Replaced lots of old code with modern code.
= 3.7.2 (8 May 2019) =
**Change:**
* Better readystate handling for faster page loads
* Improved error messages for iOS on Chrome
* Faster websocket streams
= 3.7.1 (14 Jan 2019) =
**Change:**
* Audio now enabled by default
* Improved documentation
**Bugs:**
* More robust with exotic browsers
* Correct bad spelling
= 3.6.0 (17 March 2018) =
**Change:**
* Moved to a new, public repository and free now
= 3.5.0 (17 February 2018) =
*Features:*
* New option: save to media library - so that you can reuse the video for posts or pages yay!
* New option: image quality - with this you can improve video in cost of bandwidth
**Bugs:**
* Much better error handling
= 3.4.3 (21 December 2017) =
**Bugs:**
* Now it does not mess with other rich content text editors anymore.
= 3.4.2 (12 December 2017) =
**Bugs:**
* Added missing licensing field under settings
= 3.4.0 (12 October 2017) =
*Features:*
* Now works on iPhones running on iOS11 and on Safari v11, yay.
**Bugs:**
* Now works as an optional input (= not as a required field)
= 3.3.3 (9 September 2017) =
**Bugs:**
* Make it work again on all Edge browsers
= 3.3.2 (27 July 2017) =
**Bugs:**
* Do not zip extension in another zip.
*Changes:*
* Bump videomail-client using ES6 code
* Improved error messages
= 3.3.1 (12 July 2017) =
**Initial Release**